Mirrors
/
ARDEN-documentation
mirror of https://github.com/aredn/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README with another clarification 

Add another clarification for contributing to the documentation.
This commit is contained in:
Steve Lewis KC0EUW 2019-01-19 09:11:08 -07:00 committed by Joe AE6XE
parent 4c7efb6baf
commit 89c9da1340
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -10,6 +10,6 @@ While viewing the AREDN documentation in your web browser, you will see the cont
## Contributing:
If you are interested in contributing to the rapidly growing set of AREDN related information, you can easily do so on GitHub. The workflow for contributing documentation is identical to the workflow for contributing code which is described in detail here: [How to Use GitHub for AREDN](https://github.com/aredn/documentation/blob/master/How%20to%20Use%20GitHub%20for%20AREDN.md).
The only difference is the repository name of `aredn/documentation` and the main branch name of `master`. Your local code branch name can be anything that makes sense to you. The AREDN team will then review your request just as it does for code changes. Once your documentation contributions are committed to the AREDN GitHub repository, a webhook updates and builds the latest docs for viewing and exporting on ReadTheDocs.org
The only difference is the repository name of `aredn/documentation` and the main branch name of `master`. Your local code branch name can be anything that makes sense to you. After you create your Pull Request, the AREDN team will review your request just as it does for code changes. Once your documentation contributions are committed to the AREDN GitHub repository, a webhook updates and builds the latest docs for viewing and exporting on ReadTheDocs.org
AREDN documentation is written using the reStructuredText markup language. Text is saved in "rst" files. Before committing your changes, be sure to test your `rst` files to ensure they will render correctly.