Skip to content

[Story] Interner Dokuserver für Betriebsdokumentation

User Story

Als Projektmitglied möchte ich interne Betriebsdokumentation genauso einfach ansehen wie die öffentliche Doku. (https://git.fitko.de/fit-connect/betrieb)

Warum

Doku kann mit Docusaurus wesentlich einfach betrachtet werden als im GitLab ein Repo mit Markdown-Dateien anzusehen.

TODOs:

  1. Add DNS name: betrieb-docs.fit-connect.dev https://git.fitko.de/fit-connect/deployment/dns/-/blob/main/terraform/google-dns/fit-connect.dev.tfvars
  2. Add Dockerfile to https://git.fitko.de/fit-connect/betrieb repo
  3. Create Gitlab Group applications for OpenId: https://git.fitko.de/groups/fit-connect/-/settings/applications

Betrieb Docs LOCAL

Property Value
Callback URL https://betrieb-docs.tools.fc.test/_oauth
Confidential Yes
Scopes openid, profile, email

Betrieb Docs DEV

Property Value
Callback URL https://betrieb-docs.fit-connect.dev/_oauth
Confidential Yes
Scopes openid, profile, email

  1. Secure access with GitLab-Login (vie Traefik and thomseddon/traefik-forward-auth)

  2. Gitlab CI for build and deployment

Links, Hinweise, Bemerkungen

Akzeptanzkriterien

  1. Es steht ein interner Dokuserver zur Verfügung (analog zu docs.fitko.de) -> betrieb-docs.fit-connect.dev/
  2. Der Zugang zum Dokuserver ist mit einem GitLab-Login abgesichert
  3. Die Betriebsdokumentation wird über eine CI-Pipeline deployed (siehe #1860 (closed))

Mögliche Folgeaktivitäten (vom Entwickler zu ergänzen)

Edited by Andrey Strukov