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

97 lines
3.3 KiB
ReStructuredText
Raw Normal View History

Add AREDN logo to 2 pages Add the AREDN logo to two top-level pages.
2019-02-20 10:10:54 -07:00
.. image:: _images/AREDN-Logo.png
:alt: AREDN
:align: right
Change TM to Registered Trademark symbol Change the TM symbol to the Registered Trademark symbol throughout the project. Also, add two descriptive paragraphs to the Tunnel section.
2019-03-24 09:21:09 -06:00
===========================
AREDN |trade| Documentation
===========================
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
Add version macro in RST files (#103)
2021-02-04 07:26:33 -07:00
:Release: |release|
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.
Add screenshots and diagrams for service examples Add screenshots and diagrams for as many of the service program examples as possible.
2019-01-25 09:15:11 -07:00
* The **Applications and Services Guide** discusses the types of programs or services that can be used across a mesh network.
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.
Change TM to Registered Trademark symbol Change the TM symbol to the Registered Trademark symbol throughout the project. Also, add two descriptive paragraphs to the Tunnel section.
2019-03-24 09:21:09 -06:00
If you would like to see the documentation for a specific AREDN |trade| 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
Add BY-NC-ND License Add the Creative Commons Attribution-NonCommercial-NoDerivatives license pages, and include license info on the footer of each HTML page in RTD.
2021-01-20 09:18:08 -07:00
.. note:: AREDN |trade| is a registered trademark of *Amateur Radio Emergency Data Network, Inc.* and may not be used without permission.
Add registered trademark ID to top page Add the registered trademark identifier to the index.rst page.
2019-03-24 09:42:45 -06:00
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
change section title and filename
2022-06-23 05:37:46 -06:00
arednGettingStarted/report_issues
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
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 Network Discovery Tools section (#190) * add Network Discovery Tools section * add disclaimer line None of these programs are directly supported by the AREDN development team.
2022-08-19 10:27:38 -06:00
arednServicesGuide/network_tools
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:
rework tips for uploading firmware (#152) Consolidate firmware upload troubleshooting tips into a single section. Also change bullet list character throughout. * refer to deep dive for info on autodistance setting * clarify auto-distance setting * callout auto-distance caution * include reference for testing distance settings
2022-04-13 18:54:56 -06:00
arednHow-toGuides/firmware_tips
Add how-to connect nodes to home routers Add How-To to simplify the idea of connecting nodes to home networks.
2020-02-24 07:44:33 -07:00
arednHow-toGuides/home-router-connection
add docs for Supernodes (#289) * add docs for Supernodes * remove configuration details for now * add supernode diagram
2023-09-20 16:42:06 -06:00
arednHow-toGuides/poe
arednHow-toGuides/lqm
add steps for configuring a Supernode (#326) * add steps for building supernode * edit steps for building supernode * add supernode how-to * add supernode config steps
2023-12-11 16:10:22 -07:00
arednHow-toGuides/supernodes
add docs for Supernodes (#289) * add docs for Supernodes * remove configuration details for now * add supernode diagram
2023-09-20 16:42:06 -06:00
arednHow-toGuides/iperf
add cmd line how-to section (#300)
2023-10-11 14:30:57 -06:00
arednHow-toGuides/command-line
Add SISO-MIMO section Add a doc section comparing SISO and MIMO devices.
2019-08-31 13:29:52 -06:00
arednHow-toGuides/siso-mimo
Doc fixes and restructuring (#14) * Doc fixes and restructuring This commit includes several misc changes to doc set. Create appendix directory and add freq section with website images. Expand how-to contribute section. Add reference to new 29 Host LAN mode. Add SNR sound control to SNR graphs section. Add Radio Mobile Settings to How-To section. Update images in Freq Spectrum section, and minimize reference to "unshared" channels. Move Server Sync section to Services Overview. * Fix misleading keyword search wording Fix the misleading wording about doing a keyword search for AREDN. * Fix total bandwidth allocation wording Fix total bandwidth allocation wording in Radio Spectrum section. * Clarify channel width at band edges Clarify the warning against using wide channels that could transmit outside of allowed FCC allocations. * Heading change in services overview * Add balancing comment about reducing channel width Add a balancing comment that reducing channel width to increase SNR also cuts throughput in half. * Add SNR warning comment * Fix reference to OpenWRT in screenshot Replace reference to OpenWRT in screenshot with the AREDN login banner.
2019-02-05 14:06:16 -07:00
arednHow-toGuides/radio_mobile_settings
add antenna aligning tips Add a new How-To with tips for aligning directional antennas.
2021-11-12 08:48:47 -07:00
arednHow-toGuides/dish-aiming
arednHow-toGuides/puttygen_ssh_keys
arednHow-toGuides/local-package-repo
add xlinks how-to (#309)
2023-11-03 08:47:36 -06:00
arednHow-toGuides/xlinks
Add developer tools section (#43) Add a Developer Tools section to the documentation repository.
2019-09-26 14:06:43 -06:00
arednHow-toGuides/devtools
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
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
include a Known Issues list in the Appendix (#204)
2022-09-10 20:53:03 -06:00
appendix/known_issues
Doc fixes and restructuring (#14) * Doc fixes and restructuring This commit includes several misc changes to doc set. Create appendix directory and add freq section with website images. Expand how-to contribute section. Add reference to new 29 Host LAN mode. Add SNR sound control to SNR graphs section. Add Radio Mobile Settings to How-To section. Update images in Freq Spectrum section, and minimize reference to "unshared" channels. Move Server Sync section to Services Overview. * Fix misleading keyword search wording Fix the misleading wording about doing a keyword search for AREDN. * Fix total bandwidth allocation wording Fix total bandwidth allocation wording in Radio Spectrum section. * Clarify channel width at band edges Clarify the warning against using wide channels that could transmit outside of allowed FCC allocations. * Heading change in services overview * Add balancing comment about reducing channel width Add a balancing comment that reducing channel width to increase SNR also cuts throughput in half. * Add SNR warning comment * Fix reference to OpenWRT in screenshot Replace reference to OpenWRT in screenshot with the AREDN login banner.
2019-02-05 14:06:16 -07:00
appendix/more_info
add responsible disclosure policy (#178)
2022-07-20 10:22:33 -06:00
appendix/responsible_disclosure
appendix/freq_charts
add list of acronyms used in this doc set (#199)
2022-09-02 07:46:18 -06:00
appendix/acronyms
add responsible disclosure policy (#178)
2022-07-20 10:22:33 -06:00
appendix/LICENSE