[Epic] Betriebsdokumentation als interne Webseite

Warum

Als Projektmitglied möchte ich die Betriebdsdokumentation als Webseite mit Navigation und Suchfunktion ansehen um mich schneller zurechtzufinden.

Ziel

Die öffentliche Dokumentation wird mit Docusaurus als Webseite präsentiert, für die interne Dokumentation verwenden wir den Zugriff über das GitLab Repository. Die Navigation über Docusaurus ist deutlich komfortabler und wird langfristig Zeit einsparen, um die benötigten Informationen zu finden.

Links, Hinweise, Bemerkungen

Mögliche Plattformen:

• Uberspace (vermutlich nur Basic Auth über .htaccess)
• GitLab Pages (vermutlich nicht nutzbar da im GitLab nicht aktiviert)
• NGINX Container
• Traefik + NGINX Container
• ...weitere?

Stories

• #1861 (closed) Ergänzung der Betriebdsdokumentation um die von Docusaurus benötigten Dateien @Mark_Kane
• #2104 (closed) Entscheidung für eine Plattform, auf der die Webseite gehostet wird team::INF
  • Idee: In S3 legen, Login mit Traefik machen
• #2104 (closed) Aufsetzen der Plattform und einer CI-Pipeline zum Deployment team::INF

Akzeptanzkriterien

1. Die Betriebsdokumentation steht als Webseite zur Verfügung
2. Der Zugriff auf die Betriebsdokumentation ist mit einer dieser Optionen geschützt:
   1. Mit GitLab Login (präferiert, falls der Aufwand überschaubar ist)
   2. Mit Basic-Auth (falls das GitLab Login zu viel Aufwand erzeugt)
3. Definition of Done wurde überprüft.

Mögliche Folgeaktivitäten

• Migration des Developer Guides auf die gleiche Plattform
• Dokumentation unserer internen APIs

Offene Fragen