From fb999c8617b3e7c1b9dfda2979dcfaccf48d8ce6 Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Mon, 18 Mar 2019 14:48:12 +0100 Subject: [PATCH] docs: drop references to 'main config file' were just confusing in the remaining places where they were used fixes #127 --- docs/configuration/jobs.rst | 2 +- docs/configuration/logging.rst | 2 +- docs/configuration/monitoring.rst | 2 +- docs/global.rst.inc | 3 ++- docs/installation.rst | 2 -- 5 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/configuration/jobs.rst b/docs/configuration/jobs.rst index 2b6edfd..9a2ea89 100644 --- a/docs/configuration/jobs.rst +++ b/docs/configuration/jobs.rst @@ -14,7 +14,7 @@ Job Types & Replication Overview & Terminology ---------------------- -A *job* is the unit of activity tracked by the zrepl daemon and configured in the |mainconfig|. +A *job* is the unit of activity tracked by the zrepl daemon. Every job has a unique ``name``, a ``type`` and type-dependent fields which are documented on this page. Replication always happens between a pair of jobs: one is the **active side**, and one the **passive side**. diff --git a/docs/configuration/logging.rst b/docs/configuration/logging.rst index a9077bb..7a5bb5a 100644 --- a/docs/configuration/logging.rst +++ b/docs/configuration/logging.rst @@ -7,7 +7,7 @@ Logging zrepl uses structured logging to provide users with easily processable log messages. -Logging outlets are configured in the ``global`` section of the |mainconfig|. +Logging outlets are configured in the ``global`` section of the config file. :: diff --git a/docs/configuration/monitoring.rst b/docs/configuration/monitoring.rst index f0e97dc..138b968 100644 --- a/docs/configuration/monitoring.rst +++ b/docs/configuration/monitoring.rst @@ -5,7 +5,7 @@ Monitoring ========== -Monitoring endpoints are configured in the ``global.monitoring`` section of the |mainconfig|. +Monitoring endpoints are configured in the ``global.monitoring`` section of the config file. .. _monitoring-prometheus: diff --git a/docs/global.rst.inc b/docs/global.rst.inc index bbe9204..0074484 100644 --- a/docs/global.rst.inc +++ b/docs/global.rst.inc @@ -1,3 +1,4 @@ .. global list of substitutions -.. |mainconfig| replace:: :ref:`main configuration file ` +.. + .. |macroname| replace:: macro expansion diff --git a/docs/installation.rst b/docs/installation.rst index a9086ca..a3c8cc5 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -80,8 +80,6 @@ Either way, all build results are located in the ``artifacts/`` directory. It is your job to install the apropriate binary in the zrepl users's ``$PATH``, e.g. ``/usr/local/bin/zrepl``. Otherwise, the examples in the :ref:`tutorial` may need to be adjusted. -.. _mainconfigfile: - What next? ----------