From a7809f545ff176035367b1022d5807a4150ea4e1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Michal=20Kone=C4=8Dn=C3=BD?= <mkonecny@redhat.com>
Date: Fri, 10 Sep 2021 16:48:00 +0200
Subject: [PATCH] Review zodbot SOP
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Michal Konečný <mkonecny@redhat.com>
---
 modules/sysadmin_guide/nav.adoc          |  2 +-
 modules/sysadmin_guide/pages/zodbot.adoc | 40 +++++++++++++-----------
 2 files changed, 22 insertions(+), 20 deletions(-)

diff --git a/modules/sysadmin_guide/nav.adoc b/modules/sysadmin_guide/nav.adoc
index ec499a3..2cbc637 100644
--- a/modules/sysadmin_guide/nav.adoc
+++ b/modules/sysadmin_guide/nav.adoc
@@ -115,4 +115,4 @@
 ** xref:waiverdb.adoc[WaiverDB - SOP]
 ** xref:wcidff.adoc[What Can I Do For Fedora - SOP]
 ** xref:wiki.adoc[Wiki Infrastructure - SOP]
-** xref:zodbot.adoc[zodbot - SOP in review ]
+** xref:zodbot.adoc[Zodbot Infrastructure - SOP]
diff --git a/modules/sysadmin_guide/pages/zodbot.adoc b/modules/sysadmin_guide/pages/zodbot.adoc
index 899d635..517f5d1 100644
--- a/modules/sysadmin_guide/pages/zodbot.adoc
+++ b/modules/sysadmin_guide/pages/zodbot.adoc
@@ -1,16 +1,15 @@
 = Zodbot Infrastructure SOP
 
-zodbot is a supybot based irc bot that we use in our #fedora channels.
+Zodbot is a supybot based irc bot that we use in our #fedora channels.
 
 == Contents
 
 [arabic]
-. Contact Information
-. Description
-. shutdown
-. startup
-. Processing interrupted meeting logs
-. Becoming an admin
+* <<_contact_information>>
+* <<_description>>
+* <<_startup_issues>>
+* <<_processing_interrupted_meeting_logs>>
+* <<_becoming_an_admin>>
 
 == Contact Information
 
@@ -18,8 +17,6 @@ Owner::
   Fedora Infrastructure Team
 Contact::
   #fedora-admin
-Location::
-  Phoenix
 Servers::
   value01
 Purpose::
@@ -27,17 +24,22 @@ Purpose::
 
 == Description
 
-zodbot is a supybot based irc bot that we use in our #fedora channels.
-It runs on value01 as the daemon user. We do not config manage the
-zodbot.conf because supybot makes changes to it on its own. Therefore it
+Zodbot is a supybot based irc bot that we use in our #fedora channels.
+It runs on _value01_ as the daemon user. We do not manage the
+`zodbot.conf` because supybot makes changes to it on its own. Therefore it
 gets backed up and is treated as data.
 
 shutdown::
   `killall supybot`
 startup::
-  `cd /srv/web/meetbot` # zodbot current needs to be started in the
-  meetbot directory. # This requirement will go away in a later meetbot
-  release. `sudo -u daemon supybot -d /var/lib/zodbot/conf/zodbot.conf`
++
+....
+cd /srv/web/meetbot
+# zodbot current needs to be started in the meetbot directory.
+# This requirement will go away in a later meetbot
+release
+sudo -u daemon supybot -d /var/lib/zodbot/conf/zodbot.conf
+....
 
 == Startup issues
 
@@ -47,7 +49,7 @@ If the bot won't connect, with an error like:
 "Nick/channel is temporarily unavailable"
 ....
 
-found in `/var/lib/zodbot/logs/messages.log`, hop on Freenode (with your
+found in `/var/lib/zodbot/logs/messages.log`, hop on libera.chat (with your
 own IRC client) and do the following:
 
 ....
@@ -63,13 +65,13 @@ This should allow the bot to connect again.
 
 zodbot forgets about meetings if they are in progress when the bot goes
 down; therefore, the meetings never get processed. Users may request a
-ticket in [52]our Trac instance to have meeting logs processed.
+ticket in our Trac instance to have meeting logs processed.
 
 Trac tickets for meeting log processing should consist of a URL where
 zodbot had saved the log so far and an uploaded file containing the rest
-of the log. The logs are stored in /srv/web/meetbot. Append the
+of the log. The logs are stored in `/srv/web/meetbot`. Append the
 remainder of the log uploaded to Trac (don't worry too much about
-formatting; meeting.py works well with irssi- and XChat-like logs), then
+formatting; `meeting.py` works well with irssi- and XChat-like logs), then
 run:
 
 ....