Closing the documentation gap with Backstage.io
summary
Organization centralizes scattered docs and runtime metadata by ingesting repo YAML into a Backstage.io catalog YAML and rendering mkdocs to HTML stored in Azure Storage, linking GitHub, Azure DevOps, AKS, Azure Resource Graph and AD. A custom Azure plugin surfaces resource groups, security flags and pod metrics on component pages. A scaffolder templates system generates repos, Bicep infra, GitHub Actions workflows and triggers deployments end to end. Adoption starts Oct 2021; implementation works in production but documentation gap shrinks rather than vanishes and templates are getting more granular.
AI-written summary · about
chapters (17)
- 0:00Documentation challenges
- 3:10Why docs matter
- 6:48Markdown to Backstage.io
- 8:36What is Backstage.io
- 11:03Backstage’s system model
- 16:00Software catalog with YAML
- 18:55Demo: software catalog
- 21:05Component discovery updates
- 24:22TechDocs plugin
- 26:09Demo: TechDocs integration
- 32:09Extending with plugins
- 34:14Demo: CI/CD and K8s plugins
- 41:26Self-service templates
- 43:35Demo: scaffolding services
- 51:12Template automation recap
- 52:15Adoption strategies
- 56:11Q&A
related talks
27mIntroduction to Backstage
35mBackstage: Restoring Order To Your Chaos
39mUnlocking Backstage's potential: insights and solutions for a smoother developer experience
28mBuilding Open Developer Platforms with Backstage
44mPushing documentation (so it doesn't hurt anymore)
40mDevOpsDocs: Transforming Tediousness into Joy
35mBuilding Docs like Code: Continuous Integration for Documentation
35mImproving Developer Experience with Open Source 1