From 1e438a7baa5f115d818dec060ef4b5c9e07126e8 Mon Sep 17 00:00:00 2001 From: Dotty Dotter Date: Fri, 10 Apr 2026 09:42:44 +0200 Subject: [PATCH] #62 Phase 2: mkdocs + caddy-gitea-pages Hosting auf docs.gwoe.toppyr.de MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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) --- .gitignore | 1 + docker-compose.yml | 20 ++++++++++++++++++++ mkdocs.yml | 35 +++++++++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+) create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore index e7d42ba..c82041c 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,4 @@ reports/ # OS .DS_Store Thumbs.db +site/ diff --git a/docker-compose.yml b/docker-compose.yml index b02fce5..ff90e52 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -23,6 +23,26 @@ services: networks: - 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: collaboration_collaboration: external: true diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..0b5501d --- /dev/null +++ b/mkdocs.yml @@ -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