Die Dokumentation kann auf zwei Wegen bearbeitet werden. Die Online Variante wird empfohlen, da hier keine Installation von Applikationen wie Git oder Hugo notwendig sind.

Online

Github bietet die Möglichkeit die Dateien, welche sich im Repositorium von Git befinden, direkt zu bearbeiten. Dies ist ausführlich in deren Dokumentation beschrieben. Dafür sind keinerlei Applikationen außer einem Browser notwendig. Navigiere dafür in den Dokumentationsordner im RDS Repositorium.

Achte darauf, dass Du beim Speichern einen neuen Pull Request erstellst bzw. den richtigen Zweig (Branch) auswählst, damit deine Änderungen auch gesichtet und von den Entwicklern eingepflegt werden können. Solange kein Pull Request vorhanden ist, können deine Änderungen nicht übernommen werden.

Ordnerstruktur

Im Ordner /docs im Hauptverzeichnis des Git Repositoriums findest Du den gesamten Quelltext zu der Webseite, die Du gerade betrachtest. Der Quelltext wird durch das Programm Hugo innerhalb der Gitlab-CI Pipeline verarbeitet. Anschließend existiert ein neuer Ordner namens public, welches auf den Webserver verschoben wird. Dies bedeutet, dass es sehr einfach ist, Änderungen an der Dokumentation durchzuführen.

Im Ordner /docs/content/doc sind alle Seiten in Markdown gespeichert, welche die technische Dokumentation darstellen, zu der auch die aktuelle Datei hier gehört.

In den anderen Ordnern unter /docs/content können Neuigkeiten oder Artikel (/docs/content/post), sowie verschiedene Seiten (/docs/content/page) außerhalb der technischen Dokumentation erstellt und bearbeitet werden.

Offline

Dafür wird nur ein neuer Pull Request mit den notwendigen Änderungen erstellt. Sobald die Änderungen gesichtet und akzeptiert wurden, sind sie auf der Webseite verfügbar.

Hugo bietet bei der Erstellung und Formatierung viele Annehmlichkeiten an. Weitere Funktionen sind außerdem durch das verwendete Theme verfügbar. Vor allem die Callouts sind besonders hilfreich bei der Erstellung übersichtlicher Texte.

Deine Veränderungen kannst Du lokal mit einer installierten Hugo-Applikation ansehen. Der folgende Befehl startet einen Server unter http://localhost:1313:

hugo server