Alte Handbuch Versionen parallel zur aktuellen Dokumentation verfügbar machen

[j3nsch]

Die Dokumentation für 4.7 unterscheidet sich deutlich von 4.6, insbesondere bei der Anpassung von Übersetzungen. Alle OPUS 4 Instanzen sollten die neueste Version nutzen, aber mittelfristig könnte es notwendig sein, dass die alte Dokumentation weiterhin verfügbar ist.

Dafür muss eine gute Lösung gefunden werden. Leider ist es mit GitHub Pages nicht möglich mehrere Branches zu veröffentlichen. Die alten Dokumentation müsste also in ein Unterverzeichnis kopiert werden, was die Seiten für die verschiedenen Version von einander trennen würde.

Alternativ könnte man vielleicht mit mehreren Repositorien arbeiten. Die GitHub Pages für eine ältere Version könnten in einer Subdomain angezeigt werden. Das müsste getestet werden.

Wenn wir aus der Dokumentation nicht nur eine statische Website, sondern auch ein PDF generieren könnten, wäre es möglich die alten Dokumentation einfach als Datei für den Download verfügbar zu machen. Ich habe momentan noch keine Ahnung, ob es für Jekyll Themes bzw. Tools gibt, die das erlauben würden.

Ich denke die Verwaltung der Dokumentation in einem Git-Repository auf GitHub ist wichtig und einem externen Tool, dass nicht frei zugänglich ist vorzuziehen.

Zusätzlich zu GitHub Pages gäbe es auch noch die Wikis auf GitHub. In der Vergangenheit waren sie zu eingeschränkt für unsere Nutzerdokumentation, aber sie könnten für grundlegende Informationen und vor allem für Entwickler genutzt werden.