Inbetriebnahme

Wichtiger Hinweis

Zielgruppe
Dieser Abschnitt wendet sich ausschließlich an technisch verantwortliche Personen.

Der Abschnitt beschreibt den Prozess zur technischen Bereitstellung einer neuen Dokumentationswebsite. Die hier beschriebenen Schritte sind einmalig zu Beginn eines neuen Projekts auszuführen.

Der Prozess gliedert sich in zwei wesentliche Phasen:

1. Ein neues Repository erstellen (Kopie)
   Um die Einhaltung technischer Standards und des einheitlichen Designs (Corporate Design) sicherzustellen, wird kein leeres Projekt angelegt. Stattdessen wird ein zentrales Template-Repository kopiert. Dies stellt sicher, dass die Docusaurus-Struktur sowie alle darüber hinaus notwendigen Komponenten und Skripte bereits vorhanden sind.

2. Bereitstellung
   Damit aus dem Quellcode eine aufrufbare Webseite wird, muss die Verbindung zwischen dem Repository und der Deployment-Umgebung hergestellt werden. Dies erfolgt unter anderem durch die Einrichtung eines Webhooks. Dieser sorgt dafür, dass Änderungen an der Dokumentation automatisch veröffentlicht werden.

Voraussetzung

Für die Durchführung dieser Schritte benötigen Sie mindestens die Rolle Maintainer (oder höher) in der entsprechenden GitLab-Gruppe.

Bitte führen Sie die auf den folgenden Unterseiten beschriebenen Schritte nacheinander durch.