#62 Phase 2: mkdocs + caddy-gitea-pages Hosting auf docs.gwoe.toppyr.de
mkdocs Material-Theme konfiguriert (mkdocs.yml). Build-Output wird in den gh-pages-Branch gepusht, von dort served caddy-gitea-pages den statischen Content als separater Container unter docs.gwoe.toppyr.de. Neuer docker-compose-Service gwoe-docs: - Image: ghcr.io/d7z-project/caddy-gitea-pages:nightly - Liest automatisch aus dem gh-pages-Branch via Gitea-API - Traefik-Labels für docs.gwoe.toppyr.de (SSL via Let's Encrypt) - Token via GITEA_TOKEN in .env (bereits auf dem Server hinterlegt) Wildcard-DNS *.toppyr.de zeigt bereits auf den VServer — kein DNS-Eingriff nötig, Traefik + Let's Encrypt erledigen den Rest. Doku-Update-Workflow: 1. ADR oder docs/ editieren 2. `mkdocs build` lokal 3. `git checkout gh-pages && cp -r site/* . && git add -A && git commit && git push` 4. caddy-gitea-pages refreshed automatisch .gitignore: site/ ausgeschlossen (Build-Artefakt). Refs: #62 (Phase 2)
This commit is contained in:
parent
92dcd25f73
commit
1e438a7baa
1
.gitignore
vendored
1
.gitignore
vendored
@ -17,3 +17,4 @@ reports/
|
|||||||
# OS
|
# OS
|
||||||
.DS_Store
|
.DS_Store
|
||||||
Thumbs.db
|
Thumbs.db
|
||||||
|
site/
|
||||||
|
|||||||
@ -23,6 +23,26 @@ services:
|
|||||||
networks:
|
networks:
|
||||||
- collaboration_collaboration
|
- collaboration_collaboration
|
||||||
|
|
||||||
|
# Doku-Hosting via caddy-gitea-pages (#62 Phase 2).
|
||||||
|
# Liest automatisch aus dem gh-pages-Branch. mkdocs build → git push
|
||||||
|
# origin gh-pages → Seite live unter docs.gwoe.toppyr.de.
|
||||||
|
gwoe-docs:
|
||||||
|
image: ghcr.io/d7z-project/caddy-gitea-pages:nightly
|
||||||
|
container_name: gwoe-docs
|
||||||
|
restart: unless-stopped
|
||||||
|
environment:
|
||||||
|
- GITEA_SERVER=https://repo.toppyr.de
|
||||||
|
- GITEA_TOKEN=${GITEA_TOKEN}
|
||||||
|
labels:
|
||||||
|
- "traefik.enable=true"
|
||||||
|
- "traefik.http.routers.gwoe-docs.rule=Host(`docs.gwoe.toppyr.de`)"
|
||||||
|
- "traefik.http.routers.gwoe-docs.entrypoints=websecure"
|
||||||
|
- "traefik.http.routers.gwoe-docs.tls=true"
|
||||||
|
- "traefik.http.routers.gwoe-docs.tls.certresolver=letsencrypt"
|
||||||
|
- "traefik.http.services.gwoe-docs.loadbalancer.server.port=80"
|
||||||
|
networks:
|
||||||
|
- collaboration_collaboration
|
||||||
|
|
||||||
networks:
|
networks:
|
||||||
collaboration_collaboration:
|
collaboration_collaboration:
|
||||||
external: true
|
external: true
|
||||||
|
|||||||
35
mkdocs.yml
Normal file
35
mkdocs.yml
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
site_name: GWÖ-Antragsprüfer Docs
|
||||||
|
site_url: https://docs.gwoe.toppyr.de
|
||||||
|
repo_url: https://repo.toppyr.de/tobias/gwoe-antragspruefer
|
||||||
|
repo_name: tobias/gwoe-antragspruefer
|
||||||
|
|
||||||
|
theme:
|
||||||
|
name: material
|
||||||
|
language: de
|
||||||
|
palette:
|
||||||
|
primary: teal
|
||||||
|
accent: light green
|
||||||
|
features:
|
||||||
|
- navigation.sections
|
||||||
|
- navigation.expand
|
||||||
|
- search.highlight
|
||||||
|
|
||||||
|
nav:
|
||||||
|
- Start: index.md
|
||||||
|
- Architecture Decision Records:
|
||||||
|
- Übersicht: adr/index.md
|
||||||
|
- "0001 LLM-Citation-Binding": adr/0001-llm-citation-binding.md
|
||||||
|
- "0002 Adapter-Architektur": adr/0002-adapter-architecture.md
|
||||||
|
- "0003 Citation-Property-Tests": adr/0003-citation-property-tests.md
|
||||||
|
- "0004 Deployment-Workflow": adr/0004-deployment-workflow.md
|
||||||
|
- Archiv:
|
||||||
|
- Übersicht: archive/index.md
|
||||||
|
|
||||||
|
markdown_extensions:
|
||||||
|
- tables
|
||||||
|
- admonition
|
||||||
|
- pymdownx.highlight
|
||||||
|
- pymdownx.superfences
|
||||||
|
- pymdownx.details
|
||||||
|
- toc:
|
||||||
|
permalink: true
|
||||||
Loading…
Reference in New Issue
Block a user