Online-Dokumentation für Nutzer mit AsciiDoc und Antora

  • 20.06.2022
  • ab 18:00 Uhr
  • bis 20:00 Uhr
  • kostenfrei
  • online

Die Anmeldung schließt am 20.06.2022 um 12:00 Uhr.

Willkommen bei unserer ObjektForum OnlineEdition.

Wie gewohnt mit dem Teilnahmeformular anmelden, dann schicken wir Ihnen am Veranstaltungstag den Link zur virtuellen Teilnahme via Zoom per Mail zu. Mit dieser Mail erhalten Sie unter anderem detaillierte Informationen über den Ablauf. Kommen Sie einfach kurz vor 18:00 in den virtuellen Raum - selbstverständlich gibt es auch in der OnlineEdition eine Menge Zeit zum Fragen, Diskutieren und Chatten.

Wir freuen uns auf ein spannendes ObjektForum - online!

 

Abstract

Antora erstellt Dokumentations-Websites für Nutzer. Gemäß des Docs-as-Code-Ansatzes werden alle Inhalte in AsciiDoc-Dateien in Git-Repositories versioniert und über CI/CD publiziert.

Die Nutzer erhalten eine übersichtliche Darstellung der Dokumentation im Browser mit Navigationsleiste, Suche und Querverweisen. Sie können zwischen verschiedenen Versionen der Dokumentation hin- und herschalten, um die für sie passenden Informationen zu finden. Open-Source-Projekte wie Camel, Debezium und Couchbase nutzen diese Lösung bereits. Entwickler und Autoren der Dokumentation bearbeiten die Inhalte wie gewohnt in ihrer IDE und versionieren die Inhalte in der Versionsverwaltung mit Git. Alle Änderungen durchlaufen die bestehenden Code-Review- und Build-Prozesse des Projekts.

Dieser Vortrag stellt die Grundlagen eines Antora-Setups vor und zeigt alle Schritte von einer Dokumentationsänderung in der IDE bis hin zur aktualisierten Dokumentations-Website mit Continuous Integration und Delivery.

Referenteninformation

Alexander Schwartz arbeitet als Principal Software Engineer bei Red Hat. Er hilft Organisationen und Teams die richtigen Architekturentscheidungen zu treffen. Um wartbare Software zu bauen, unterstützt er mit Best Practices und passenden Werkzeugen. Er geht mit gutem Beispiel voran, um echte agile Prozesse zu leben und ist immer neugierig geblieben. Technologisch geht es meist um JavaScript-Frontends, Java-Backends, Kubernetes und wie man es passend betreiben kann. Auf Konferenzen und bei User Groups spricht er über seine Erfahrungen.

Anmeldung

Bitte addieren Sie 9 und 3.

Zurück