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

77 lines
2.7 KiB
ReStructuredText
Raw Normal View History

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
===================
Doc version to update RTD latest for nightly builds Add build files to gitignore. Change admonition type to attention. Create AREDN Services Guide and Services Overview docs as a work in progress. Update conf.py with new copyright year and release info. Expand index.rst with description of sections, and added Services Guide to toctree.
2019-01-10 06:26:11 -07:00
:Version: 3.18.9.0 plus nightly build additions
Update index.rst (#3) * Update index.rst * Update index.rst * Update README.md
2018-12-24 13:48:52 -07:00
:Reviewers: KC0EUW, K5DLQ, AE6XE, K6AH, WU2S
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
Doc version to update RTD latest for nightly builds Add build files to gitignore. Change admonition type to attention. Create AREDN Services Guide and Services Overview docs as a work in progress. Update conf.py with new copyright year and release info. Expand index.rst with description of sections, and added Services Guide to toctree.
2019-01-10 06:26:11 -07:00
This documentation set consists of several sections which are shown in the navigation list.
* The **Getting Started Guide** walks through the process of configuring an AREDN |trade| radio node to be part of a mesh network.
* The **Network Design Guide** provides background information and tips for planning and deploying a robust mesh network.
* The **Applications and Services Guide** discusses the types of programs or services that can be used across a mesh network. *NOTE: This section is incomplete while in progress.*
Modified .gitignore forWU2S local environment on Windows 10. Created How-to Guides section with initial chapter on making SSH keys on Windows computers.
2019-01-22 14:31:46 -07:00
* The **How-to Guides** provide tips and techniques for various tasks.
Doc version to update RTD latest for nightly builds Add build files to gitignore. Change admonition type to attention. Create AREDN Services Guide and Services Overview docs as a work in progress. Update conf.py with new copyright year and release info. Expand index.rst with description of sections, and added Services Guide to toctree.
2019-01-10 06:26:11 -07:00
* Finally, the **Appendix** contains supplementary information.
If you wish to locate specific topics within the documentation, you can type keywords into the *Search docs* field to display a list of items which match your search.
If you would like to see the documentation for a specific AREDN release, click on the **Read the Docs** label at the bottom of the navigation bar. This label shows the version you are currently viewing, but clicking the label bar opens a panel with several other options. Here you may choose to view another version of the documentation, and you can also download the entire documentation set in any of several formats *(PDF, ePub, HTML)* for offline use.
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
.. toctree::
Add content for Email and File Sharing Add content for email and file sharing sections. Add placeholder for Computer Aided Dispatch section.
2019-01-23 08:37:32 -07:00
:maxdepth: 1
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
:caption: Getting Started Guide
Update index.rst (#3) * Update index.rst * Update index.rst * Update README.md
2018-12-24 13:48:52 -07:00
:hidden:
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
arednGettingStarted/aredn_overview
arednGettingStarted/selecting_devices
arednGettingStarted/downloading_firmware
arednGettingStarted/installing_firmware
arednGettingStarted/basic_setup
arednGettingStarted/node_status
arednGettingStarted/mesh_status
arednGettingStarted/advanced_config
.. toctree::
Add content for Email and File Sharing Add content for email and file sharing sections. Add placeholder for Computer Aided Dispatch section.
2019-01-23 08:37:32 -07:00
:maxdepth: 1
Modified .gitignore forWU2S local environment on Windows 10. Created How-to Guides section with initial chapter on making SSH keys on Windows computers.
2019-01-22 14:31:46 -07:00
:caption: Network Design Guide
:hidden:
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
Modified .gitignore forWU2S local environment on Windows 10. Created How-to Guides section with initial chapter on making SSH keys on Windows computers.
2019-01-22 14:31:46 -07:00
arednNetworkDesign/networking_overview
arednNetworkDesign/network_topology
arednNetworkDesign/frequency_bands
arednNetworkDesign/channel_planning
arednNetworkDesign/network_modeling
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
Doc version to update RTD latest for nightly builds Add build files to gitignore. Change admonition type to attention. Create AREDN Services Guide and Services Overview docs as a work in progress. Update conf.py with new copyright year and release info. Expand index.rst with description of sections, and added Services Guide to toctree.
2019-01-10 06:26:11 -07:00
.. toctree::
Add content for Email and File Sharing Add content for email and file sharing sections. Add placeholder for Computer Aided Dispatch section.
2019-01-23 08:37:32 -07:00
:maxdepth: 1
Doc version to update RTD latest for nightly builds Add build files to gitignore. Change admonition type to attention. Create AREDN Services Guide and Services Overview docs as a work in progress. Update conf.py with new copyright year and release info. Expand index.rst with description of sections, and added Services Guide to toctree.
2019-01-10 06:26:11 -07:00
:caption: Applications and Services Guide
:hidden:
arednServicesGuide/services_overview
Add to Services Guide sections Add sections to the AREDN Services Guide; update index for new sections; expand overview; create first draft of Chat Services section.
2019-01-16 13:32:20 -07:00
arednServicesGuide/chat_programs
arednServicesGuide/email_programs
arednServicesGuide/file_sharing
arednServicesGuide/voip_programs
arednServicesGuide/video_streaming
Add content for Email and File Sharing Add content for email and file sharing sections. Add placeholder for Computer Aided Dispatch section.
2019-01-23 08:37:32 -07:00
arednServicesGuide/dispatch_programs
Add to Services Guide sections Add sections to the AREDN Services Guide; update index for new sections; expand overview; create first draft of Chat Services section.
2019-01-16 13:32:20 -07:00
arednServicesGuide/other_programs
Doc version to update RTD latest for nightly builds Add build files to gitignore. Change admonition type to attention. Create AREDN Services Guide and Services Overview docs as a work in progress. Update conf.py with new copyright year and release info. Expand index.rst with description of sections, and added Services Guide to toctree.
2019-01-10 06:26:11 -07:00
Modified .gitignore forWU2S local environment on Windows 10. Created How-to Guides section with initial chapter on making SSH keys on Windows computers.
2019-01-22 14:31:46 -07:00
.. toctree::
Add content for Email and File Sharing Add content for email and file sharing sections. Add placeholder for Computer Aided Dispatch section.
2019-01-23 08:37:32 -07:00
:maxdepth: 1
Modified .gitignore forWU2S local environment on Windows 10. Created How-to Guides section with initial chapter on making SSH keys on Windows computers.
2019-01-22 14:31:46 -07:00
:caption: How-to Guides
:hidden:
arednHow-toGuides/howto_overview
arednHow-toGuides/puttygen_ssh_keys
Update index.rst (#3) * Update index.rst * Update index.rst * Update README.md
2018-12-24 13:48:52 -07:00
.. toctree::
:maxdepth: 1
Doc version to update RTD latest for nightly builds Add build files to gitignore. Change admonition type to attention. Create AREDN Services Guide and Services Overview docs as a work in progress. Update conf.py with new copyright year and release info. Expand index.rst with description of sections, and added Services Guide to toctree.
2019-01-10 06:26:11 -07:00
:caption: Appendix
Update index.rst (#3) * Update index.rst * Update index.rst * Update README.md
2018-12-24 13:48:52 -07:00
:hidden:
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 index.rst (#3) * Update index.rst * Update index.rst * Update README.md
2018-12-24 13:48:52 -07:00
more_info
.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
:ltrim: