feat(create-plugin): add panel-docs codemod - #2834
Draft
sunker wants to merge 7 commits into
Draft
Conversation
grafana-catalog-project-bot
Bot
moved this from 📬 Triage
to 🧑💻 In development
in Grafana Catalog Team
Base automatically changed from
eriksundell/plugin-docs-cli-meta-files
to
main
August 20, 2026 10:09
sunker
force-pushed
the
eriksundell/panel-docs-codemod
branch
from
August 20, 2026 10:31
b985289 to
bdd44bc
Compare
@grafana/create-plugin
@grafana/eslint-config
@grafana/eslint-plugin-plugins
@grafana/plugin-docs-cli
@grafana/plugin-docs-parser
@grafana/plugin-e2e
@grafana/plugin-meta-extractor
@grafana/plugin-types-bundler
@grafana/react-detect
@grafana/sign-plugin
@grafana/tsconfig
commit: |
… in panel-docs README template
…odemod 0.2.1 is now published and includes the repo-meta-file exclusion and inline-code-masking fixes that 0.2.0 predates.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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:
Adds
create-plugin add panel-docs, a codemod that scaffolds stub multi-page documentation for panel plugins (overview, data-formats, options, examples, troubleshooting, README), each page carrying section-brief comments describing what to fill in. Also wires the plugin up for docs publishing -docsPathinplugin.json,docs:serve/docs:validatenpm scripts, avalidate-docs.ymlworkflow and abuild-pluginversion bump.Which issue(s) this PR fixes:
N/A
Special notes for your reviewer:
Stacked on
eriksundell/plugin-docs-cli-meta-files(skip repo-meta files during docs validation) - that PR must merge first sincedocs:validatedepends on it. This is a scoped-down split of a larger draft; a datasource-docs codemod and an opt-in AI-authoring layer will follow as separate PRs.