ARDEN-documentation/README.md

# AREDN Documentation
This repository is for creating documentation for the AREDN project so it can be made available on ReadTheDocs.

## Viewing the Docs:
To view the AREDN documentation in a web browser, navigate to [https://arednmesh.readthedocs.io/en/latest/](https://arednmesh.readthedocs.io/en/latest/) or select your choice from the `Docs` dropdown menu on [https://arednmesh.org](https://arednmesh.org).

## Exporting to PDF:
While viewing the AREDN documentation in your web browser, you will see the contents list in the left panel. At the bottom of the panel is a drawer labeled "ReadTheDocs" showing the version you are viewing. Click the label bar to open it. From the drawer you can export the documentation set as a single PDF or Epub file. This is handy if you want to take a PDF copy of the guidebook with you into the field where you do not have Internet access.

## 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 described in detail here: [How to Use GitHub for AREDN](https://github.com/aredn/documentation/blob/master/How%20to%20Use%20GitHub%20for%20AREDN.md).

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 automatically 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.
Added Network Design Guide Added Network Design Guide sections, and edited a few Getting Started Guide areas. Both guidebooks are now part of the single existing AREDN documentation repository. 2018-12-16 15:03:51 -07:00			`# AREDN Documentation`
			`This repository is for creating documentation for the AREDN project so it can be made available on ReadTheDocs.`

Update index.rst (#3) * Update index.rst * Update index.rst * Update README.md 2018-12-24 13:48:52 -07:00			`## Viewing the Docs:`
fix readme links 2018-12-30 15:56:33 -07:00			To view the AREDN documentation in a web browser, navigate to [https://arednmesh.readthedocs.io/en/latest/](https://arednmesh.readthedocs.io/en/latest/) or select your choice from the `Docs` dropdown menu on [https://arednmesh.org](https://arednmesh.org).
Update index.rst (#3) * Update index.rst * Update index.rst * Update README.md 2018-12-24 13:48:52 -07:00
			`## Exporting to PDF:`
			`While viewing the AREDN documentation in your web browser, you will see the contents list in the left panel. At the bottom of the panel is a drawer labeled "ReadTheDocs" showing the version you are viewing. Click the label bar to open it. From the drawer you can export the documentation set as a single PDF or Epub file. This is handy if you want to take a PDF copy of the guidebook with you into the field where you do not have Internet access.`

Added Network Design Guide Added Network Design Guide sections, and edited a few Getting Started Guide areas. Both guidebooks are now part of the single existing AREDN documentation repository. 2018-12-16 15:03:51 -07:00			`## Contributing:`
Update links for new aredn code repo Update links pointing to the new aredn code repo. 2020-12-16 10:04:42 -07:00			`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 described in detail here: [How to Use GitHub for AREDN](https://github.com/aredn/documentation/blob/master/How%20to%20Use%20GitHub%20for%20AREDN.md).`
Added Network Design Guide Added Network Design Guide sections, and edited a few Getting Started Guide areas. Both guidebooks are now part of the single existing AREDN documentation repository. 2018-12-16 15:03:51 -07:00
Update links for new aredn code repo Update links pointing to the new aredn code repo. 2020-12-16 10:04:42 -07:00			`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 automatically updates and builds the latest docs for viewing and exporting on ReadTheDocs.org`
Added Network Design Guide Added Network Design Guide sections, and edited a few Getting Started Guide areas. Both guidebooks are now part of the single existing AREDN documentation repository. 2018-12-16 15:03:51 -07:00
Clarify contrib steps Change toctree depth to 1; clarify steps for contributing to aredn/documentation 2019-01-19 06:49:41 -07:00			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.