Skip to content

Commit

Permalink
Doc version to update RTD latest for nightly builds
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
Steve Lewis KC0EUW authored and ae6xe committed Jan 10, 2019
1 parent 7590c97 commit ed2c658
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 12 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.DS_Store
Makefile
_build/
4 changes: 2 additions & 2 deletions arednGettingStarted/advanced_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Click the **Port Forwarding, DHCP, and Services** link to navigate to these sett

If your node is running its default DHCP server on the LAN network, it will automatically provide IP addresses to connected hosts. Look under the **Current DHCP Leases** heading to see the existing hosts and their assigned IP address.

.. note:: The hostnames of computers connected to the mesh at large must be unique. Typically you should prefix your amateur radio callsign to the computer's hostname in order to have the best chance of it being unique on the mesh network.
.. attention:: The hostnames of computers connected to the mesh at large must be unique. Typically you should prefix your amateur radio callsign to the computer's hostname in order to have the best chance of it being unique on the mesh network.

Since DHCP leases are dynamic and can change over time, there may be a reason why a host's assigned IP address should be made permanent. This is especially useful if that host will provide an application, program, or service through your node to the mesh network at large. You can permanently reserve that host's DHCP address by clicking the *Add* button to the right of the host in the *DHCP Leases* list. You will see that host now appears in the list under the **DHCP Address Reservations** heading above the list of leases.

Expand Down Expand Up @@ -207,7 +207,7 @@ Click the **Administration** link to navigate to these settings. There are four
:alt: Upgrade and Packages
:align: center

.. note:: Files cannot be uploaded to a node while a tunnel server or client connection is enabled. Disable tunnel client or server connections before uploading firmware, packages, or ssh key files. The *Upload* buttons will be disabled until tunnels are disabled.
.. attention:: Files cannot be uploaded to a node while a tunnel server or client connection is enabled. Disable tunnel client or server connections before uploading firmware, packages, or ssh key files. The *Upload* buttons will be disabled until tunnels are disabled.

**Firmware Update**
If you have a new firmware image that has already been downloaded to your computer, click the *Browse* button and select the firmware file to upload. Click *Upload* and the file will be uploaded and installed on the node.
Expand Down
18 changes: 18 additions & 0 deletions arednServicesGuide/services_overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
=======================
AREDN Services Overview
=======================

.. attention:: This section of the documentation is a work in progress.

As mentioned in the AREDN |trade| overview, the purpose of an amateur radio emergency data network is to provide typical Internet or intranet-type applications to people who need to communicate across a wide area during an emergency or community event. An AREDN |trade| network provides the transport mechanism for the types of applications people rely upon to communicate with each other in the normal course of their business and social interactions today. This may include keyboard-to-keyboard chat, email messages with text or image attachments, file transfer, collaborative document sharing, :abbr:`VoIP (Voice over IP)` phone service, video conferencing, GPS tracking, surveillance camera streaming, weather station reporting, sensor monitoring and control, repeater linking, and many other services.

The purpose for this section of the AREDN |trade| documentation is to identify the types programs that might be useful for communication across a mesh network. Almost any application that can operate across a peer-to-peer TCP/IP network is a candidate for AREDN |trade| networking, but you should carefully select and test your services to ensure they will work within the following restrictions.

* An important consideration for selecting programs is to understand the impact each service will have on the performance and reliability of the network during the times when digital communication is required.

* It is equally important to choose data services that will meet the criteria defined in FCC Part 97 regulations for amateur radio operators.



.. |trade| unicode:: U+02122 .. TRADE MARK SIGN
:ltrim:
13 changes: 5 additions & 8 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
# -- Project information -----------------------------------------------------

project = u'AREDN Documentation'
copyright = u'2018, AREDN'
copyright = u'2019, AREDN'
author = u'KC0EUW'

# The short X.Y version
version = u'3.18.9.0'
# The full version, including alpha/beta/rc tags
release = u'3.18.9.0'
release = u'3.18.9.0 base with additions'


# -- General configuration ---------------------------------------------------
Expand All @@ -43,7 +43,7 @@
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
#templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
Expand Down Expand Up @@ -75,9 +75,6 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
#html_theme = 'alabaster'
#html_theme = 'sphinxdoc'
#html_theme = 'nature'
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
Expand All @@ -89,7 +86,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
#html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down Expand Up @@ -117,7 +114,7 @@

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
'pointsize': '12pt',

# Additional stuff for the LaTeX preamble.
#
Expand Down
22 changes: 20 additions & 2 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,19 @@
AREDN Documentation
===================

:Version: 3.18.9.0
:Version: 3.18.9.0 plus nightly build additions
:Reviewers: KC0EUW, K5DLQ, AE6XE, K6AH, WU2S

This documentation set contains the *Getting Started Guide* which walks through the process of configuring an AREDN |trade| radio node. It also contains the *Network Design Guide* which provides background information and tips for planning and deploying a robust mesh network.
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.*
* 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.

.. toctree::
:maxdepth: 2
Expand All @@ -32,8 +41,17 @@ This documentation set contains the *Getting Started Guide* which walks through
arednNetworkDesign/channel_planning
arednNetworkDesign/network_modeling

.. toctree::
:maxdepth: 2
:caption: Applications and Services Guide
:hidden:

arednServicesGuide/services_overview


.. toctree::
:maxdepth: 1
:caption: Appendix
:hidden:

more_info
Expand Down

0 comments on commit ed2c658

Please sign in to comment.