60 lines
1.1 KiB
Markdown
60 lines
1.1 KiB
Markdown
# 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:
|
|
|
|
```bash
|
|
npm install
|
|
npm run start
|
|
```
|
|
|
|
Danach ist die Seite unter `http://localhost:3005` erreichbar.
|
|
|
|
## Statischer Build
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
docker compose pull docs
|
|
docker compose up -d docs
|
|
```
|
|
|
|
Für ein komplettes Update des gesamten Stacks:
|
|
|
|
```bash
|
|
docker compose pull
|
|
docker compose up -d
|
|
```
|
|
|
|
## Workflow bei Funktionsänderungen
|
|
|
|
Vor jedem Docs-Deploy:
|
|
|
|
1. Technische Kataloge aktualisieren
|
|
|
|
```bash
|
|
node docs/scripts/sync-funktionsdoku.mjs
|
|
```
|
|
|
|
2. Änderungen committen
|
|
3. CI baut und pusht das `docs`-Image
|
|
4. Server zieht neues Image und startet den Service neu
|