From e75d4eb9f28cf56a0e8f0554626825cd010e4a36 Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Thu, 7 Oct 2021 21:08:23 +0200
Subject: [PATCH] L2SS-434: Add cross references

---
 docs/source/devices/configure.rst | 2 ++
 docs/source/logs.rst              | 4 +++-
 docs/source/monitoring.rst        | 8 +++++---
 docs/source/remote_interfaces.rst | 2 +-
 4 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/docs/source/devices/configure.rst b/docs/source/devices/configure.rst
index d3089de53..ba16efcba 100644
--- a/docs/source/devices/configure.rst
+++ b/docs/source/devices/configure.rst
@@ -6,6 +6,8 @@ The devices receive their configuration from two sources:
 - The TangoDB database, for static *properties*,
 - Externally, from the user, or a control system, that set *control attributes*.
 
+.. _tangodb:
+
 TangoDB
 -------------------------
 
diff --git a/docs/source/logs.rst b/docs/source/logs.rst
index fd6b9735a..91900af0a 100644
--- a/docs/source/logs.rst
+++ b/docs/source/logs.rst
@@ -7,7 +7,9 @@ The devices, and the docker containers in general, produce logging output. The e
 
 This is mostly useful for interactive use.
 
-ELK stack
+.. _elk:
+
+ELK
 ------------------
 
 To monitor the logs remotely, or to browse older logs, use the *ELK stack* that is included on the station, and served on http://localhost:5601. ELK, or ElasticSearch + Logstash + Kibana, is a popular log collection and querying system. Currently, the following logs are collected in our ELK installation:
diff --git a/docs/source/monitoring.rst b/docs/source/monitoring.rst
index 1fbcf81d7..0f479a429 100644
--- a/docs/source/monitoring.rst
+++ b/docs/source/monitoring.rst
@@ -17,10 +17,12 @@ You are encouraged to inspect each panel (graph) to see the underlying database
 
 The Grafana dashboards are configured with the following data sources:
 
-- *Prometheus*, the time-series database that caches the latest values of all monitoring points (see next section),
+- :ref:`prometheus-section`, the time-series database that caches the latest values of all monitoring points (see next section),
 - *Archiver DB*, the database that provides a long-term cache of attributes,
-- *Tango DB*, providing access to device properties (fixed settings),
-- *ELK*, the log output of the devices.
+- :ref:`tangodb`, providing access to device properties (fixed settings),
+- :ref:`elk`, the log output of the devices.
+
+.. _prometheus-section:
 
 Prometheus
 -------------------------
diff --git a/docs/source/remote_interfaces.rst b/docs/source/remote_interfaces.rst
index 452708cf0..f587e5592 100644
--- a/docs/source/remote_interfaces.rst
+++ b/docs/source/remote_interfaces.rst
@@ -24,7 +24,7 @@ Futhermore, there are some low-level interfaces:
 +---------------------+--------------+----------------------+-------------------+
 | :ref:`rest-api`     |tango-rest    |http://localhost:8080 |tango-cs/tango     |
 +---------------------+--------------+----------------------+-------------------+
-|Tango Database       |MariaDB       |http://localhost:3306 |tango/tango        |
+| :ref:`tangodb`      |MariaDB       |http://localhost:3306 |tango/tango        |
 +---------------------+--------------+----------------------+-------------------+
 |Archive Database     |MariaDB       |http://localhost:3307 |tango/tango        |
 +---------------------+--------------+----------------------+-------------------+
-- 
GitLab