Gábor Nyers - Documentation as code

Abstract

If you work as an IT professional chances are that you spend a great deal of your time on creating documentation. Want to learn how to create documents that are built from reusable bits, may contain generated diagrams and styled beautifully for both on-line and printed medium? As it is often the case, the right tooling and process can transform a tedious and error-prone chore into a fulfilling activity.

In this session you’ll see a demonstration of creating documentation as if it would be code. We’ll consider the necessary skills - like Markdown, RST and version control - and using some handy tooling (Pandoc, Jinja2, MkDocs or Sphinx, Mermaid and WeasyPrint) we’ll demo a few examples of how to create different types of documents, such as technical articles, project documentation, presentation slides, contracts, invoices or even your very own parametrized CV generator.

In addition, for those who need it, the approach supports Git based collaboration and automated build pipelines out of the box.

Biography

Gábor is an freelance instructor and consultant with 25+ years of experience in the IT industry. He teaches several courses on beginner and intermediate level around a number of DevOps topics, such as (Enterprise) Linux, Python, containers, Git and CI/CD. As consultant he typically works as DevOps engineer or as Python developer. He is also a regular speaker at conferences and meetups.

Spreker