Use :wiki: role, streamline structure
authorJan Dittberner <jan@dittberner.info>
Thu, 5 May 2016 19:41:11 +0000 (21:41 +0200)
committerJan Dittberner <jan@dittberner.info>
Thu, 5 May 2016 19:41:11 +0000 (21:41 +0200)
This commit replaces regular Wiki URLs with :wiki: role links and adds
an "Application Links" section to existing pages for the arbitration,
blog, board, monitor and webmail containers.

docs/critical/template.rst
docs/network.rst
docs/people.rst
docs/systems/arbitration.rst
docs/systems/blog.rst
docs/systems/board.rst
docs/systems/infra02.rst
docs/systems/monitor.rst
docs/systems/template.rst
docs/systems/webmail.rst

index 7ab0e91..006f7ed 100644 (file)
@@ -68,7 +68,7 @@ Physical Configuration
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/EquipmentList
+   See :wiki:`SystemAdministration/EquipmentList`
 
 Logical Location
 ----------------
@@ -97,7 +97,7 @@ Name                       Type     Content
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/Procedures/DNSChanges
+   See :wiki:`SystemAdministration/Procedures/DNSChanges`
 
 Operating System
 ----------------
@@ -289,7 +289,7 @@ Keys and X.509 certificates
 .. seealso::
 
    * :doc:`../certlist`
-   * https://wiki.cacert.org/SystemAdministration/CertificateList
+   * :wiki:`SystemAdministration/CertificateList`
 
 <service_x> configuration
 -------------------------
@@ -327,11 +327,11 @@ Additional documentation
 
 .. seealso::
 
-   * https://wiki.cacert.org/Exim4Configuration
-   * https://wiki.cacert.org/PostfixConfiguration
-   * https://wiki.cacert.org/QmailConfiguration
-   * https://wiki.cacert.org/SendmailConfiguration
-   * https://wiki.cacert.org/StunnelConfiguration
+   * :wiki:`Exim4Configuration`
+   * :wiki:`PostfixConfiguration`
+   * :wiki:`QmailConfiguration`
+   * :wiki:`SendmailConfiguration`
+   * :wiki:`StunnelConfiguration`
 
 References
 ----------
index 33e79f2..b8262f0 100644 (file)
@@ -2,11 +2,11 @@ Network
 =======
 
 .. this page contains information from the IP address list at
-   https://wiki.cacert.org/SystemAdministration/IPList
+   :wiki:`SystemAdministration/IPList`
 
 .. seealso::
 
-   https://wiki.cacert.org/SystemAdministration/IPList
+   :wiki:`SystemAdministration/IPList`
 
 
 Internet
index f68b593..91d2a92 100644 (file)
@@ -17,7 +17,7 @@ Jan Dittberner
 
 :roles: :term:`Infrastructure Team Lead`, :term:`Infrastructure Administrator`
 :contact: jandd@cacert.org
-:wiki: https://wiki.cacert.org/JanDittberner
+:wiki: :wiki:`JanDittberner`
 :irc: jandd
 
 .. _people_martin:
index 91ecff5..7558690 100644 (file)
@@ -10,6 +10,12 @@ Purpose
 
 This system is planned to host a future collaboration platform for arbitrators.
 
+Application Links
+-----------------
+
+Arbitration nginx welcome page
+   http://arbitration.cacert.org/
+
 Administration
 ==============
 
@@ -28,8 +34,6 @@ There is no application yet.
 
 .. todo:: setup application(s) and document admins
 
-.. * <application>: <sysadmin's name>
-
 Contact
 -------
 
@@ -79,7 +83,7 @@ arbitration.intra.cacert.org. IN A     172.16.2.241
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/Procedures/DNSChanges
+   See :wiki:`SystemAdministration/Procedures/DNSChanges`
 
 Operating System
 ----------------
@@ -253,7 +257,7 @@ Keys and X.509 certificates
 .. seealso::
 
    * :doc:`../certlist`
-   * https://wiki.cacert.org/SystemAdministration/CertificateList
+   * :wiki:`SystemAdministration/CertificateList`
 
 Nginx configuration
 -------------------
@@ -285,10 +289,10 @@ Additional documentation
 
 .. seealso::
 
-   * https://wiki.cacert.org/Exim4Configuration
+   * :wiki:`Exim4Configuration`
 
 References
 ----------
 
-Arbitration nginx welcome page
-   http://arbitration.cacert.org/
+Wiki page for this system
+   :wiki:`SystemAdministration/Systems/Arbitration`
index 890fdd0..38bb50d 100644 (file)
@@ -11,6 +11,15 @@ Purpose
 This system hosts the blog, blog.cacert.org. The blog meets the needs of public
 relations and the CAcert community to publish CAcert's activities.
 
+Application Links
+-----------------
+
+Blog URL
+   https://blog.cacert.org/
+
+Adding a category
+   https://blog.cacert.org/wp-admin/categories.php
+
 Administration
 ==============
 
