newUI-40

arednHow-toGuides/xlinks.rst

@@ -24,15 +24,15 @@ You can use either a *Mikrotik hAP ac2* or *ac3* as the AREDN® device on each e
   :alt: Ethernet Ports & Xlinks
   :align: center
 
-In this example we chose VLAN ``20`` because it is not in use anywhere else on our network. We assigned an *IP Address* of ``172.16.1.1`` for the near-side node, and we assigned ``172.16.1.2`` as the *Peer Address* for the node on the other side of the link. The xlink knows nothing about the details or configuration of the intermediate devices. The *Weight* is set to ``1`` which is the same weight as would be used by a tunnel connection, but this can be increased if you want the cross-link to be chosen at a lower priority for routing traffic on the mesh. *Port* ``lan3`` was chosen because it is an open port on this device. After entering these values, click ``Done`` and ``Commit`` your changes. Now you can cable your near-side PtP device to port 3 on your AREDN® node.
+In this example VLAN ``20`` is not in use anywhere else on the network. We assigned an *IP Address* of ``172.16.1.1`` for the near-side node, and we assigned ``172.16.1.2`` as the *Peer Address* for the node on the other side of the link. The xlink knows nothing about the details or configuration of the intermediate transport devices. The *Weight* is set to ``1`` which is the same weight as would be used by a tunnel connection, but this can be increased if you want the cross-link to be chosen at a lower priority for routing traffic on the mesh. *Port* ``lan3`` was chosen because it is an open port on this node. After entering these values, click ``Done`` and ``Commit`` your changes. Now you can cable your near-side transport device to port 3 on your AREDN® node.
 
 .. image:: _images/xlink.png
-  :alt: Cross-link diagram
+  :alt: xlink diagram
   :align: center
 
-Next, open the **Ethernet Ports & Xlinks** page on the node for the other side of the PtP link. Set the *IP Address* for that node to ``172.16.1.2`` and the *Peer Address* to ``172.16.1.1``. The *Weight* is set to ``1`` and the *Port* is set to ``lan4`` because that is an open port on the device. After entering these values, click ``Done`` and ``Commit`` your changes for this side of the PtP link. Now you can cable your far-side PtP device to port 4 on that AREDN® node.
+Next, open the **Ethernet Ports & Xlinks** page on the node for the other side of the link. Set the *IP Address* for that node to ``172.16.1.2`` and the *Peer Address* to ``172.16.1.1``. The *Weight* is set to ``1`` and the *Port* is set to ``lan4`` because that is an open port on this node. After entering these values, click ``Done`` and ``Commit`` your changes. Now you can cable your far-side transport device to port 4 on that AREDN® node.
 
-Configure the intermediate Point-to-Point link
+Configure the intermediate transport link
 ----------------------------------------------
 
-How data is moved between the peer devices is not restricted or defined. There are many types of vendor-specific Point-to-Point products that can be used to establish an AREDN® xlink. Refer to your manufacturer's documentation for the best way to ensure that network packets can be successfully transferred between the two endpoint devices. The easiest way to accomplish this is to bridge the traffic directly between the peer devices.
+How data is moved between the peer devices is not restricted or defined. There are many types of intermediate transport products that can be used to establish an AREDN® xlink. Refer to your manufacturer's documentation for the best way to ensure that network packets can be successfully transferred between the two endpoint devices. The easiest way to accomplish this is to bridge the traffic directly between the peer devices.

conf.py

@@ -17,6 +17,17 @@
 # sys.path.insert(0, os.path.abspath('.'))
 from datetime import date
 
+import os
+
+# Define the canonical URL if you are using a custom domain on Read the Docs
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+
+# Tell Jinja2 templates the build is running on Read the Docs
+if os.environ.get("READTHEDOCS", "") == "True":
+    if "html_context" not in globals():
+        html_context = {}
+    html_context["READTHEDOCS"] = True
+
 # -- Project information -----------------------------------------------------
 
 project = u'AREDN® Documentation'
@@ -36,21 +47,10 @@ release = u'latest'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
+#### ones.
-extensions = [
+###extensions = [
-    'sphinx.ext.autodoc',
+###    'sphinx.ext.autodoc',
-]
+###]
-
-###rst_epilog = """
-###`Link: AREDN® Webpage <https://www.arednmesh.org>`_
-###"""
-
-# Include the trademark symbol in the prolog
-###rst_prolog = """
-###.. |trade|  unicode:: U+00AE .. Registered Trademark SIGN
-###   :ltrim:
-###
-###"""
 
 # Add any paths that contain templates here, relative to this directory.
 #templates_path = ['_templates']
@@ -79,7 +79,6 @@ exclude_patterns = [u'_build', u'Thumbs.db', u'.DS_Store']
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for