Skip to content

Suggestions: Add plugin developer docs#2541

Open
fastfrwrd wants to merge 17 commits intomainfrom
fastfrwrd/suggestions-api-docs
Open

Suggestions: Add plugin developer docs#2541
fastfrwrd wants to merge 17 commits intomainfrom
fastfrwrd/suggestions-api-docs

Conversation

@fastfrwrd
Copy link
Copy Markdown
Contributor

Updates the Plugin author docs to have accurate and complete information on how to configure Suggestions for a panel plugin.

Copilot AI review requested due to automatic review settings March 25, 2026 20:39
@fastfrwrd fastfrwrd requested review from a team as code owners March 25, 2026 20:39
@fastfrwrd fastfrwrd requested review from eledobleefe, jackw and mckn March 25, 2026 20:39
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 25, 2026

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.

@fastfrwrd fastfrwrd added the no-changelog Don't include in changelog and version calculations label Mar 25, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@grafana-plugins-platform-bot grafana-plugins-platform-bot bot moved this from 📬 Triage to 🔬 In review in Grafana Catalog Team Mar 25, 2026
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
Copy link
Copy Markdown
Contributor

@urbiz-grafana urbiz-grafana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few style suggestions, LGTM otherwise!

fastfrwrd and others added 4 commits March 30, 2026 08:50
…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>
fastfrwrd and others added 2 commits March 30, 2026 08:52
Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
Co-authored-by: Paul Marbach <fastfrwrd@gmail.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 7 out of 8 changed files in this pull request and generated 3 comments.

…pport.md

Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
@cla-assistant
Copy link
Copy Markdown

cla-assistant bot commented Mar 30, 2026

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ fastfrwrd
❌ adela-almasan
You have signed the CLA already but the status is still pending? Let us recheck it.

1 similar comment
@cla-assistant
Copy link
Copy Markdown

cla-assistant bot commented Mar 30, 2026

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ fastfrwrd
❌ adela-almasan
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog Don't include in changelog and version calculations

Projects

Status: 🔬 In review

Development

Successfully merging this pull request may close these issues.

4 participants