Add glossary and indexing
authorJan Dittberner <jan@dittberner.info>
Sun, 24 Apr 2016 13:01:30 +0000 (15:01 +0200)
committerJan Dittberner <jan@dittberner.info>
Sun, 24 Apr 2016 13:01:30 +0000 (15:01 +0200)
This commit adds a glossary and some :term: marks. The system files for
emailout and monitor got titles and index terms.

docs/glossary.rst [new file with mode: 0644]
docs/index.rst
docs/systems/arbitration.rst
docs/systems/emailout.rst
docs/systems/infra02.rst
docs/systems/monitor.rst
docs/systems/template.rst

diff --git a/docs/glossary.rst b/docs/glossary.rst
new file mode 100644 (file)
index 0000000..19e6811
--- /dev/null
@@ -0,0 +1,12 @@
+Glossary
+========
+
+.. glossary::
+
+   LXC
+      `Linux Containers <https://linuxcontainers.org/>`_
+
+   Container
+      A container is an isolated system with a separate root file system and
+      operating system userland. The containers share a common operating system
+      kernel.
index a7c191b..17a4e83 100644 (file)
@@ -20,6 +20,7 @@ Contents:
    iplist
    sshkeys
    certlist
+   glossary
 
 
 Indices and tables
index 9a931ff..36bffc2 100644 (file)
@@ -40,7 +40,8 @@ Contact
 Additional People
 -----------------
 
-`Jan Dittberner`_ and `Mario Lipinski`_ have sudo access on that machine too.
+`Jan Dittberner`_ and `Mario Lipinski`_ have :program:`sudo` access on that
+machine too.
 
 .. _Jan Dittberner: jandd@cacert.org
 .. _Mario Lipinski: mario@cacert.org
@@ -51,9 +52,8 @@ Basics
 Physical Location
 -----------------
 
-This system is located in an LXC_ container on physical machine :doc:`infra02`.
-
-.. _LXC: https://linuxcontainers.org/
+This system is located in an :term:`LXC` container on physical machine
+:doc:`infra02`.
 
 Logical Location
 ----------------
index e69de29..a6fb000 100644 (file)
@@ -0,0 +1,5 @@
+.. index::
+   single: Systems; Emailout
+
+Emailout
+========
index bc0c213..35b054a 100644 (file)
@@ -12,14 +12,13 @@ The infrastructure host system Infra02 is a dedicated physical machine for the
 CAcert infrastructure.
 
 .. index::
-   single: LXC
    single: Ferm
 
-Infra02 is the host system for all infrastructure containers. The containers
-are setup using the Linux kernel's LXC_ system. The firewall for infrastructure
-is maintained on this machine using Ferm_.
+Infra02 is the host system for all infrastructure :term:`containers
+<container>`. The containers are setup using the Linux kernel's :term:`LXC`
+system. The firewall for infrastructure is maintained on this machine using
+Ferm_.
 
-.. _LXC: https://linuxcontainers.org/
 .. _Ferm: http://ferm.foo-projects.org/
 
 Administration
@@ -42,8 +41,8 @@ Contact
 Additional People
 -----------------
 
-`Wytze van der Raay`_ and `Mendel Mobach`_ have sudo access on that machine
-too.
+`Wytze van der Raay`_ and `Mendel Mobach`_ have :program:`sudo` access on that
+machine too.
 
 .. _Wytze van der Raay: wytze@cacert.org
 .. _Mendel Mobach: mendel@cacert.org
@@ -59,7 +58,7 @@ The machine is located in a server rack at BIT B.V. in the Netherlands.
 Physical Configuration
 ----------------------
 
-The machine has been sponsored by Thomas Krenn and has the following hardware
+The machine has been sponsored by `Thomas Krenn`_ and has the following hardware
 parameters:
 
 :Mainboard: Supermicro X9SCL/X9SCM Version 1.11A
@@ -77,6 +76,8 @@ There is a 2 TB USB backup disk attached to the system.
 
    See https://wiki.cacert.org/SystemAdministration/EquipmentList
 
+.. _Thomas Krenn: https://www.thomas-krenn.com/
+
 Logical Location
 ----------------
 
index e69de29..6260153 100644 (file)
@@ -0,0 +1,5 @@
+.. index::
+   single: Systems; Monitor
+
+Monitor
+=======
index de33829..7b8555d 100644 (file)
@@ -35,7 +35,7 @@ Contact
 Additional People
 -----------------
 
-`Person A`_ and `Person B`_ have sudo access on that machine too.
+`Person A`_ and `Person B`_ have :program:`sudo` access on that machine too.
 
 .. _Person A: persona@cacert.org
 .. _Person B: personb@cacert.org
@@ -50,9 +50,8 @@ Physical Location
 
 .. ## Use the following for containers on Infra02:
 
-This system is located in an LXC_ container on physical machine :doc:`infra02`.
-
-.. _LXC: https://linuxcontainers.org/
+This system is located in an :term:`LXC` container on physical machine
+:doc:`infra02`.
 
 Physical Configuration
 ----------------------