plugin-tools

plugin-tools copied to clipboard

We use docusaurus in combination with our design system to power the Grafana developer portal and associated microsites.

Plugin developers either have to resort to using their GitHub readme and other markdown files or build out their own custom documentation solution, such as https://yesoreyeram.github.io/grafana-infinity-datasource.

This issue is to explore ways in which we could leverage what we have already built to make a "template" plugin documentation site and reduce the burden for individual plugin authors to instantiate this themselves.

It could be a combination of tooling, templates (repos), tutorials, etc.

Providing this as a starting point could encourage more comprehensive and consistent documentation for plugins and improve the user experience for plugin consumers.