On top of the static documentation, we incorporate additional metadata about the documentation site - such as owner, open GitHub Issues, Slack support channel, and Stack Overflow Enterprise tags.īut this is just one way to do it. During CI, a documentation site is created using MkDocs, and all sites are rendered centrally in a Backstage plugin. We are quite sure the main reason for the success of TechDocs is our docs-like-code approach - engineers write their technical documentation in Markdown files that live together with the code. Its popularity is evidence of something simple: We made documentation so easy to create, find, and use - people actually use it. It’s the most used plugin at Spotify by far - accounting for about 20% of our Backstage traffic (even though it is just one of 130+ plugins). Now let’s start collaborating and making it better, together. The first open source version of TechDocs is here.
Since we open sourced Backstage, one of the most requested features has been for a technical documentation plugin.
0 kommentar(er)
