Docs: auto generate plugin schema reference #1770
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hugohaggmark
added
type/docs
github-project-automation
bot
moved this to 📬 Triage
in Plugins Platform / Grafana Community
|
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs. |
hugohaggmark
force-pushed
the
hugoh/auto-schema
branch
from
02b4b94 to
32be476
Compare
hugohaggmark
commented
May 7, 2025
hugohaggmark
force-pushed
the
hugoh/auto-schema
branch
from
26b0be2 to
1f7bdfd
Compare
tolzhabayev
moved this from 📬 Triage
to 🔬 In review
in Plugins Platform / Grafana Community
I actually like it better this way 👍 |
github-project-automation
bot
moved this from 🔬 In review
to 🚀 Shipped
in Plugins Platform / Grafana Community
This was referenced May 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR downloads the plugins-schema and generates markdown from the schema using jsonschema2mk.
LIMITATIONS
This approach unfortunately comes with a small (or big, depends how you feel) limitation and that is the linking from tables to headers are based on full paths of properties in the json schema. This means that the Docusaurus quick links and headers in the document show the full path to properties. I've tried different approaches by customizing different
partialsbut I think we would need to hook into extensions to make the links unique because for exampleexposedcomponentsappears twice in the document.Which issue(s) this PR fixes:
Fixes #1651 , #1650
Special notes for your reviewer:
Passing runs here https://github.com/grafana/plugin-tools/actions/runs/14875523629/job/41772019976?pr=1770 and here https://github.com/grafana/plugin-tools/actions/runs/14875523629/job/41772019976?pr=1770 look for
Markdown generation complete!in theBuild documentation website (Dev Portal)stepDeployed the latest commit to DEV bucket so you can test
To test this PR:
npm cinpm run docs:clearDEV_PORTAL_ENV=dev npm run docs:build, shouldn't create any build errors ✅npm run docs, should render a new Metadata (plugin.json) page that is in sync with plugin schema ✅