[Plugin] markdoc for Backstage

[praveensanap]

Summary

A backstage plugin integration with markdoc.io

Project website (if applicable)

Stripe announced release of their documentation authoring tool. https://markdoc.io/ https://github.com/markdoc/markdoc

Context

https://increment.com/documentation/why-investing-in-internal-docs-is-worth-it/ This article advocates investing in authoring tool for engineers.

Current TechDocs plugin displays the documents beautifully, but to edit it redirects to Github Edit page. Although, MD files can be edited in IDE that has great support. Do you guys feel there will be a value add if we add support for editing documents in UI?

[benjdlambert]

@garyniemen do you want to have some input here and take a look?

[garyniemen]

Hi @praveensanap - I think this is a good idea and I think could be implemented using the new TechDocs Addon Framework. Do you agree @iamEAP ?

[praveensanap]

Thanks @garyniemen. We are in the midst of adopting backstage at github.com/carousell. We will work on a prototype to integrate markdoc.io using TechDocs Addon Framework. Will report the findings. Thanks~

[rodmachen]

@praveensanap any update on this?

Is the idea that users would be able to edit TechDocs, with a preview provided by markdoc, that would then open a PR against the appropriate repo?

[anilazaidi]

Wow, really hope this comes about -- thank you!!

[jasondeutsch]

Keeping this alive. Hope this comes to be.

[awanlin]

Looking for contributions to make this one a reality! 🚀

[github-actions[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.