# Contributing to the Homelab Wiki ## Voice Concise, technical, sysadmin-to-sysadmin. No marketing prose, no exclamation marks. ## Page templates ### Container page (`containers/-.md`) ```markdown # — `` One-sentence purpose. ## At a glance - **Hostname:** `` - **IP:** `192.168.8.x` - **Privilege:** privileged | unprivileged - **Resources:** N cores / M GiB RAM / D GiB rootfs - **Mounts:** `/mnt/library` ↔ `/mnt/library` (if any) - **Public hostname:** `.hubris.network` (if proxied) ## Role What it does, what it talks to. ## Service / port map | Service | Listen | Notes | ## Storage / config paths ## Auto-deploy (if any) — link to [auto-deploy](../infrastructure/auto-deploy.md) ## Related - [Caddy](121-caddy.md) (if proxied) - [DNS](../infrastructure/dns.md) (if has subdomain) - [Authentik](124-authentik.md) (if SSO) - ... ## Changelog ### YYYY-MM-DD — short title What changed, why, link to investigation if any. ``` ### Cross-cutting page (`infrastructure/.md`) ```markdown # One-sentence summary. ## Why Design rationale — what it replaces, what it solves. ## Components Where it runs, what files matter. ## How to apply / use Recipes. ## Gotchas ## Related Links to nodes that host or depend on this. ## Changelog ``` ### Investigation (`investigations/YYYY-MM-DD-slug.md`) ```markdown # YYYY-MM-DD — ## Summary 1-3 sentences. ## Timeline ## Root cause ## Mitigations applied ## Open questions ``` ## Linking discipline - Every container page links to every cross-cutting page it participates in. - Every cross-cutting page lists the nodes that participate. - Every investigation links to the nodes it implicates *and* gets back-linked from each node's changelog. ## Changelog hygiene - Reverse-chronological (newest first). - One entry per discrete change, even if you make several in one day. - If a change spans nodes, repeat the entry on each affected page (different perspective is fine). - Don't rewrite history — entries are append-only. Mistakes get a follow-up entry that supersedes them.