d7095b1730
* update team * image fix (#85) * update team * move image to right location * update nimbus book link * update homepage * update design page * Move design ahead of getting started; hide guides (for now) * major documentation update * fix sidebar * remove archived library from list |
||
|---|---|---|
| js | ||
| scaffolds | ||
| scripts | ||
| source | ||
| themes/navy | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| Jenkinsfile | ||
| LICENSE | ||
| README.md | ||
| _config.dev.yml | ||
| _config.prod.yml | ||
| gulpfile.js | ||
| package.json | ||
| yarn.lock | ||
README.md
Nimbus Site
This repo holds the code for two sites:
- nimbus.team - From
master, built in CI, served fromgh-pages - dev.nimbus.team - From
develop, built in CI, serverd from dev host
There is an edit button on each page, which will take you directly to the document you need to edit on the develop branch.
The recommended flow is to create a PR against develop. We can then allow a large group of people to push directly to develop and show their changes on the staging site when asking for review, which should smooth out and speed up the process considerably for everyone. master is obviously protected, and will only have changes merged in from develop once accepted.
N.B. make sure you've set up signed commits before submitting a PR (this repository requires all commits to be signed).
Adding a New Page
If you want to add a page, rather than just edit, you'll need to make sure it appears on the sidebar and is accessible to everyone.
- Add your page to
source/docs/<your_file_here>.md - In
source/_data/sidebars.ymladd the appropriate text to the appropriate place. - In
themes/navy/languages/en.ymledit the sidebars section to make sure that your new text insidebars.ymlis rendered correctly.
Testing locally
Make sure you have Node.js installed first.
- Open Terminal and navigate to the project root directory,
- Run
yarn install - Run
yarn build - Run
yarn devel - Open http://localhost:8000 in a browser
This prevents the need for any global installs, and allows you to live reload any changes you make.