Loading…
DevConf.US 2021 has ended
DevConf.US 2021 is the 5th annual, free, Red Hat sponsored technology conference for community project and professional contributors to Free and Open Source technologies coming to Boston!
Back To Schedule
Friday, September 3 • 15:30 - 16:00
Documentation for users with AsciiDoc and Antora

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Tweet Share
Video Stream


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.
Speakers
avatar for Alexander Schwartz

Alexander Schwartz

Principal Software Engineer, Red Hat
I help organisations and teams to make architecture decisions that match their needs. To build their software in a maintainable way, I empower them with best practices, tools and libraries. I lead by example to adopt true agile processes and to stay curious. Ideas spark when sharing... Read More →

2021 09 03 documentation site for users asciidoc antora devconfus pdf
Friday September 3, 2021 15:30 - 16:00 EDT
Virtual
  Ensuring Software Quality, Beginner

Attendees (27)