Cumulus Docs

Local Setup

git clone git@github.com:cumulus-nasa/cumulus-nasa.github.io.git
cd cumulus-nasa.github.io
npm install
npm start

Add a new page

Add a .md file to docs folder and then a new item to SUMMARY.md.

Add a new task

The tasks list in docs/tasks.md is generated from the list of task package names in tasks.json. Do not edit the docs/tasks.md file directly. Instead, add the package name to tasks.json.

Read more about adding a new task.

Editing the tasks.md header or template

Look at the bin/build-tasks-doc.js and bin/tasks-header.md files to edit the output of the tasks build script.

Deployment

The develop branch is automatically built and deployed to master. The master branch is served by Github Pages. Do not make edits to the master branch.