Micha
a4f4696b0d
- REPO_MAP.md: replace Arbeitsregel with 8 binding documentation rules (one fact one home, done leaves the working copy, file types, header convention, quarterly gardening) - WORKFLOW.md Dokumentationspflicht and CLAUDE.md aligned to the rules - docs/README.md index rebuilt for the consolidated state - H drive docs merged into ops/h-drive-nearline/README.md (scheduled task + no-MIR rule added); docs/H_DRIVE_NEARLINE_PULL.md removed - implemented proposal archived to docs/archive/2026/ Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
73 lines
3.2 KiB
Markdown
73 lines
3.2 KiB
Markdown
# Documentation Index
|
|
|
|
Typ: Einstieg/Index · Stand: 2026-06-11 · Status: aktiv
|
|
|
|
Diese Datei trennt aktive Betriebsdokumentation von historischer Arbeitsdoku.
|
|
Neue operative Dokumente duerfen nur in `docs/` liegen, wenn sie heute als
|
|
Einstieg, Runbook, Inventar, Entscheidung oder Statusliste gebraucht werden.
|
|
Abgeschlossene Audits, Drills und Plaene wandern nach `archive/` oder werden
|
|
geloescht (Git-Historie ist das Archiv). Verbindliche Doku-Regeln:
|
|
`REPO_MAP.md` Abschnitt "Doku-Regeln".
|
|
|
|
## Pflicht-Einstieg
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `../README.md` | kurzer Repo-Einstieg |
|
|
| `../HOMELAB_ARCHITECTURE_MASTER_V2.md` | Architektur-Quelle fuer Netz, Zugriff und Ausnahmen |
|
|
| `WORKFLOW.md` | verbindlicher GitOps-/No-Drift-Ablauf |
|
|
| `REPO_MAP.md` | technische Landkarte des Repositories + Doku-Regeln |
|
|
| `SERVICE_CATALOG.md` | produktiver Service-Katalog |
|
|
| `DECISIONS.md` | Entscheidungs-Register (ADR-light) |
|
|
| `MASTER_TODO.md` | einzige operative Statusliste |
|
|
|
|
## Betrieb und Recovery
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `DISASTER_RECOVERY.md` | Wiederanlauf nach Host-/Systemausfall |
|
|
| `RESTORE_MATRIX.md` | Restore-Quellen, Dumps, Secrets, Smoke-Tests und Test-Reifegrad je Dienst |
|
|
| `SERVICES_RECOVERY.md` | Gitea-/Komodo-/Services-Bootstrap |
|
|
| `ROLLBACK.md` | Rueckweg bei GitOps-/Deploy-Fehlern |
|
|
| `GITOPS_DRIFT_RUNBOOK.md` | Pflichtmatrix bei Drift zwischen Git, Komodo, Docker und Host |
|
|
| `DR_WORKSTATION_SETUP.md` | DR-Gaming-PC einrichten (WSL2 + Borg-Client + SSH-Keys) |
|
|
| `../ops/restore-tests/README.md` | Restore-Test-Betrieb, Skripte und Kadenz |
|
|
|
|
## Inventare und Policies
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `STORAGE_LAYOUT.md` | verbindliche Storage-/Share-/Pfad-Regeln |
|
|
| `SECRETS_MAP.md` | Secret-Namen, Speicherorte und Einbindungsarten ohne Werte |
|
|
| `AUTHELIA_OIDC_PLAN.md` | Plan & Runbook fuer app-uebergreifendes SSO via Authelia OIDC |
|
|
| `HARDWARE_INVENTORY.md` | Host-, Disk-, SMART- und Power-Baseline |
|
|
| `NETWORK_INVENTORY.md` | Router, DNS, Tailscale, Portfreigaben und Netzthemen |
|
|
| `GUEST_IOT_NETWORK.md` | Sicherer Ablauf fuer FRITZ!Box-Gastnetz / IoT-Isolation |
|
|
| `EXTERNAL_DEPENDENCIES.md` | Provider, Konten, DR-Workstation-Kit und externe Abhaengigkeiten |
|
|
| `EXTERNAL_OPERATOR_RUNBOOK.md` | Hetzner-/Borg-/FRITZ!Box-Betreibercheck |
|
|
| `CAPACITY_AND_LIFECYCLE.md` | Kapazitaet, Wachstum, Upgrade-Trigger, H:/-Nearline-Einordnung |
|
|
|
|
## Monitoring und Automatisierung
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `ALERT_RULES.md` | Prometheus-/ntfy-Regeln und Handlungslogik |
|
|
| `RENOVATE.md` | Self-hosted Renovate gegen Gitea |
|
|
| `runbooks/komodo-bulk-deploy-dns.md` | Bulk-Deploy-Pulls scheitern an DNS bei AdGuard-Recreate |
|
|
| `../ops/h-drive-nearline/README.md` | Windows-H:/ Nearline-Pull fuer kritische Restore-Artefakte |
|
|
|
|
## Nutzer- und Statusdoku
|
|
|
|
| Datei | Zweck |
|
|
|---|---|
|
|
| `FAMILY_ONBOARDING.md` | familienverstaendliche Nutzungsdoku |
|
|
| `AI_CONTEXT.md` | kompakter Kontext fuer KI-Agenten (Regeln + Pointer, kein Status) |
|
|
| `homelab-optimierung.md` | technisches Optimierungs-Assessment 2026-06-10 (offene Empfehlungen) |
|
|
|
|
## Archiv
|
|
|
|
Abgeschlossene Snapshots, Drills und Audits: `archive/README.md`.
|
|
Windows-Neuaufsetzen-Doku (Projekt abgeschlossen) liegt ebenfalls dort;
|
|
aktiv geblieben sind nur Veeam-Baseline und Laufwerksstruktur unter
|
|
`../ops/windows-reinstall/`.
|