Go to content

Writing documentation with Asciidoctor by Jérémie Bresson

Asciidoctor is a comprehensive, user-friendly publishing toolchain for the AsciiDoc writing format that uses the AsciiDoc markup language (similar to Markdown or Textile). The Asciidoctor platform is both open source and easy to use. Therefore, several projects at the Eclipse foundation as well as other open source projects such as the Spring getting started guides and the OpenShift project have adopted Asciidoctor to reduce the pain when writing documentation. After a quick overview of the AsciiDoc language, the talk will focus of the pattern that can be used to solve some of the recurrent problems encountered with documentation: * How do I handle source code snippets and ensure that they stay up-to date? * How do I single source different documentation? (Reuse of text blocs) * What are the requested tools and why does it matter? * How do I have reproducible builds for my documentation? * How do I get feedback from my community/users? This talk focuses on practical examples from the real world usage in the Eclipse Scout project and will be illustrated with live demonstrations.

March 3, 2016