extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2024-11-22 00:13:52 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: drop references to 'main config file'

Browse Source 
were just confusing in the remaining places where they were used

fixes #127
This commit is contained in:
Christian Schwarz 2019-03-18 14:48:12 +01:00
parent 53dc0c3c5e
commit fb999c8617
5 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/configuration/jobs.rst
View File

@ -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**.

2
docs/configuration/logging.rst
View File

@ -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.
::

2
docs/configuration/monitoring.rst
View File

@ -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:

3
docs/global.rst.inc
View File

@ -1,3 +1,4 @@
.. global list of substitutions
.. |mainconfig| replace:: :ref:`main configuration file <mainconfigfile>`
..
.. |macroname| replace:: macro expansion

2
docs/installation.rst
View File

@ -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?
----------