Jedes Jahr treffen sich tausende Entwickler der Open Source Community beim FOSDEM Event. Statt vor Ort in Brüssel findet es dieses Jahr online statt. Mit über 500 Events und über 100 Tracks ist es eine der großen Veranstaltungen, bei denen sich Teilnehmer aus aller Welt begegnen.
Die msg ist mit dem Beitrag "Creating a documentation site for users with AsciiDoc and Antora" dabei. Dieser Vortrag ist Teil des DevRooms "Tool the docs", der verschiedene Aspekte und Technologien rund um Dokumentation vorstellt.
Die Teilnahme ist kostenlos. Alle Vorträge der Konferenz sind in englischer Sprache.
Mehr zum Devroom "Tool the docs"
Titel:
Creating a documentation site for users with AsciiDoc and Antora
Beschreibung:
The tool Antora creates documentation websites from AsciiDoc sources stored in Git repositories. Users can browse the generated website and select the version matching the software they use. Navigation outlines, search and cross-references between pages allow users to find answers to their questions. Several open-source software projects like Camel, Debezium and Couchbase use this solution.
For developers it is normal to develop software in collaboration using their IDE and a version control system like Git. The same type of collaboration is possible when all documentation is versioned in a markup-format like AsciiDoc.
This talk presents the basics of an Antora setup and walks through all the steps from editing content in the IDE to updating the documentation site using continuous integration and delivery.