diff options
author | 2024-07-24 20:09:42 +0200 | |
---|---|---|
committer | 2024-07-25 20:06:54 +0200 | |
commit | a4d7e92d544aeb43dbe1fcd8648d97e0dbf7b9d3 (patch) | |
tree | 183318852234388654c99514e45f095af8c21676 /docs/runbooks/index.rst | |
parent | Add 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/runbooks/index.rst')
-rw-r--r-- | docs/runbooks/index.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/runbooks/index.rst b/docs/runbooks/index.rst new file mode 100644 index 0000000..18690c7 --- /dev/null +++ b/docs/runbooks/index.rst @@ -0,0 +1,17 @@ +Runbooks +======== + +Learn how to do anything in our infrastructure with these guidelines. + +.. note:: + + In general, we try to codify manual processes as much as possible. Still, + this section is important for tasks that are either hard to automate or are + run so infrequently that it does not make sense to regularly run them. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + postgresql-upgrade |