Vortrag: Microservices dokumentieren mit Antora

Zur Aufzeichnung

Lasst uns mit einer gewagten These starten: eigentlich möchte jeder in einem IT-Projekt dokumentieren, und alle sehen fehlende Dokumentation als Problem. Trotzdem scheint es so, als ob mit wachsendem Projekt die Dokumentation immer weniger, älter und einfach unpassender wird. Warum tun wir uns damit so schwer, wo es doch fast jedes Projekt auf Github schafft, ein brauchbares Readme zu haben?

Ist ja klar, Enterprise-Grade-Doku passt nunmal in kein Readme! Stimmt das wirklich?

In dieser Session möchte ich euch Antora vorstellen. Dieses Tool hilft euch dabei, Doku entspannt in euerer Lieblings-IDE mit Asciidoc zu schreiben, statt fluchend vor Word zu sitzen. Und das auch, wenn das Projekt mal komplexer wird: Antora stellt dabei aus vielen verschiedenen Repositories wieder eine zusammenhängende und bestens verknüpfte Dokumentation zusammen.

Nach einer kurzen Einführung von Asciidoc und Antora zeige ich, wie sich ein Konzept nach Arc42 für ein komplexeres System mit mehreren Microservices und Frontends, aufgeteilt auf verschiedene Repos generieren lässt. Dazu gibt's Tipps, wie ihr im Team am besten vorgeht. Außerdem werfen wir einen Blick auf das Extension-Ökosystem um zu sehen, was noch so alles machbar ist.

Info

Tag: 17.03.2021
Anfangszeit: 13:00
Dauer: 00:40
Raum: Wintergarten
Track: Werkzeuge
Sprache: de

Links:

Feedback

Uns interessiert Ihre Meinung! Wie fanden Sie diese Veranstaltung?

Gleichzeitige Events