[trafficcontrol] 40/46: linking extensions to their sections

[mi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mitchell852 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git

commit a54847ffc97cdc31ca022879cf938ff8ef6508ae
Author: ocket8888 <oc...@gmail.com>
AuthorDate: Mon Sep 17 09:02:26 2018 -0600

    linking extensions to their sections
---
 docs/source/admin/traffic_ops/extensions.rst | 4 ++++
 docs/source/overview/traffic_ops.rst         | 8 ++++----
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/docs/source/admin/traffic_ops/extensions.rst b/docs/source/admin/traffic_ops/extensions.rst
index e3fe7e6..559ac85 100644
--- a/docs/source/admin/traffic_ops/extensions.rst
+++ b/docs/source/admin/traffic_ops/extensions.rst
@@ -21,6 +21,8 @@ Managing Traffic Ops Extensions
 
 Traffic Ops supports two types of extensions. 'Check Extensions' are analytics scripts that collect and display information as columns in the table under 'Monitor' -> 'Cache Checks' in Traffic Portal. 'Data Source Extensions' provide ways to add data to the graph views and usage APIs.
 
+.. _to-check-ext:
+
 Check Extensions
 ================
 Each extension is a separate bash script located in ``$TO_HOME/bin/checks/`` on the Traffic Ops server (though practically, they can be any executable). The extensions must be registered with Traffic Ops in order to display a column on the Cache Checks page. The currently registered extensions can be listed by running ``/opt/traffic_ops/app/bin/extensions -a``. Some extensions automatically registered with the Traffic Ops database (``to_extension`` table) at install time (see ``traffic_o [...]
@@ -34,6 +36,8 @@ Each extension is a separate bash script located in ``$TO_HOME/bin/checks/`` on
 :check_name: The name of the check e.g. ``CDU``, ``CHR``, ``DSCP``, ``MTU``, etc...
 :log_level: A whole number between 1 and 4 (inclusive), with 4 being the most verbose. This field is optional
 
+.. _to-datasource-ext:
+
 Data Source Extensions
 ======================
 Data Source Extensions work in much the same way as `Check Extensions`_, but are implemented differently. Rather than being a totally external executable, a Data Source Extension *must* be written in Perl 5, as they are injected via manipulation of the ``$PERL5LIB`` environment variable. These extensions are not very well-documented (as you may be able to tell), and support for extending them may be phased out in future releases.
diff --git a/docs/source/overview/traffic_ops.rst b/docs/source/overview/traffic_ops.rst
index 12b01fc..84936b5 100644
--- a/docs/source/overview/traffic_ops.rst
+++ b/docs/source/overview/traffic_ops.rst
@@ -31,11 +31,11 @@ Traffic Ops Extension
 ---------------------
 Traffic Ops Extensions are a way to enhance the basic functionality of Traffic Ops in a custom manner. There are two types of extensions:
 
-Check Extension
-	Allows you to add custom checks to the 'Monitor' -> 'Cache Checks' view.
+:ref:`to-check-ext`
+	Allow you to add custom checks to the 'Monitor' -> 'Cache Checks' view.
 
-Data source Extensions
-	Allows you to add data sources for the graph views and usage APIs.
+:ref:`to-datasource-ext`
+	Allow you to add data sources for the graph views and usage APIs.
 
 
 .. These are listed as "in beta" as far back as TO 1.0, sooo