New Doc: Adding a suggestion supplier to a plugin #816
Conversation
briangann
added
type/docs
|
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. |
|
|
||
| You can add a suggestion supplier to examine query data coming from a panel and suggest usage of the plugin for the type of data detected. This guide provides instructions for doing so along with links to relevant examples. | ||
|
|
||
| A single stat panel would be ranked "high" for a single series, and "low" for multiple series (or even none). |
There was a problem hiding this comment.
This sentence seems disconnected from what came before. Can you clarify?
There was a problem hiding this comment.
will add text here, i left out context
|
|
||
| :::note | ||
|
|
||
| When creating a suggestion supplier be certain the plugin can actually render something for the data being provided. |
There was a problem hiding this comment.
What happens if you don't?
There was a problem hiding this comment.
Grafana will either display a blank panel and/or an error message will be displayed. It's best to offer the plugin only to query data that matches well-known criteria that the author can validate.
|
|
||
| ## Additional resources | ||
|
|
||
| Reference these suggestion suppliers to get ideas for further customization: |
There was a problem hiding this comment.
Can you add a sentence or part of a sentence to note what's distinctive about the suggestion suppliers in each of these plugins?
|
updated with more details, hopefully this reads a little better |
What this PR does / why we need it:
Adds docs for creating a suggestion supplier for a plugin
Which issue(s) this PR fixes:
Fixes # grafana/grafana#84419