Von Asciidoc zu Antora

Fabian Kalweit

Playlists: 'froscon2023' videos starting here / audio

Am Anfang wurde die opsi-Dokumentation mit OpenOffice erstellt. Als die Dokumente dann zu groß wurden, wurde Asciidoc und eine Versionsverwaltung für die Dokumentation eingeführt. Der Build-Prozess mit Asciidoc und recht umfangreichen Build-Skripten war bis vor kurzem noch im Einsatz.
Letztes Jahr wurde der gesamte Dokumentations- und Build-Prozess auf Asciidoctor umgestellt.
Mit Asciidoctor können die Asciidoc-Quellen direkt in HTML und mit Asciidoctor-PDF auch in PDF umgewandelt werden.
Damit entfällt die Notwendigkeit einer DocBook- oder LaTeX-Toolchain.

In einem weiteren Schritt wurde die opsi-Dokumentation in eine Antora-Dokumentation umgewandelt.
Antora erstellt eine Dokumentationsseite mit Navigation und Suche. Auf dieser Seite werden alle Handbücher zusammengefasst.
Über die Dokumentationsseite können die Benutzer nun auch Änderungen an der Dokumentation einreichen.
Zusätzlich werden mit Hilfe eines Skripts und Asciidoctor HTML- und PDF-Dateien der einzelnen Handbücher erstellt.

Download

Embed

Share:

Tags