Runbook: GitHub Pages lokal previewen
Zweck
Die GitHub-Pages-Seite lokal als Jekyll-Server starten, um Inhalte/Links zu prüfen, ohne GitHub Pages abzuwarten.
Diese Seite ist für J01-98 der kanonische Zielort für den
preview-relevanten Branch- und Promotionspfad aus docs/agile.
Voraussetzungen
- Docker (inkl.
docker compose) compose.yamlist vorhanden
Schritte
Preview-Server starten (Port 4000):
docker compose up --build ghpages-preview
Shell im Container (Debugging):
docker compose run --rm ghpages-shell
Repo-Ablauf heute
- Für das aktuelle Doku-Repo gilt kein generischer
feature/*-/dev-/preview-Pfad. - Änderungen werden nach lokaler Vorschau und Pflichtchecks direkt in
mainintegriert. - Der frühere Promotionspfad aus
J01-98ist historischer Kontext, aber kein aktiver Repo-Standard mehr.
Pflichtchecks vor Integration
- Sprachbäume in
de/unden/gemeinsam pflegen. - Interne Links mit
relative_urlprüfen. - Lokale Pages-Vorschau starten und die betroffenen Zielseiten direkt anklicken.
- Sicherstellen, dass neue oder geänderte Jira-Arbeitsdoku in die passende öffentliche Seite verlinkt.
- Erst danach den Stand in
mainintegrieren.
Hinweise
- Der Preview-Server läuft auf
http://localhost:4000/. - Vor dem Start werden die abgeleiteten EN-Seiten aus der DE-Basis synchronisiert.
- Interne Links sollen mit
relative_urlgebaut werden, damitbaseurlkorrekt greift (bei dieser Site leer). - Die lokale Vorschau prüft Inhalt, Navigation und Linkpfade. Sie ersetzt nicht die fachlichen Nachweise in der Testmatrix.
- Sprintrelevante Preview-Arbeit aus
J01-98bleibt an diese Seite, die Testmatrix und die betroffenen Bereichsseiten gekoppelt.
Troubleshooting
- Port belegt: in
compose.yamlein anderes Port-Mapping setzen (z. B.4001:4000). - Wenn Links lokal stimmen, aber der EN-Spiegel fehlt: zuerst die abgeleiteten EN-Seiten im Repo nachziehen und dann den Preview-Server neu starten.