Integriere Docusaurus in Haupt-Compose mit TLS unter /docs
This commit is contained in:
@@ -2,6 +2,12 @@
|
||||
|
||||
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:
|
||||
@@ -20,15 +26,23 @@ npm run build
|
||||
npm run serve
|
||||
```
|
||||
|
||||
## Deploy mit Docker Compose
|
||||
## Deploy über Haupt-Compose
|
||||
|
||||
Aus dem Projekt-Root:
|
||||
Die Docs sind in der zentralen `docker-compose.yml` als eigener Service `docs` eingebunden.
|
||||
|
||||
Deploy aus dem Projekt-Root:
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose.docs.yml up -d --build
|
||||
docker compose pull docs
|
||||
docker compose up -d docs
|
||||
```
|
||||
|
||||
Standard-Port ist `3205`.
|
||||
Für ein komplettes Update des gesamten Stacks:
|
||||
|
||||
```bash
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Workflow bei Funktionsänderungen
|
||||
|
||||
@@ -41,11 +55,5 @@ node docs/scripts/sync-funktionsdoku.mjs
|
||||
```
|
||||
|
||||
2. Änderungen committen
|
||||
3. Docs-Container neu bauen und starten
|
||||
|
||||
## Wichtige Platzhalter
|
||||
|
||||
Bitte in `docs-site/docusaurus.config.ts` anpassen:
|
||||
|
||||
- `url` auf die echte Docs-Domain
|
||||
- GitHub-Links (`editUrl`, `Repository`)
|
||||
3. CI baut und pusht das `docs`-Image
|
||||
4. Server zieht neues Image und startet den Service neu
|
||||
|
||||
Reference in New Issue
Block a user