Zum Hauptinhalt springen

Cloudflare

Die bevorzugte Docs-Domain ist:

docs.skintogo.de

documentation.skintogo.de wird bewusst nicht verwendet, weil docs kurz und Standard für technische Dokumentationen ist.

Empfehlung: Cloudflare Pages für die Doku

Für die Docusaurus-Dokumentation ist Cloudflare Pages sinnvoller als ein Deployment auf der bestehenden App-Infrastruktur.

Gründe:

  • Docusaurus erzeugt statische Dateien.
  • Build und Hosting sind vom App-Deployment entkoppelt.
  • Doku-Deployments blockieren keine App-Deployments.
  • Rollbacks und Preview-Deployments sind einfach.
  • docs.skintogo.de lässt sich direkt als Custom Domain anbinden.
  • Die bestehende App-Infrastruktur bleibt auf Runtime-Services, API, Datenbank und Reverse Proxy fokussiert.

Wann bestehende Infrastruktur sinnvoll wäre

Ein Deployment auf bestehender Infrastruktur wäre nur naheliegend, wenn:

  • die Doku zwingend im privaten Netz bleiben soll
  • serverseitige Authentifizierung vor der gesamten Doku nötig ist
  • dieselbe Deployment-Kette wie die App gewünscht ist
  • Cloudflare Pages organisatorisch nicht genutzt werden soll

Für eine technische Projektdokumentation mit statischem Docusaurus-Build ist Cloudflare Pages die wartungsärmere Option.

Cloudflare Pages Secrets

Der vorbereitete GitHub-Workflow erwartet:

  • CLOUDFLARE_API_TOKEN
  • CLOUDFLARE_ACCOUNT_ID

Diese Werte gehören als GitHub Actions Secrets in das Docs-Repository und dürfen nicht dokumentiert oder geloggt werden.