Tool The Docs
Automate IaC documentations with terraform-docs
Introduction to terraform-docs and a showcase of a real world example
February 7, 2021
5:00 PM – 5:30 PM Add to calendar
5:00 PM – 5:30 PM Add to calendar
D.docs
Let's face it: our documentations are more often than not at least one step behind our implementations. This becomes a problem when it prevents our users from effectively using what we produce as developers. In this talk, you will learn from its maintainers an in depth introduction of terraform-docs, how users apply the tool to automate the documentation of Terraform modules to always keep implementation and documentation consistent whenever a part of their code changes. You will also get to know about more possibilities, such as the automated rendering of Jenkins pipelines to execute Terraform code using the same tool.
Additional information
| Type | devroom |
|---|
More sessions
| 2/7/21 |
We can't have our normal brunch this year, so let's all meet before the talks start and enjoy… Well, whatever we want too :)
|
| 2/7/21 |
Learn about the missing ingredient from your Docs-as-Code recipe, a headless CMS (Content Management System). Let's understand the problems writers face and how adding a CMS to your Docs toolchain helps solve (some of) them. We'll look at a sample docs-as-code repository and then add a CMS to the mix. We'll then go through authoring new topics and editing existing docs with our CMS (Look ma, no Git).
|
| 2/7/21 |
Originally having been developed for the open source projects at Facebook, Docusaurus now serves as an easy-to-use tool across many open-source projects. Having worked with it on the Google Season of Docs for transforming Rucio's documentation (http://rucio.cern.ch/documentation/) & as the SIG DOCS lead for LitmusChaos, this talk is an exposition of my experiences with the static site generator. I hope to benefit others looking at migrating to/using this tool with the contents.
|
| 2/7/21 |
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 ...
|
| 2/7/21 |
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.
|
| 2/7/21 |
In 2017 Nexmo (now Vonage) launched their first documentation portal as a Ruby on Rails site. Fast forward more than 3 years and the Vonage API Developer is now running on a custom-built open-source tool we call Station. Station powers multiple documentation portals, and allows us to achieve numerous organizational goals. How did we arrive at Station and not get derailed in the process? In this talk, we will take a deep dive into the technical journey behind Station. What does the tech stack ...
|
| 2/7/21 |
PostgreSQL has been maintaining its documentation in DocBook for over twenty years. It's been successful but not without challenges. PostgreSQL is often praised for its excellent documentation, and PostgreSQL is also often criticized for its hard-to-approach documentation.
|
