aboutsummaryrefslogtreecommitdiffstats
path: root/docs/tooling
diff options
context:
space:
mode:
authorGravatar Johannes Christ <[email protected]>2024-07-24 20:09:42 +0200
committerGravatar Johannes Christ <[email protected]>2024-07-25 20:06:54 +0200
commita4d7e92d544aeb43dbe1fcd8648d97e0dbf7b9d3 (patch)
tree183318852234388654c99514e45f095af8c21676 /docs/tooling
parentAdd link to DevOps Kanban board in meeting template (#420) (diff)
Improve documentation
This commit ports our documentation to Sphinx. The reason for this is straightforward. We need to improve both the quality and the accessibility of our documentation. Hugo is not capable of doing this, as its primary output format is HTML. Sphinx builds plenty of high-quality output formats out of the box, and incentivizes writing good documentation.
Diffstat (limited to 'docs/tooling')
-rw-r--r--docs/tooling/bots.rst52
-rw-r--r--docs/tooling/index.rst12
2 files changed, 64 insertions, 0 deletions
diff --git a/docs/tooling/bots.rst b/docs/tooling/bots.rst
new file mode 100644
index 0000000..e38f83c
--- /dev/null
+++ b/docs/tooling/bots.rst
@@ -0,0 +1,52 @@
+Our GitHub repositories are supported by two custom bots:
+
+- Our **Fast Forward Bot**, which ensures that commits merged into main
+ are either merged manually on the command line or via a fast-forward,
+ ensuring that cryptographic signatures of commits remain intact.
+ Information on the bot can be found `in the ``ff-bot.yml``
+ configuration <https://github.com/python-discord/infra/blob/main/.github/ff-bot.yml>`__.
+ Merges over the GitHub UI are discouraged for this reason. You can
+ use it by running ``/merge`` on a pull request. Note that attempting
+ to use it without permission to will be reported.
+
+- Our **Craig Dazey Emulator Bot**, which ensures team morale stays
+ high at all times by thanking team members for submitted pull
+ requests. [1]_
+
+Furthermore, our repositories all have dependabot configured on them.
+
+Dealing with notifications
+--------------------------
+
+This section collects some of our team members’ ways of dealing with the
+notifications that originate from our bots.
+
+Sieve (RFC 5228) script
+~~~~~~~~~~~~~~~~~~~~~~~
+
+If your mail server supports the `Sieve mail filtering
+language <https://datatracker.ietf.org/doc/html/rfc5228.html>`__, which
+it should, you can adapt the following script to customize the amount of
+notifications you receive:
+
+.. code:: sieve
+
+ require ["envelope", "fileinto", "imap4flags"];
+
+ if allof (header :is "X-GitHub-Sender" ["coveralls", "github-actions[bot]", "netlify[bot]"],
+ address :is "from" "[email protected]") {
+ setflag "\\seen";
+ fileinto "Trash";
+ stop;
+ }
+
+If you also want to filter out notifications from renovate, which we use
+for dependency updates, you can add ``renovate[bot]`` to the
+``X-GitHub-Sender`` list above.
+
+.. [1]
+ Craig Dazey Emulator Bot stands in no affiliation, direct or
+ indirect, with Craig Dazey. Craig Dazey Emulator Bot. Craig Dazey
+ Emulator Bot is not endorsed by Craig Dazey. Craig Dazey Emulator Bot
+ is an independent project of Craig Dazey. No association is made
+ between Craig Dazey Emulator Bot and Craig Dazey.
diff --git a/docs/tooling/index.rst b/docs/tooling/index.rst
new file mode 100644
index 0000000..2381849
--- /dev/null
+++ b/docs/tooling/index.rst
@@ -0,0 +1,12 @@
+Tooling
+=======
+
+Learn about the helperlings that keep Python Discord DevOps running like a
+well-oiled machine.
+
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+ bots