Merge pull request #2 from kc0euw/master

Added Network Design Guide
aredn · Dec 21, 2018 · ef7671a · ef7671a
2 parents 2709709 + 7c2526f
commit ef7671a
Show file tree

Hide file tree

Showing 46 changed files with 449 additions and 28 deletions.
diff --git a/Getting_Started_Guide/index.rst b/Getting_Started_Guide/index.rst
diff --git a/How to Use GitHub for AREDN.md b/How to Use GitHub for AREDN.md
@@ -0,0 +1,58 @@
+# How to Use GitHub
+## Contributing to the AREDN Project
+
+
+### Create Your GitHub Account
+
+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:
+
+1. Open your web browser and navigate to the GitHub URL `https://github.com`.
+2. Click the `Sign Up` button and enter a username, email, and password. We suggest using your callsign as the username.
+3. On the GitHub website, click the `Sign In` button and enter your username or email, followed by your github password.
+4. You can enter "aredn" into the search bar to find all repositories related to AREDN, or if you want to contribute directly to the AREDN firmware you can type this URL into your web browser: `https://github.com/aredn/aredn_ar71xx`.
+
+### Understanding GitHub Workflow
+
+The process of contributing and tracking changes to AREDN is circular. Code is maintained in the AREDN Master repository on GitHub. To contribute a potential code update, you must first FORK the AREDN master repository to your own GitHub account. You then CLONE your copy of the code from your GitHub repository to your own local computer. Make and test any changes you want to contribute using your local computer's copy of the code.
+
+When you are satisfied with your changes, COMMIT them to your local computer's repository, then PUSH those local changes to your copy of the code on your own GitHub account. Finally, create a PULL REQUEST, which tells the AREDN development team that you would like your changes to be reviewed for inclusion in the AREDN Master repository.
+
+![GitHub Workflow](_images/GitHub-workflow.png)
+
+#### One-time Repository Setup:
+
+1. Login to your own GitHub account and navigate in your browser to `https://github.com/aredn/aredn_ar71xx`
+2. Click the `Fork` button on the upper right side of the page.  You now have a copy of the AREDN source code on your own GitHub account.
+3. Go to your local computer and copy your fork of the AREDN source code: `git clone https://github.com/myCall/aredn_ar71xx`
+4. `cd aredn_ar71xx`  This directory contains your local copy of the AREDN source code. The following commands will be executed while you are in this directory or its subdirectories.
+5. `git remote add aredn https://github.com/aredn/aredn_ar71xx`  
+
+Now your local environment knows about both the master code repository and your forked copy on your GitHub account.
+
+#### Ongoing Development Cycle:
+
+1. Update your local environment with the latest code changes from the rest of the community, which will include any changes you had previously submitted.   *Caution:*  never make code changes directly on the `develop` branch.  This will result in inconsistencies between the main repository and your repository, requiring a force-remove of any changes you have made.
+	1. `git checkout develop`
+	2. `git pull aredn develop`
+2. Create a git code branch to fix a bug or implement a new feature:
+	1. `git checkout -b my-wiz-bang-feature-name`
+3. Make your changes and test them.
+4. When ready to submit changes, check to see whether they still work with code others have recently submitted. In GitHub terminology, “pull” down the latest changes and “rebase” or move your code on top of the latest. In this process you might find conflicts with someone else’s code, making further merge edits necessary.
+	1. `git stash` to stash the changes still in process.
+	2. `git checkout develop`
+	3. `git pull aredn develop`
+	4. `git checkout my-wiz-bang-feature-name`
+	5. `git rebase develop` to move your branch and changes on top of the latest code others have submitted.
+	6. `git stash pop` to reapply your stashed changes
+	7. Resolve any conflicts that need to be merged if warned in the step above.
+	8. Final build and validation that your changes work on top of the latest changes from all of the AREDN contributors.
+5. `Commit` your changes to your local repository, then `Push` the changes to your own GitHub repository.
+	1. `git commit`
+	2. `git push origin my-wiz-bang-feature-name`
+6. Create a `Pull Request` (PR) to the AREDN master repository by browsing to `github.com/myCall/aredn_ar71xx`, then select the my-wiz-bang-feature-name branch. Click the `New Pull Request` button to generate your Pull Request. Others can now review your code, test it, and give feedback. If feedback is given and you need to make changes, go back to step 3.
+7. Once your changes have been accepted into the AREDN master repository, delete your branch:
+	1. On your local repository: `git branch -D my-wiz-bang-feature-name`
+	2. On your forked copy of your GitHub repository: `git push origin --delete my-wiz-bang-feature-name`
+
+You can continue contributing new features by beginning the development cycle again, starting with step 1 on the Ongoing Development Cycle.
+
diff --git a/README.md b/README.md
@@ -1,2 +1,21 @@
-# aredn-doc
-This is a project to create AREDN documentation so it can be made available on ReadTheDocs.
+# AREDN Documentation
+This repository is for creating documentation for the AREDN project so it can be made available on ReadTheDocs.
+
+## Contributing:
+If you are interested in contributing to the rapidly growing set of AREDN related information, you can easily do so on GitHub. This works the same way as if you were contributing code to the project.
+
+AREDN documentation is written using the reStructuredText markup language. Text is saved in "rst" files.
+
+After you setup your GitHub account, you should:
+
+1. FORK the AREDN documentation repository to your GitHub account.
+2. Then, to send updates or additions, checkout your repository from github.com/your-account/documentation, commit local changes you have made (additions or corrections to the AREDN docs), push to origin (your repository).
+3. Create a pull request.
+
+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
+
+## Viewing the Docs:
+To view the AREDN documentation in a web browser, navigate to ReadTheDocs.org and search for the AREDN Documentation.
+
+## Exporting to PDF:
+While viewing the AREDN documentation in your web browser, you will see the Topics 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.
diff --git a/_images/GitHub-workflow.png b/_images/GitHub-workflow.png
diff --git a/...Started_Guide/_images/01-setup-nocall.png → ...ettingStarted/_images/01-setup-nocall.png b/...Started_Guide/_images/01-setup-nocall.png → ...ettingStarted/_images/01-setup-nocall.png
diff --git a/..._Started_Guide/_images/02-basic-setup.png → ...GettingStarted/_images/02-basic-setup.png b/..._Started_Guide/_images/02-basic-setup.png → ...GettingStarted/_images/02-basic-setup.png
diff --git a/..._Started_Guide/_images/03-node-status.png → ...GettingStarted/_images/03-node-status.png b/..._Started_Guide/_images/03-node-status.png → ...GettingStarted/_images/03-node-status.png
diff --git a/..._Started_Guide/_images/04-node-charts.png → ...GettingStarted/_images/04-node-charts.png b/..._Started_Guide/_images/04-node-charts.png → ...GettingStarted/_images/04-node-charts.png
diff --git a/..._Started_Guide/_images/05-mesh-status.png → ...GettingStarted/_images/05-mesh-status.png b/..._Started_Guide/_images/05-mesh-status.png → ...GettingStarted/_images/05-mesh-status.png
diff --git a/...Started_Guide/_images/06-admin-header.png → ...ettingStarted/_images/06-admin-header.png b/...Started_Guide/_images/06-admin-header.png → ...ettingStarted/_images/06-admin-header.png
diff --git a/...tarted_Guide/_images/07-setup-options.png → ...ttingStarted/_images/07-setup-options.png b/...tarted_Guide/_images/07-setup-options.png → ...ttingStarted/_images/07-setup-options.png
diff --git a/...Started_Guide/_images/08-port-forward.png → ...ettingStarted/_images/08-port-forward.png b/...Started_Guide/_images/08-port-forward.png → ...ettingStarted/_images/08-port-forward.png
diff --git a/...tarted_Guide/_images/09-admin-upgrade.png → ...ttingStarted/_images/09-admin-upgrade.png b/...tarted_Guide/_images/09-admin-upgrade.png → ...ttingStarted/_images/09-admin-upgrade.png
diff --git a/...ed_Guide/_images/10-tunneling-diagram.png → ...gStarted/_images/10-tunneling-diagram.png b/...ed_Guide/_images/10-tunneling-diagram.png → ...gStarted/_images/10-tunneling-diagram.png
diff --git a/...tarted_Guide/_images/11-tunnel-client.png → ...ttingStarted/_images/11-tunnel-client.png b/...tarted_Guide/_images/11-tunnel-client.png → ...ttingStarted/_images/11-tunnel-client.png
diff --git a/...ing_Started_Guide/_images/setup-login.png → arednGettingStarted/_images/setup-login.png b/...ing_Started_Guide/_images/setup-login.png → arednGettingStarted/_images/setup-login.png
diff --git a/Getting_Started_Guide/advanced_config.rst → arednGettingStarted/advanced_config.rst b/Getting_Started_Guide/advanced_config.rst → arednGettingStarted/advanced_config.rst
@@ -223,5 +223,15 @@ Click the **Administration** link to navigate to these settings. There are four
 **Support Data**
   There may be times when you want to view more detailed information about the configuration and operation of your node, or even forward this information to the AREDN |trade| forum in order to get help with a problem. Click *Download Support Data* to save a compressed archive file to your local computer.
 
