florianfederspiel
4882da0d35
Some checks failed
Build and Push Docker Images / verify-docs-sync (push) Successful in 7s
Build and Push Docker Images / build-backend (push) Successful in 15s
Build and Push Docker Images / build-docs (push) Failing after 41s
Build and Push Docker Images / build-frontend (push) Successful in 14s
FEDEO Docs Site (Docusaurus)
Diese Docusaurus-App rendert die versionierte FEDEO-Dokumentation aus dem Ordner ../docs.
Zielpfad in Produktion
Die Seite ist für den Betrieb hinter Traefik unter folgendem Pfad konfiguriert:
https://app.fedeo.de/docs
Lokale Entwicklung
Im Ordner docs-site ausführen:
npm install
npm run start
Danach ist die Seite unter http://localhost:3005 erreichbar.
Statischer Build
npm run build
npm run serve
Deploy über Haupt-Compose
Die Docs sind in der zentralen docker-compose.yml als eigener Service docs eingebunden.
Deploy aus dem Projekt-Root:
docker compose pull docs
docker compose up -d docs
Für ein komplettes Update des gesamten Stacks:
docker compose pull
docker compose up -d
Workflow bei Funktionsänderungen
Vor jedem Docs-Deploy:
- Technische Kataloge aktualisieren
node docs/scripts/sync-funktionsdoku.mjs
- Änderungen committen
- CI baut und pusht das
docs-Image - Server zieht neues Image und startet den Service neu