tobias/gwoe-antragspruefer
1
0
Fork 0
Code Issues 11 Pull Requests Actions Packages Projects Releases 1 Wiki Activity
abb6cf81a8
gwoe-antragspruefer/mkdocs.yml

63 lines
2.0 KiB
YAML
Raw Normal View History

#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)
2026-04-10 09:42:44 +02:00
site_name: GWÖ-Antragsprüfer Docs
#62 Phase 2: Pivot nginx + docs.toppyr.de/gwoe-antragspruefer/ caddy-gitea-pages verworfen — dessen URL-Schema ({owner}.{domain}/{repo}) passt nicht für Single-Project-Hosting ohne DNS-Wildcards auf Sub-Sub- Domains. Stattdessen simples nginx:alpine mit statischem Volume-Mount. URL: https://docs.toppyr.de/gwoe-antragspruefer/ Der nginx-Container mounted docs-site/ nach /usr/share/nginx/html/gwoe-antragspruefer/ — Traefik routet alles auf Host docs.toppyr.de an den Container, nginx served den Pfad 1:1. Skaliert für weitere Repos: einfach ein zweites Volume-Mount für /usr/share/nginx/html/anderes-repo/ einrichten. SSL: Traefik, nicht nginx/caddy. DNS: *.toppyr.de Wildcard deckt docs.toppyr.de ab. Update-Workflow: cd webapp && mkdocs build scp -r site/* vserver:/opt/gwoe-antragspruefer/docs-site/ Caddyfile.docs entfernt (war caddy-gitea-pages-spezifisch). Refs: #62
2026-04-10 09:47:06 +02:00
site_url: https://docs.toppyr.de/gwoe-antragspruefer/
#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)
2026-04-10 09:42:44 +02:00
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
docs: API-Reference + mkdocs-Nav um Stimmverhalten/Aktuelle-Themen/Admin api.md ergaenzt um die ~20 neuen Endpoints (Stimmverhalten-Aggregate, Aktuelle-Themen, PM-Drafts, Admin-Stand, Auth, Score-Histogram, Vote-Orphans). Filter-Parameter-Tabelle dokumentiert. mkdocs.yml-Nav vollstaendig auf alle 11 ADRs erweitert plus Plenum-Vote-Parser-Roadmap unter "Analysen". Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-06 15:40:58 +02:00
- "0005 Keycloak SSO mit Dev-Bypass": adr/0005-keycloak-sso-with-dev-bypass.md
- "0006 Embedding-Modell-Migration v3→v4": adr/0006-embedding-model-migration-v3-to-v4.md
- "0007 Test-Taxonomie": adr/0007-test-taxonomy.md
- "0008 DDD-Lightweight-Migration": adr/0008-ddd-lightweight-migration.md
- "0009 Protokoll-Parser-Registry": adr/0009-protokoll-parser-registry.md
- "0010 Stimmverhalten×GWÖ-Aggregat": adr/0010-stimmverhalten-gwoe-aggregat.md
- "0011 Aktuelle-Themen + PM-Generator": adr/0011-aktuelle-themen-pm-generator.md
#93 Vergleichsmatrix: Adapter-Capabilities pro Bundesland
2026-04-10 14:09:42 +02:00
- Reference:
#62: API-Reference + Datenmodelle + Embeddings-Pipeline (mkdocstrings)
2026-04-10 14:14:15 +02:00
- API-Endpoints: reference/api.md
#93 Vergleichsmatrix: Adapter-Capabilities pro Bundesland
2026-04-10 14:09:42 +02:00
- Adapter-Capabilities: reference/adapter-capabilities.md
#62: API-Reference + Datenmodelle + Embeddings-Pipeline (mkdocstrings)
2026-04-10 14:14:15 +02:00
- Datenmodelle: reference/models.md
- Embeddings & Citations: reference/embeddings.md
docs: API-Reference + mkdocs-Nav um Stimmverhalten/Aktuelle-Themen/Admin api.md ergaenzt um die ~20 neuen Endpoints (Stimmverhalten-Aggregate, Aktuelle-Themen, PM-Drafts, Admin-Stand, Auth, Score-Histogram, Vote-Orphans). Filter-Parameter-Tabelle dokumentiert. mkdocs.yml-Nav vollstaendig auf alle 11 ADRs erweitert plus Plenum-Vote-Parser-Roadmap unter "Analysen". Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-06 15:40:58 +02:00
- Analysen:
- Plenum-Vote-Parser-Roadmap: protokoll-parser-roadmap.md
Docs: Keycloak-Setup How-to + ADR-Index aktualisiert
2026-04-10 16:33:52 +02:00
- How-to:
- Keycloak einrichten: how-to/keycloak-setup.md
#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)
2026-04-10 09:42:44 +02:00
- Archiv:
- Übersicht: archive/index.md
#62: API-Reference + Datenmodelle + Embeddings-Pipeline (mkdocstrings)
2026-04-10 14:14:15 +02:00
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [.]
options:
show_source: false
show_bases: true
heading_level: 3
#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)
2026-04-10 09:42:44 +02:00
markdown_extensions:
- tables
- admonition
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.details
- toc:
permalink: true
Reference in New Issue Copy Permalink