+Node Reset Button
+-----------------
+
+The reset button on an AREDN |trade| node has two built-in functions based on the length of time the button is pressed.
+
+With the node powered on and fully booted:
+
+* Hold for 5 seconds to reset the password and DHCP server
+* Hold for 15 seconds to return the node to “just-flashed” condition
+
 .. |trade|  unicode:: U+02122 .. TRADE MARK SIGN
    :ltrim:
diff --git a/Getting_Started_Guide/aredn_overview.rst → arednGettingStarted/aredn_overview.rst b/Getting_Started_Guide/aredn_overview.rst → arednGettingStarted/aredn_overview.rst
diff --git a/Getting_Started_Guide/basic_setup.rst → arednGettingStarted/basic_setup.rst b/Getting_Started_Guide/basic_setup.rst → arednGettingStarted/basic_setup.rst
diff --git a/...ng_Started_Guide/downloading_firmware.rst → arednGettingStarted/downloading_firmware.rst b/...ng_Started_Guide/downloading_firmware.rst → arednGettingStarted/downloading_firmware.rst
diff --git a/...ing_Started_Guide/installing_firmware.rst → arednGettingStarted/installing_firmware.rst b/...ing_Started_Guide/installing_firmware.rst → arednGettingStarted/installing_firmware.rst
diff --git a/Getting_Started_Guide/mesh_status.rst → arednGettingStarted/mesh_status.rst b/Getting_Started_Guide/mesh_status.rst → arednGettingStarted/mesh_status.rst
diff --git a/Getting_Started_Guide/node_status.rst → arednGettingStarted/node_status.rst b/Getting_Started_Guide/node_status.rst → arednGettingStarted/node_status.rst
diff --git a/Getting_Started_Guide/selecting_devices.rst → arednGettingStarted/selecting_devices.rst b/Getting_Started_Guide/selecting_devices.rst → arednGettingStarted/selecting_devices.rst
@@ -17,7 +17,7 @@ One of the best sources of detailed device information is a manufacturer's datas
 
 If you are just getting started with AREDN |trade| you can easily begin with one of the low-cost devices that comes with an integrated antenna and a :abbr:`PoE (Power over Ethernet)` unit. If you are expanding your AREDN |trade| network with more sophisticated equipment, you may choose a standalone radio attached to any of several kinds of high-gain antennas.
 
