pkr-lab-docs
Quelle: pkr-lab/pkr-lab-docs/README.md
pkr-lab-docs
Zentrale Dokumentation aller Projekte von pkr-lab. Jedes Projekt hat einen eigenen Ordner, dessen Name dem Repo entspricht. Die Code-Repos selbst enthalten nur eine kurze README mit Zweck, Quickstart und einem Link hierher.
Projekte
| Projekt | Zweck | Repo | Doku |
|---|---|---|---|
| capulus-core | GitOps-Homelab: ArgoCD-Apps, Promotion ENTW → TECH → PROD, Token-Register | GitHub | capulus-core/ |
| capulus-ansible | Ansible-Playbooks und Rollen für Hosts, k3s-Cluster und Kiosks | GitHub | capulus-ansible/ |
| capulus-ios | SwiftUI-App „Homeserver Dashboard“ | GitHub | capulus-ios/ |
| capulus-operator | Kubernetes-Operator: Backups, Datenbanken, Zertifikate, Secret-Rotation | GitHub | capulus-operator/ |
| cubi | Terminal-Werkzeug für den Kubernetes-Alltag | GitHub | cubi/ |
| ui-terminal-config | Starship, Nerd Font und KI-CLIs für Ubuntu Desktop | GitHub | ui-terminal-config/ |
| DocFlowEngine | PowerShell-Modul: Dokumente erkennen, umbenennen, sortieren | GitHub | DocFlowEngine/ |
| PowerShell | Skriptsammlung für Windows-Administration | GitHub | PowerShell/ |
| ps-data-fixtures | Testdaten für PowerShell-Skripte | GitHub | ps-data-fixtures/ |
| EDV-Kretzer | Statische Website von EDV-Kretzer | GitHub | EDV-Kretzer/ |
| .github | wiederverwendbare Workflows für Releases und Commitlint | GitHub | github-workflows/ |
| pkr-lab | GitHub-Profilseite | GitHub | pkr-lab/ |
Fehlersuche
Einstieg bei Störungen: Zentrale Fehlersuche (Symptom → richtige Anleitung). Jedes Projekt hat eine eigene Seite „Debugging und Fehlersuche“ oder einen Abschnitt „Fehlersuche“:
| Projekt | Fehlersuche |
|---|---|
| capulus-core | Zentrale Fehlersuche, Skripte und Workflows |
| capulus-ansible | Rollen: Fehlersuche je Rolle, Troubleshooting |
| capulus-ios | Debugging |
| cubi | Debugging |
| ui-terminal-config | Debugging |
| DocFlowEngine | Debugging |
| PowerShell | Debugging, git-pull-push |
| EDV-Kretzer | Debugging |
Aufbau
pkr-lab-docs/
├── README.md
├── capulus-core/ Doku in Kategorien (a-… bis f-…, 1-… bis 7-…), Komponenten, Archiv
├── capulus-ansible/ index, installation, konfiguration, nutzung, releases, rollen/ plus Fachdocs
├── capulus-ios/
├── cubi/
├── ui-terminal-config/
├── DocFlowEngine/
├── PowerShell/
├── ps-data-fixtures/
├── EDV-Kretzer/
├── github-workflows/
├── pkr-lab/
└── scripts/check-doc-links.py
Jedes Projekt hat mindestens index.md (Zweck, Überblick, Architektur), installation.md, konfiguration.md, nutzung.md und releases.md.
Mitarbeit
- Commits folgen Conventional Commits, z. B.
docs(capulus-ansible): Rolle k3s ergänzen. - Links zwischen Seiten sind relativ, Links in Code-Repos sind absolute GitHub-URLs.
- Vor dem PR:
python3 scripts/check-doc-links.py. - Konventionen für Dateinamen und Aufbau der capulus-core-Docs: TEMPLATE.md.
Wiki
Die Seiten werden automatisch in Wiki.js im PROD-Cluster gespiegelt, die Ordnerstruktur bleibt als Seitenbaum erhalten. Änderungen macht man hier, nicht im Wiki. Aufbau und Betrieb: wiki-sync.