@@ -95,7 +104,7 @@ blog.intra.cacert.org. IN A     172.16.2.13
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/Procedures/DNSChanges
+   See :wiki:`SystemAdministration/Procedures/DNSChanges`
 
 Operating System
 ----------------
@@ -109,8 +118,7 @@ Operating System
 Applicable Documentation
 ------------------------
 
-A small (work in progress) guide can be found in the `Wiki
-<https://wiki.cacert.org/BlogDoc>`_.
+A small (work in progress) guide can be found in the :wiki:`BlogDoc`.
 
 Services
 ========
@@ -140,13 +148,13 @@ Running services
 ----------------
 
 .. index::
-   single: openssh
    single: Apache
-   single: cron
    single: MySQL
    single: PHP FPM
    single: Postfix
+   single: cron
    single: nrpe
+   single: openssh
 
 +--------------------+--------------------+----------------------------------------+
 | Service            | Usage              | Start mechanism                        |
@@ -286,10 +294,10 @@ Keys and X.509 certificates
 .. seealso::
 
    * :ref:`cert_blog_cacert_org` in :doc:`../certlist`
-   * https://wiki.cacert.org/SystemAdministration/CertificateList
+   * :wiki:`SystemAdministration/CertificateList`
 
-Apache configuration files
---------------------------
+Apache configuration
+--------------------
 
 * :file:`/etc/apache2/cacert/blog.inc.conf`
 
@@ -347,15 +355,10 @@ Additional documentation
 
 .. seealso::
 
-   * https://wiki.cacert.org/PostfixConfiguration
-
-Adding a category
------------------
-
-* https://blog.cacert.org/wp-admin/categories.php
+   * :wiki:`PostfixConfiguration`
 
 References
 ----------
 
-Blog URL
-   https::/blog.cacert.org/
+Wiki page for this system
+   :wiki:`SystemAdministration/Systems/Blog`
index fd4b032..c400935 100644 (file)
@@ -8,7 +8,13 @@ Board
 Purpose
 =======
 
-This systems hosts an OpenERP instance available at board.cacert.org.
+This system hosts an OpenERP instance available at board.cacert.org.
+
+Application Links
+-----------------
+
+OpenERP URL
+   https://board.cacert.org/
 
 Administration
 ==============
@@ -24,7 +30,11 @@ System Administration
 Application Administration
 --------------------------
 
-* OpenERP: :ref:`people_gero`, :ref:`people_neo`, Treasurer
++-------------+--------------------------------------------------+
+| Application | Administrator(s)                                 |
++=============+==================================================+
+| OpenERP     | :ref:`people_gero`, :ref:`people_neo`, Treasurer |
++-------------+--------------------------------------------------+
 
 .. note:: use personalized accounts only
 
@@ -77,7 +87,7 @@ board.intra.cacert.org IN A     172.16.2.34
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/Procedures/DNSChanges
+   See :wiki:`SystemAdministration/Procedures/DNSChanges`
 
 Operating System
 ----------------
@@ -294,7 +304,7 @@ Keys and X.509 certificates
 .. seealso::
 
    * :ref:`cert_board_cacert_org` in :doc:`../certlist`
-   * https://wiki.cacert.org/SystemAdministration/CertificateList
+   * :wiki:`SystemAdministration/CertificateList`
 
 Apache configuration files
 --------------------------
@@ -353,10 +363,10 @@ Additional documentation
 
 .. seealso::
 
-   * https://wiki.cacert.org/PostfixConfiguration
+   * :wiki:`PostfixConfiguration`
 
 References
 ----------
 
-OpenERP URL
-   https://board.cacert.org/
+Wiki page for this system
+   :wiki:`SystemAdministration/Systems/Board`
index 6e3fd81..76cc3b9 100644 (file)
@@ -68,7 +68,7 @@ There is a 2 TB USB backup disk attached to the system.
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/EquipmentList
+   See :wiki:`SystemAdministration/EquipmentList`
 
 .. _Thomas Krenn: https://www.thomas-krenn.com/
 
@@ -110,7 +110,7 @@ infra02.intra.cacert.org.  IN A     172.16.2.10
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/Procedures/DNSChanges
+   See :wiki:`SystemAdministration/Procedures/DNSChanges`
 
 Operating System
 ----------------
@@ -290,4 +290,10 @@ Additional documentation
 
 .. seealso::
 
-   * https://wiki.cacert.org/PostfixConfiguration
+   * :wiki:`PostfixConfiguration`
+
+References
+----------
+
+Wiki page for this system
+   :wiki:`SystemAdministration/Systems/Infra02`
index bd0ebb3..c206e43 100644 (file)
@@ -26,6 +26,12 @@ expiry).
 
 .. _Icinga: https://www.icinga.org/
 
