Login
Newsletter
Werbung

Fr, 3. August 2018, 09:47

Software::Distributionen::Fedora

Fedoras Dokumentations-Webseite komplett überholt

Fedora hat seiner Dokumentations-Webseite mit Antora einen neuen Unterbau verpasst und setzt anstelle von DocBook nun auf AsciiDoc. Damit soll neben einer besseren Gesamtstruktur der Seite auch die Einstiegshürde für Mitwirkende aus der Gemeinschaft gesenkt werden.

fedoraproject.org

In den letzten Jahren hatte Fedoras Dokumentations-Webseite potenzielle Mitwirkende eher abgeschreckt. Das hauseigene Bau-Werkzeug Publican wurde nicht mehr aktiv entwickelt und ließ sich mit aktuellen Fedora-Versionen nicht mehr nutzen. Zusätzlich wurden viele potenzielle Mitwirkende abgeschreckt, da sie DocBook, eine XML-Markup-Sprache für technische Dokumentation, lernen mussten, um einen Beitrag zu leisten.

Wie das Fedora Magazine jetzt berichtet, sind nach mehrjähriger Arbeit nun erste Früchte der Neuorientierung zu sehen. Die Fedora Dokumentations-Webseite erhielt mit dem noch jungen Projekt Antora eine neue Dokumentations-Engine, die Seiten auf der Basis von Asciidoctor erstellt und als Auszeichnungssprache AsciiDoc verwendet. Während DocBook auf XML basiert, ist AsciiDoc eine leichter zu erlernende Auszeichnungssprache auf der Basis von einfachem Text.

Die Gründe der Entscheidung für Antora und AsciiDoc werden im Community-Blog ausführlich erläutert. Aufgrund der neuen Basis weist die Seite nun eine bessere Navigation sowie eine klarere URL-Struktur auf. Der Bau-Prozess der Seiten soll künftig noch weiter automatisiert werden, damit Dokumentation schneller zu den Anwendern gelangt. Außerdem sollen große Inhaltsblöcke aufgebrochen werden, um sie besser pflegen und ergänzen zu können.

Ein weiteres Projekt ist das von Projektleiter Matthew Miller angeregte Quick Docs, in dessen Rahmen bisher im Wiki untergegangene problemorientierte Dokumentation mehr Sichtbarkeit erlangen soll. Es wurde damit begonnen, die wichtigsten Themen aus dem Wiki für die Dokumentationsseite aufzuarbeiten. Hier werden noch Mitwirkende gesucht, eine Anleitung zum Konvertieren von aktualisierten Themen findet sich auf der Quick-Docs-Seite. Wiki-Artikel, die keiner Überarbeitung bedürfen, können auch mittels eines eigens entwickelten Plugins auf die Dokumentationsseite umgeleitet werden.

Werbung
Pro-Linux
Unterstützer werden
Neue Nachrichten
Werbung