Web-Ansichten

Sie können Ihr Dokument als Web-Ansicht direkt über openCode bereitstellen. Sie benötigen für diese “Web-Ansicht Light” keinen Betriebsdienstleister oder zusätzliche Software.

Neben der “Web-Ansicht Light” können Sie auch eine “Web-Ansicht Full” erstellen. Diese enthält die folgenden zusätzlichen Funktionen:

• Kommentarfunktion: Nutzer können Kommentare zu einzelnen Abschnitten hinterlassen. Die Kommentare werden zu Issues in Ihrem openCode-Projekt. Sie können aus den Issues heraus auf die Kommentare antworten.
• Synopse: Es steht eine Synopse (Git-Diff) zur Verfügung, die Versionen (Git-Tags) miteinander vergleicht.
• Self-Assessment: Sie können ein Self-Assessment durch die Nutzer durchführen lassen. Die Fragen werden aus Ihren Markdown-Dateien extrahiert (siehe Self-Assessment).

Menü-Struktur

Sie können optional die Menü-Struktur der Web-Ansicht über Dateien mit Meta-Informationen steuern. Die Dateien müssen den Dateinamen _meta.json haben. Es kann eine _meta.json-Datei pro Ordner geben.

Aufbau

Der Titel und die Reihenfolge einer in der Seitenleiste angezeigten Seite sollten in der Datei _meta.json als Schlüssel-Wert-Paare konfiguriert werden. Wenn Sie zum Beispiel die folgende Dateistruktur haben:

Dann könnte die _meta.json-Datei folgendermaßen aussehen:

Die _meta.json-Datei im Unterordner könnte folgendermaßen aussehen:

Besondere Einstellungen

Sie können auch spezielle Einstellungen für die Web-Ansicht in der _meta.json-Datei vornehmen.

Verstecken von Seiten

Anzeige nur im Footer

Standardmäßig aufklappter Ordner

Deployment bestimmter Versionen

Sie können konfigurieren, welche Versionen Ihrer Dokumentation als Web-Ansicht bereitgestellt werden sollen. Dazu müssen Sie eine Anpassung an der .gitlab-ci.yml-Datei vornehmen.

Standardmäßig werden getaggte Versionen als Web-Ansicht bereitgestellt (sieh hierzu auch Versionierung).

Sie können die deploy-only-on-Eigenschaft auf tags, einen Branch-Namen (z.B. main) oder einen konkreten Tag (z.B. 1.0.0) setzen. Im Falle von tags wird immer der letzte erzeugte Tag als Web-Ansicht bereitgestellt. Wenn Sie einen Branch-Namen einstellen, wird immer die letzte Version des Branches bereitgestellt.

Um einen konkreten Tag zu deployen, müssen Sie die folgenden Punkte beachten:

• Konfiguration in der .gitlab-ci.yml-Datei anpassen (z.B. deploy-only-on: "1.0.0")
• Tag z. B. über die openCode UI erstellen ausgehend von dem Stand (z. B. main) auf dem Sie die Änderungen an der .gitlab-ci.yml-Datei vorgenommen haben.
• Das Anlegen des Tags erzeugt eine Pipeline in GitLab, die die Web-Ansicht bereitstellt.

Wenn Sie den Tag vor der Anpassung der .gitlab-ci.yml-Datei erstellen, wird die Web-Ansicht nicht bereitgestellt. Sie müssen dann einen neuen Tag erstellen, nachdem Sie die Anpassung vorgenommen haben.