+Application Links
+-----------------
+
+The Icinga classic frontend
+   https://monitor.cacert.org/
+
 Administration
 ==============
 
@@ -92,7 +98,7 @@ monitor.cacert.org. IN CNAME infrastructure.cacert.org
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/Procedures/DNSChanges
+   See :wiki:`SystemAdministration/Procedures/DNSChanges`
 
 Operating System
 ----------------
@@ -268,7 +274,7 @@ Keys and X.509 certificates
 .. seealso::
 
    * :doc:`../certlist`
-   * https://wiki.cacert.org/SystemAdministration/CertificateList
+   * :wiki:`SystemAdministration/CertificateList`
 
 CRL fetch job
 -------------
@@ -314,10 +320,10 @@ Additional documentation
 
 .. seealso::
 
-   * https://wiki.cacert.org/PostfixConfiguration
+   * :wiki:`PostfixConfiguration`
 
 References
 ----------
 
-The Icinga classic frontend
-   https://monitor.cacert.org/
+Wiki page for this system
+   :wiki:`SystemAdministration/Systems/Monitor`
index 7ab0e91..006f7ed 100644 (file)
@@ -68,7 +68,7 @@ Physical Configuration
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/EquipmentList
+   See :wiki:`SystemAdministration/EquipmentList`
 
 Logical Location
 ----------------
@@ -97,7 +97,7 @@ Name                       Type     Content
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/Procedures/DNSChanges
+   See :wiki:`SystemAdministration/Procedures/DNSChanges`
 
 Operating System
 ----------------
@@ -289,7 +289,7 @@ Keys and X.509 certificates
 .. seealso::
 
    * :doc:`../certlist`
-   * https://wiki.cacert.org/SystemAdministration/CertificateList
+   * :wiki:`SystemAdministration/CertificateList`
 
 <service_x> configuration
 -------------------------
@@ -327,11 +327,11 @@ Additional documentation
 
 .. seealso::
 
-   * https://wiki.cacert.org/Exim4Configuration
-   * https://wiki.cacert.org/PostfixConfiguration
-   * https://wiki.cacert.org/QmailConfiguration
-   * https://wiki.cacert.org/SendmailConfiguration
-   * https://wiki.cacert.org/StunnelConfiguration
+   * :wiki:`Exim4Configuration`
+   * :wiki:`PostfixConfiguration`
+   * :wiki:`QmailConfiguration`
+   * :wiki:`SendmailConfiguration`
+   * :wiki:`StunnelConfiguration`
 
 References
 ----------
index 1b5afce..a35ce51 100644 (file)
@@ -25,6 +25,23 @@ password reset`_.
 .. _staff list: https://community.cacert.org/staff.php
 .. _email password reset: https://community.cacert.org/password.php
 
+Application Links
+-----------------
+
+Webmail URL
+   https://community.cacert.org/ (redirects to
+   https://community.cacert.org/roundcubemail/)
+
+Board Voting System URL
+   https://community.cacert.org/board/
+
+Password reset
+   https://community.cacert.org/password.php
+
+Staff list
+   https://community.cacert.org/staff.php
+
+
 Administration
 ==============
 
@@ -99,7 +116,7 @@ community.cacert.org. IN CNAME email.cacert.org
 
 .. seealso::
 
-   See https://wiki.cacert.org/SystemAdministration/Procedures/DNSChanges
+   See :wiki:`SystemAdministration/Procedures/DNSChanges`
 
 Operating System
 ----------------
@@ -117,8 +134,8 @@ This is it :-)
 
 .. seealso::
 
-   * `Community Email Wiki Page <https://wiki.cacert.org/CommunityEmail>`_
-   * `Email Account Policy <https://wiki.cacert.org/EmailAccountPolicy>`_
+   * :wiki:`CommunityEmail`
+   * :wiki:`EmailAccountPolicy`
 
 Services
 ========
@@ -256,7 +273,7 @@ Keys and X.509 certificates
 .. seealso::
 
    * :doc:`../certlist`
-   * https://wiki.cacert.org/SystemAdministration/CertificateList
+   * :wiki:`SystemAdministration/CertificateList`
 
 Apache configuration
 --------------------
@@ -335,23 +352,10 @@ Additional documentation
 
 .. seealso::
 
-   * https://wiki.cacert.org/PostfixConfiguration
+   * :wiki:`PostfixConfiguration`
 
 References
 ----------
 
-Webmail URL
-   https://community.cacert.org/ (redirects to
-   https://community.cacert.org/roundcubemail/)
-
-Board Voting System URL
-   https://community.cacert.org/board/
-
-Password reset
-   https://community.cacert.org/password.php
-
-Staff list
-   https://community.cacert.org/staff.php
-
 Wiki page for this system
-   https://wiki.cacert.org/SystemAdministration/Systems/Community
+   :wiki:`SystemAdministration/Systems/Community`