Commit Graph

109 Commits

Author SHA1 Message Date
Steve AB7PA 4f262d25db
add spectral view to WiFi Scan section (#175)
* add spectral view to WiFi Scan section

* update scan screenshot

* eliminate "signal" from spectral view description

* include new auto distance Adv Config setting

* correct typo

* clarify wording
2022-06-29 11:17:31 -05:00
Steve Lewis AB7PA 7a11ac6790 update docs for latest LQM features 2022-06-16 17:44:12 -05:00
Steve Lewis AB7PA 3441e4766c fix broken link to Ethernet port usage 2022-06-12 19:31:54 -05:00
Steve AB7PA da022115cc
add SNR throughput guidelines from Andre (#168) 2022-06-01 11:21:15 -05:00
Steve Lewis AB7PA 8dfe2fb5bf expand NAT mode info for port forwarding etc 2022-05-23 18:51:11 -05:00
Steve AB7PA 0f5d80ad84
update new LQM value and screenshot (#164) 2022-05-20 22:46:28 -05:00
Steve AB7PA 3fe0b4eee1
add LQM to doc sections (#163)
* add LQM to How-To section

* add LQM to all relevant doc sections
2022-05-19 10:29:09 -05:00
AB7PA f4752dd009 tweak scp wording 2022-05-10 10:53:15 -05:00
AB7PA 8189b7966a add pointer to download paths 2022-05-10 10:53:15 -05:00
AB7PA 9c81265284 add Load Local Firmware instructions 2022-05-10 10:53:15 -05:00
Steve Lewis AB7PA dc4eb77875 clarify tunnel encryption wording 2022-05-01 13:50:35 -05:00
Steve AB7PA 094c0a0605
clarify unencrypted tunnels (#158)
Clarify that AREDN nodes do not have SSL libraries and do not encrypt 
tunnel traffic.
2022-04-28 15:35:22 -05:00
Steve AB7PA 0483a528f6
add iperf URL feature (#157)
Add the iperf URL feature to Adv Config and the iperf3 How-To.
2022-04-26 22:13:15 -05:00
Steve Lewis AB7PA 6773c2a4d6 add description for new wan.vlanid 2022-04-21 14:52:33 -05:00
Steve AB7PA ef7e422851
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 17:54:56 -07:00
Steve AB7PA fda6fda8ed
minimize links to old forum posts (#148) 2022-03-27 18:45:28 -05:00
Steve AB7PA dff873d8fa
update docs for Perl retirement (#146)
* 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
2022-03-22 14:16:00 -05:00
Steve Lewis AB7PA 6e633ed006 add descriptions for new UI features
Add descriptions for new UI features and make minor formatting changes 
to several pages for spacing around in-line images.
2022-03-13 21:34:02 -05:00
Steve AB7PA d3e3c4a2e5
Move Checklists to Install Section (#134) 2022-02-04 09:24:30 -06:00
Steve AB7PA 57d838ab21
add Low Memory to Adv Config (#119)
Add description for two Low Memory settings in Advanced Configuration 
display.
2021-12-08 08:03:47 -06:00
Steve AB7PA 1ed105a670
minor format tweaks (#118) 2021-11-14 17:04:51 -06:00
Steve AB7PA 57d9417321
Adv Config Note Callouts (#113)
* 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.
2021-05-03 10:37:42 -05:00
Steve AB7PA eb3da3bb72
Add Setting Tunnel Max Values (#111) 2021-04-27 10:06:40 -05:00
Steve AB7PA 58bd6583f2
Format Advanced Configuration Section (#109)
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.
2021-04-13 21:30:06 -05:00
Steve AB7PA 278b6a8bfb
Add Sphinx Makefile to repo (#104)
* 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.
2021-03-15 09:55:41 -05:00
Steve AB7PA dea6824945
Set trademark macro once for all (#94)
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.
2021-01-06 10:43:11 -06:00
Steve Lewis AB7PA 2d809cf23e Change Advanced Config title
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.
2020-12-18 11:29:32 -05:00
Steve Lewis AB7PA 2e932f0c1b Update links for new aredn code repo
Update links pointing to the new aredn code repo.
2020-12-17 21:01:21 -05:00
Steve AB7PA 57ae63c2ab
Add NAT Mode Aliases and misc formatting improvements
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.
2020-10-08 14:36:04 -07:00
Steve AB7PA 6c11aabfd3
Add DNS Aliases Section
Add the explanation for DNS Aliases to the Advanced Configuration 
section.
2020-09-08 17:28:31 -05:00
Steve Lewis AB7PA d1e51b9528 Add Do-Not-Propagate Section
Add a section to describe the "Do Not Propagate" feature.
2020-08-30 13:23:20 -05:00
Steve Lewis AB7PA a8c785d0dc Describe New Adv Config Slider
Describe the new Advanced Configuration slider for enabling/disabling 
settings.
2020-08-30 13:23:20 -05:00
Steve Lewis AB7PA 6f8d817cac Explain LAN DNS Issues
Explain that LAN devices need to let their connected node provide 
hostname resolution or issues could result.
2020-08-26 18:02:01 -05:00
Steve AB7PA f81c762a92
Local Alert Messages and Path (#72)
Add local alert message display and path to the documentation.
2020-08-24 08:11:48 -05:00
Steve Lewis KC0EUW d36ee5cbb9 Update adv config text
Update Adv Config text for OLSR restart to clarify process.  Fixes #65
2020-06-24 19:09:53 -05:00
Steve Lewis KC0EUW 619415b038
Add local package server How-To (#63)
* 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.
2020-06-03 07:40:53 -05:00
Steve Lewis KC0EUW 45aac37f94 Clarify WAN WiFi Client
Clarify wording in WAN WiFi Client section.
2020-04-21 19:11:11 -07:00
Steve Lewis KC0EUW 3a02fb8a6b Update Adv Config section
Another wording tweak.
2020-04-15 12:59:24 -07:00
Steve Lewis KC0EUW 782141db51 Update Adv Config section
Tweak wording in OLSR restart section.
2020-04-15 12:59:24 -07:00
Steve Lewis KC0EUW 2ad834433d Update Adv Config section
Add ital for Mesh Status display.
2020-04-15 12:59:24 -07:00
Steve Lewis KC0EUW 092d02ba8f Update Adv Config section
Tweak wording for OLSR Restart.
2020-04-15 12:59:24 -07:00
Steve Lewis KC0EUW e5f88775af Update Adv Config section
Clarify wording on OLSR restart.
2020-04-15 12:59:24 -07:00
Steve Lewis KC0EUW 8e51aad36f Update Adv Config section
Update the Advanced Config section with new AAM refresh setting and 
additional URL/path entries.
2020-04-15 12:59:24 -07:00
Steve Lewis KC0EUW e4e79a7fa8
Add note about tunnel issues with long nodenames (#54)
* 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.
2020-04-08 09:59:10 -05:00
Steve Lewis KC0EUW fd278adbd4
Update release to 3.20.3.0 (#52)
* 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.
2020-03-27 11:12:41 -05:00
Steve Lewis KC0EUW 249e0da301 Add features from OpenWRT
Add features inherited from OpenWRT as well as OLSR Restart and 
screenshot fixes.
2020-03-23 15:36:31 -07:00
Steve Lewis KC0EUW 2caf308673 Add WAN Wifi Client section (#44)
Add WAN Wifi Client section
2019-10-13 17:24:39 -07:00
Steve Lewis KC0EUW cc327d2f4f Add auto-distance to Advanced Config (#29)
* 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.
2019-05-14 11:54:44 -05:00
Steve Lewis KC0EUW 1e27cbf18e 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 08:21:09 -07:00
Steve Lewis KC0EUW f6489be51f Remove auto-distance explanation (#24)
Remove the auto-distance explanations since they will be deferred to a 
future release.
2019-03-21 09:48:23 -05:00
Steve Lewis KC0EUW 7d0998bf72 Update Advanced Config for 3.19.3.0-pre
Update the Advanced Configuration section to include changing node 
parameters.
2019-03-09 16:03:26 -07:00
Steve Lewis KC0EUW 9474eeadc2 Add Distance Setting information
Add the new Distance Auto-setting information to the Basic Setup 
screenshots and the advanced configuration text.
2019-02-25 17:19:11 -08:00
Steve Lewis KC0EUW f262b896a5 Add nightly build features (#16)
* 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
2019-02-17 17:54:30 -06:00
Steve Lewis KC0EUW 655619747f 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 15:06:16 -06:00
Steve Lewis KC0EUW 40a57dba2b 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
Steve Lewis KC0EUW ed2c6586d9 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 08:52:42 -08:00
Steve Lewis KC0EUW 7590c970b4 Doc clarifications 2019-01-07 09:01:53 -08:00
Steve Lewis KC0EUW 737960b320 Update advanced_config.rst
Changes per dman776: node powered on and fully booted.
2018-12-16 15:30:11 -07:00
Steve Lewis KC0EUW 6af8e8293c 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