Additional information about the AREDN® project can be found at the links below.
Contributing AREDN® Documentation¶
If you are interested in contributing to the rapidly growing set of AREDN® documentation you can easily do so on GitHub. To contribute to the AREDN® project you first must create your own GitHub account. This is free and easy to do by following these steps:
- Open your web browser and navigate to the GitHub URL.
- Click the
Sign Upbutton and enter a username, email, and password. We suggest using your callsign as the username.
- On the GitHub website, click the
Sign Inbutton and enter your username or email followed by your GitHub password.
- Navigate on GitHub to the AREDN® documentation repository: https://github.com/aredn/documentation.
- Click the
Forkbutton at the upper right corner of the page. After this process completes, you will have your own copy of the AREDN® documentation files on your GitHub account.
- Go to your local computer and clone your fork of the AREDN® documentation:
git clone https://github.com/YOUR-GITHUB-ID/documentation
- Navigate on your local computer to the folder where your cloned copy of the repository is located:
cd documentationThis directory contains your local copy of the AREDN® documentation, and all of your document editing should be done while you are in this directory or its subdirectories.
The workflow for contributing documentation is identical to the workflow for contributing code which is described in the file titled How to Use GitHub for AREDN, a copy of which you already have in your new local repository. Refer to that document for additional information about contributing AREDN® documentation.
Your local editing branch name can be anything that makes sense to you as you add topics to the documentation. AREDN® documentation is written using the reStructuredText markup language and your text is saved in “rst” files. Before committing your changes, be sure to test your rst files locally using Sphinx to ensure they will render correctly.
After you create a Pull Request on GitHub, the AREDN® team will review your 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