-.. note:: See the **AREDN Design Guide** for more information about constructing robust mesh networks.
+.. note:: See the **AREDN Network Design Guide** for more information about constructing robust mesh networks.
 
 
 .. |trade|  unicode:: U+02122 .. TRADE MARK SIGN

diff --git a/arednNetworkDesign/_images/01-mesh-topology.png b/arednNetworkDesign/_images/01-mesh-topology.png
diff --git a/arednNetworkDesign/_images/02-link-types.png b/arednNetworkDesign/_images/02-link-types.png
diff --git a/arednNetworkDesign/_images/2.4ghz.png b/arednNetworkDesign/_images/2.4ghz.png
diff --git a/arednNetworkDesign/_images/3.4ghz.png b/arednNetworkDesign/_images/3.4ghz.png
diff --git a/arednNetworkDesign/_images/5.8ghz.png b/arednNetworkDesign/_images/5.8ghz.png
diff --git a/arednNetworkDesign/_images/900mhz.png b/arednNetworkDesign/_images/900mhz.png
diff --git a/arednNetworkDesign/_images/airlink-path.png b/arednNetworkDesign/_images/airlink-path.png
diff --git a/arednNetworkDesign/_images/align-nodes.png b/arednNetworkDesign/_images/align-nodes.png
diff --git a/arednNetworkDesign/_images/collocated-nodes.png b/arednNetworkDesign/_images/collocated-nodes.png
diff --git a/arednNetworkDesign/_images/dtd-linking.png b/arednNetworkDesign/_images/dtd-linking.png
diff --git a/arednNetworkDesign/_images/hidden-node.png b/arednNetworkDesign/_images/hidden-node.png
diff --git a/arednNetworkDesign/_images/radioMobile-coverage.png b/arednNetworkDesign/_images/radioMobile-coverage.png
diff --git a/arednNetworkDesign/_images/radioMobile-path.png b/arednNetworkDesign/_images/radioMobile-path.png
diff --git a/arednNetworkDesign/_images/vlan-isolation.png b/arednNetworkDesign/_images/vlan-isolation.png