diff options
author | 2024-07-24 20:09:42 +0200 | |
---|---|---|
committer | 2024-07-25 20:06:54 +0200 | |
commit | a4d7e92d544aeb43dbe1fcd8648d97e0dbf7b9d3 (patch) | |
tree | 183318852234388654c99514e45f095af8c21676 /docs/onboarding/resources.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/onboarding/resources.rst')
-rw-r--r-- | docs/onboarding/resources.rst | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/onboarding/resources.rst b/docs/onboarding/resources.rst new file mode 100644 index 0000000..0ec846b --- /dev/null +++ b/docs/onboarding/resources.rst @@ -0,0 +1,28 @@ +Resources +========= + +The following is a collection of important reference documents for the +DevOps team. + +`Infra Repo <https://github.com/python-discord/infra>`__ +-------------------------------------------------------- + +This GitHub repo contains most of the manifests and configuration +applies to our cluster. It’s kept up to date manually and is considered +a source of truth for what we should have in the cluster. + +It is mostly documented, but improvements for unclear or outdated +aspects is always welcome. + +`Knowledge base <https://python-discord.github.io/infra/>`__ +------------------------------------------------------------ + +Deployed using GH pages, source can be found in the docs directory of +the k8s repo. + +This includes: + +- Changelogs +- Post-mortems +- Common queries +- Runbooks |