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
* update docs for Perl retirement
With the retirement of Perl and the inclusion of tunneling in the base
build, there are several steps and warnings that no longer apply. These
have been removed from the docs.
* add tunnel.wanonly description
* update slider screenshot
* Adv Config Note Callouts
Add note callouts to several Advanced Configuration items, referring
readers to more detailed discussion in the How-To section.
* Adv Config Note Callouts
Add link to arednmesh.org on top and bottom of every page.
Break the Advanced Configuration section into parts with separate
screenshots. This should make it more readable, since the Adv Conf table
is becoming quite large.
* Add Sphinx Makefile to repo
Add the Sphinx Makefile to the repository.
* Fix (R) symbol on tunnel diagram
Fix the (R) symbol on the tunneling diagram.
* Tweak conf.py
* Revert "Tweak conf.py"
This reverts commit 8bf1c874ec.
* Set March 2021 Release Date
Set the doc release date to March 2021 so it corresponds to the next
code Stable Release of 3.21.3.0
* Adjust Tunnel diagram
Tighten up the tunnel diagram.
* Clarify Tunnel Client Graphic
Clarify the graphic for tunnel clients.
* Adjust alert banner color
Adjust alert banner to display the new color.
* Add AAM purge to advConfig
Add the new AAM purge description in the Advanced Configuration section.
* Add sysinfo.json Mesh_Gateway
Add new mesh_gateway info to the description of sysinfo.json.
Set the trademark macro once as a prolog to all RST files. Reduces the
possibility of error by removing the requirement for the trademark macro
within every RST.
Change the Advanced Configuration section title to Configuration Deep
Dive in order to avoid confusion with the existing Advanced
Configuration menu item. Also change all project references to the old
section title.
Add distinction between DNS Aliases for Direct Mode vs NAT Mode to
describe the feature in ar71xx PR#573.
Include small format changes for firmware install steps.
Include note for tunneling using nodes with built-in switches.
Minor formatting tweaks.
Minor formatting changes on Installing Firmware.
Minor formatting changes to four sections, making formats consistent
across sections.
Format Install Firmware section consistently.
More formatting consistency checks in additional doc sections.
*Add display color info for DoNotPropagate nodes and Aliases on the Mesh Status page.
* Revise diagram and text for docs workflow
* Clarify git stage/commit process
* Add info about Sphinx for doc testing
* Add info about reStructuredText markup
* Clarify github usernames and best practice resource for commit messages.
* Update installing_firmware.rst
Added tips related to browser session management not always working properly and Windows firewall.
* Update installing_firmware.rst
Typos.
* Revert "Update installing_firmware.rst"
This reverts commit f8c07ee67b.
* Revert "Update installing_firmware.rst"
This reverts commit 1f9abd25f1.
* Update installing_firmware.rst
Moved tip for Tiny PXE Server to troubleshooting.
* Update installing_firmware.rst
* Moved troubleshooting up
Moved Troubleshooting up to make more people read possible problems they may encounter prior to start following instructions.
* Add local package server How-To
Add a How-To section explaining how to create a local package host.
* Add local package server How-To
Tweak wording slightly.
* Add local package server How-To
Specify hAP ac lite as a device supporting PoE passthrough.
* Add local package server How-To
Mention recursive copying for httrack and wget.
* Update Optional Settings text
Update the Optional Settings description in the Basic Setup document.
* Update Optional Settings text
Add section headers.
* Clarify non-private messaging
Clarify that directed messages are not guaranteed to be private since
anyone can view the arednmesh message repository.
* Clarify non-private messaging
Fix typo in screenshot.
* Add note about tunnel issues with long nodenames
Add a note about tunnel issues with clients having long node names.
* Add note about tunnel issues with long nodenames
Included a link to the AREDN forum thread for more
information/discussion.
* Add note about tunnel issues with long nodenames
Clarify it's the vtun package that has the limitation.
* Update release to 3.20.3.0
Update release number in screenshots to 3.20.3.0. Include new comment
field for tunnels.
* Update wording for firmware targets
Update wording for firmware targets.
* Add steps to Firmware Upgrade Tips
Add steps to the Firmware Upgrade Tips section, and include more info in
the OLSR Restart section.
* Add wifi down to Troubleshooting Tips
Add the "wifi down" tip for troubleshooting firmware installs that
result in a "bad gateway" message.
* Add wifi down to Troubleshooting-2
Remove # for clarity.
Rework the Channel Planning section to clarify, expand, and illustrate
the importance of channel plans and frequency coordination.
Clarify Radio Spectrum section
Add HeyWhatsThat Profiler to Network Modeling section
Clarify the explanation of equipment size and gain for the different
bands.
Tweak the description of antenna polarization to clarify.
Clarify the statement about link quality so it is adequate for required
applications.
* Add clear browser cache to firmware install section
Add a paragraph explaining why clearing the web browser cache may be
required during firmware installs.
* Update link types graphic
Update link types graphic
* Update backbone diagram
Update backbone link on topology diagram
* Update backbone diagram
* Add auto-distance to Advanced Config
Add the auto-distance explanation to the Advanced Configuration page.
* Update trademark sign on adv config
Update the trademark sign on the advanced config page.
* Replace tunnel explanation
Replace tunnel explanation.
* Add nightly build features
Add nightly build features for SNR sound control and Basic Setup
screens.
* Add explanation for pitch/volume sliders
* Clarify wording on when LAN AP display appears
Clarify the wording about when the LAN AP display section will appear in
the UI.
* Fix snr-sound image
Fix the snr-sound image.
* Add Other Possible Services section
Add the Other Possible Services section to the doc set.
* Correct typo in image name
* Update screenshots to 3.19.3.0
Update screenshots to 3.19.3.0 version and change text to 3.19.3.0
pre-release
* Update etherpad screenshot
* 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.
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.
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.
Steve Lewis AB7PA