acid-info
/
nimbus-site
mirror of https://github.com/acid-info/nimbus-site.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

readme edits (signed commit) (#80) 

* readme edits

* minor edit

* Update README.md

tense fix
This commit is contained in:
Sacha Saint-Leger 2020-08-16 11:21:21 +02:00 committed by GitHub
parent ad357919bb
commit a4ed912ab8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -5,7 +5,11 @@ This repo holds the code for two sites:
* [nimbus.team](https://nimbus.team) - From `master`, built in [CI](https://ci.status.im/job/misc/job/nimbus.team/), served from `gh-pages`
* [dev.nimbus.team](https://dev.nimbus.team) - From `develop`, built in [CI](https://ci.status.im/job/misc/job/dev.nimbus.team/), 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. 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.
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](https://docs.github.com/en/github/authenticating-to-github/signing-commits) before submitting a PR (this repository requires all commits to be signed).
## Adding a New Page
@ -20,8 +24,9 @@ If you want to add a page, rather than just edit, you'll need to make sure it ap
Make sure you have [Node.js](https://nodejs.org/) installed first.
1. Open Terminal and navigate to the project root directory,
2. Run `yarn install`
3. Run `yarn build`
4. Run `yarn devel`
5. Open http://localhost:8000 in a browser
This prevents the need for any global installs, and will allow you to have live reloading for any changes you are making.
This prevents the need for any global installs, and allows you to live reload any changes you make.