Ankh-Morpork¶
Documentation for the thaum.xyz home Kubernetes cluster — a k3s cluster in a cupboard, managed entirely through Flux.
-
Tutorial
Learning-oriented. Start here if you have never deployed anything to this cluster. One guided path, guaranteed to work, no decisions to make.
-
How-to
Task-oriented. You know what you want and need the steps for this cluster. Runbooks live here too.
-
Reference
Information-oriented. Storage classes, admission policies, ingress classes, the app inventory. Look things up, don't read it through.
-
Explanation
Understanding-oriented. Why the cluster is built the way it is, and what was measured or learned to justify it.
How this documentation is organised¶
This site follows Diátaxis. The four sections above are document types, not subjects — the same component can appear in all four. A page belongs in a section based on what the reader is doing when they open it:
| Practical | Theoretical | |
|---|---|---|
| Studying | Tutorial | Explanation |
| Working | How-to | Reference |
Each section states its own admission test. Read it before adding a page there — the framework only pays for itself if the boxes stay honest.
Where documentation lives¶
Two prior doc sets for this cluster died after being moved away from the code
they described: docs/ went to a private Logseq, and the runbooks went to
thaum-xyz/runbooks, which last received a commit in November 2021. What
survived instead was everything that stayed inside the repository — the per-app
READMEs, AGENTS.md, the deployment skill.
So the rule here is proximity:
- This site is built from
docs/in theankhmorporkrepository. The source is plain Markdown with no front matter, so every page stays readable on github.com and shows up in the diff that invalidates it. Only the rendering leaves the repo. - Per-app documentation stays next to its manifests, at
k8s/apps/<app>/README.md, for the same reason. - Nothing here contains secrets, credentials, or break-glass paths. The repository is public on purpose. Anything failing that test does not belong on this site — see what stays private.
Found something wrong?
Every page has an edit link in the top right that opens it directly in the GitHub editor. Fixing a stale sentence should cost less than tolerating it.