Updating user docs

This commit is contained in:
Mike Farah
2018-06-12 10:17:09 +10:00
parent 27089d1ca1
commit ebdc092688
5 changed files with 26 additions and 12 deletions
+5 -3
View File
@@ -83,6 +83,8 @@ Use "yq [command] --help" for more information about a command.
2. add unit tests
3. apply changes
4. `make [local] build`
5. Update user documentation if required (README.md, mkdocs folder )
6. `make [local] build-docs`
5. profit
5. If required, update the user documentation
- Update README.md and/or documentation under the mkdocs folder
- `make [local] build-docs`
- browse to docs/index.html and check your changes
6. profit