Integrating Documentation in DevOps Practices

Are your docs part of your DevOps cycle? Richard chats with Mattias Karlsson about automating documentation for APIs, cloud resources, and more! Mattias talks about using tools to build text files that contain every Azure resource being utilized, hopefully per application, along with API info, NuGet packages, and more. He also digs into the different audiences for that documentation - business wants to know what website exist, both interior and publically facing. Operations need to know what resources are consumed on-premises and in the cloud. Development is always looking for versions of APIs, calling approaches, etc. Maintaining documentation by hand is tedious and perpetually out-of-date. But if you can get up to speed with the tooling, you can make your documentation generate at the speed of deployment!

Links

• Bicep
• Azure Resource Inventory
• Azure CLI
• Pulumi

Recorded October 29, 2024