Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Docs-as-Code with AsciiDoc & docToolchain

Docs-as-Code with AsciiDoc & docToolchain

A journey to the limits

https://fosdem.org/2021/schedule/event/ttddoctoolchain/

The combination of AsciiDoc and Gradle should be well known by now. But what if you want to go beyond? Have you ever tried to include UML diagrams the easy way, convert Excel to AsciiDoc or export your results to Confluence? This talk shows you what you can really do if you treat your docs as code and apply some tricks you only did to your code before. Forget about copy & paste your images to your documentation – let the build do it! Create different docs for different stakeholders and even run automated tests on your docs!

In this talk, Ralf will give an short overview of the open source documentation tool chain "docToolchain". He will open up the Docs-as-Code solution space with some new and fresh ideas and show where the Docs-as-Code approach is heading to.

As the maintainer of the open source tool called "docToolchain", Ralf tries to push the Docs-as-Code approach further to its limits. Every new idea finds its place in the docToolchain. It is by now a collection of quite helpful tasks of your every day documentation needs.

This talk assumes that you already know about the docs-as-code approach and AsciiDoc.

docToolchain itself uses jBake to create a webpage but it will also play nicely together with Antora which is shown in the talk "Creating a documentation site for users with AsciiDoc and Antora" by Alexander Schwartz at 15:00.

AsciiDoc can be converted out of the box to docBook. So I assume that most tools shown can be combined with approaches shown in the talk "20 years with DocBook" at 16:00.

Cc5f3bf8b3cb91c985ed4fd046aa451d?s=128

Ralf D. Müller

February 05, 2021
Tweet

Transcript

  1. Docs-as-Code with AsciiDoc & docToolchain A journey to the limits

    07.02.2021 | FOSDEM
  2. About docToolchain What it is and why does it matter?

    DB Systel GmbH | Ralf D. Müller | @RalfDMueller 2
  3. Basic Docs-as-Code with AsciiDoc DB Systel GmbH | Ralf D.

    Müller | @RalfDMueller 4 asciidoctor
  4. Basic Docs-as-Code with AsciiDoc DB Systel GmbH | Ralf D.

    Müller | @RalfDMueller 5 asciidoctor your solution architecture documentation read
  5. Basic Docs-as-Code with AsciiDoc DB Systel GmbH | Ralf D.

    Müller | @RalfDMueller 6 asciidoctor your solution architecture documentation read arc42 asciidoc template is derived from
  6. Basic Docs-as-Code with AsciiDoc DB Systel GmbH | Ralf D.

    Müller | @RalfDMueller 7 asciidoctor your solution architecture documentation read HTML5 generate HTML arc42 asciidoc template is derived from
  7. Basic Docs-as-Code with AsciiDoc DB Systel GmbH | Ralf D.

    Müller | @RalfDMueller 8 asciidoctor your solution architecture documentation diagram plugin plantUML read HTML5 generate HTML arc42 asciidoc template is derived from
  8. Basic Docs-as-Code with AsciiDoc DB Systel GmbH | Ralf D.

    Müller | @RalfDMueller 9 asciidoctor your solution architecture documentation pdf plugin diagram plugin plantUML read PDF generate PDF HTML5 generate HTML arc42 asciidoc template is derived from
  9. Basic Docs-as-Code with AsciiDoc DB Systel GmbH | Ralf D.

    Müller | @RalfDMueller 10 asciidoctor your solution architecture documentation pdf plugin diagram plugin plantUML read PDF generate PDF HTML5 generate HTML arc42 asciidoc template is derived from
  10. DB Systel GmbH | Ralf D. Müller | @RalfDMueller Basic

    Docs-as-Code with AsciiDoc & docToolchain 11
  11. DB Systel GmbH | Ralf D. Müller | @RalfDMueller 12

    Basic Docs-as-Code with AsciiDoc & docToolchain
  12. DB Systel GmbH | Ralf D. Müller | @RalfDMueller 13

    Basic Docs-as-Code with AsciiDoc & docToolchain
  13. DB Systel GmbH | Ralf D. Müller | @RalfDMueller 14

    Basic Docs-as-Code with AsciiDoc & docToolchain
  14. DB Systel GmbH | Ralf D. Müller | @RalfDMueller 15

    Basic Docs-as-Code with AsciiDoc & docToolchain
  15. DB Systel GmbH | Ralf D. Müller | @RalfDMueller 16

    Basic Docs-as-Code with AsciiDoc & docToolchain
  16. Demo Check out the recording for the demo

  17. Thank you for your Attention! Visit doctoolchain.github.io or follow me

    on twitter @RalfDMueller for more information. Thanx to all Contributors and Sponsors!
  18. None