DevOpsDocs: Transforming Tediousness into Joy

on YouTube ↗40m

" summary

A concrete claim: documentation becomes automated and current by calling vendors' REST APIs and extracting metadata into text files. The demo uses PowerShell + SQL Server module to dump schemas to Markdown, Azure ARM/CLI and Bicep artifacts plus container registries to inventory resources, and custom .NET tools (docfx / StaticDocs + a DPI dependency inspector) to emit per-resource Markdown and a static site generator. The open source inventory tool publishes a site in minutes (coffee-break / nightly CI) and the demos show it working end to end.

AI-written summary · about

" chapters (12)

1. 0:00DevOpsDocs introduction
2. 1:10Metadata as documentation foundation
3. 6:30Hacky scripts and iteration
4. 7:54SQL Server metadata example
5. 17:57Azure resources inventory
6. 20:51Bicep modules documentation
7. 24:02StaticDocs for .NET
8. 29:10Dependency documentation automation
9. 31:14Automation vs manual docs
10. 33:43Docs in build pipelines
11. 35:29Audience-specific documentation
12. 36:57Summary

" related talks

• 01h 01mClosing the documentation gap with Backstage.ioMartin Ehrnst, Bastiaan Wassenaar · NDC Oslo 2023
• 25mBuilding Docs like Code: Continuous Integration for DocumentationMason Egger · PyOhio 2019
• 39mPutting the Ops in DevOpsApril Edwards · PowerShell + DevOps Global Summit 2022
• 39mDevOps Your DocsLorna Jane Mitchell · Write the Docs Atlantic 2024
• 20mJourney Of Devops Teams in a Corporate EnvironmentJohannes Dienst, Carsten Hoffmann · DevConf.CZ 2021
• 01h 31mAccelerate Business Delivery With AI and DevOpsMohamed Radwan · DSC MENA 2024
• 01h 11mWorkshop - Automating for DevOpsKenneth Hansen, Hemant Mahawar · PowerShell Summit North America 2013
• 02h 50mBuild Beautiful Documentation with platyPS and Material for MkDocsJosh Hendricks · PowerShell + DevOps Global Summit 2024