Conversation
|
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. |
There was a problem hiding this comment.
Pull request overview
This PR updates the Grafana Plugin Tools docs to provide current, panel-plugin-focused guidance for implementing visualization suggestions (the “Suggestions” / visualization picker integration), and removes the older Angular→React migration doc for suggestion suppliers.
Changes:
- Adds a new how-to guide that explains how to enable and implement a suggestions supplier for panel plugins.
- Updates existing docs to link to the new guide and introduces a “Next steps” section in the panel tutorial.
- Removes the obsolete Angular→React migration guide page for suggestion suppliers and updates the sidebar accordingly.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
docusaurus/website/sidebars.ts |
Adds the new suggestions guide under Panel plugins and removes the old Angular→React entry. |
docusaurus/docs/tutorials/build-a-panel-plugin.md |
Adds “Next steps” links, including the new suggestions guide. |
docusaurus/docs/reference/metadata.md |
Expands plugin.json suggestions field description with a link to the new guide. |
docusaurus/docs/migration-guides/angular-react/suggestion-supplier.md |
Deletes the outdated migration guide page. |
docusaurus/docs/key-concepts/anatomy-of-a-plugin.md |
Adds a “Visualization suggestions” concept section pointing to the new guide. |
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md |
New end-to-end documentation for implementing and testing suggestions suppliers. |
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
Add a client redirect from /migration-guides/angular-react/add-suggestion-supplier to the new /how-to-guides/panel-plugins/add-suggestions-support guide to preserve existing inbound links and bookmarks.
- Capitalize 'Suggestions' in section heading and body text where referring to the Visualization Suggestions feature - Fix Fieldtype typo to FieldType in code example import
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
urbiz-grafana
left a comment
There was a problem hiding this comment.
Left a few style suggestions, LGTM otherwise!
…pport.md Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
…pport.md Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
…pport.md Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
…pport.md Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/how-to-guides/panel-plugins/add-suggestions-support.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com> Co-authored-by: Paul Marbach <fastfrwrd@gmail.com>
…pport.md Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
|
|
1 similar comment
|
|
Updates the Plugin author docs to have accurate and complete information on how to configure Suggestions for a panel plugin.