[runwhen-local-feedback] Integration with Backstage Techdocs Desired

[stewartshea]

Observation
There has been a couple of discussions around integrations with the Backstage Idp. This issue is to track some ideas around what this might look like.

The integration would make sense for users of Backstage. Backstage is intended to provide a centralized resource portal of developer resources, from documentation through to integrations with development tooling and infrastructure. Since RunWhen Local provides a form of auto-generated troubleshooting documentation, integrating these documents into Backstage seems like a logical approach.

Possible Suggestions
Initial thoughts here would be pretty straight forward, since Backstage TechDocs and the RunWhen Local Cheatsheet are both based on mkdocs:

• Create a set of mkdocs templates and configuration files that are tailored towards Backstage
• Create an export feature for all rendered troubleshooting documentation that can distribute the documentation into one of Backstage's accepted formats (e.g. GitHub, GCS, S3?)
• Create documentation on how to configure and test the integration

Any other details or context
These ideas are based on my limited knowledge and experience with Backstage. We are actively seeking additional feedback and design partners that are interested in this integration.