@grafana/create-plugin 7.15.1 → 7.17.0

package/templates/docs/datasource/docs/dashboards.md

@@ -12,6 +12,8 @@ sidebar_position: 7
 
 ## Import a dashboard
 
+<!-- snippet:import-dashboard -->
+
 To import a dashboard that ships with {{{pluginName}}}:
 
 1. Click **Connections** > **Data sources** in the left-side menu.
@@ -21,6 +23,8 @@ To import a dashboard that ships with {{{pluginName}}}:
 
 Imported dashboards don't update when you upgrade the plugin. When a plugin upgrade ships a newer version of a dashboard, click **Update** next to it. This overwrites any changes you made to it.
 
+<!-- /snippet:import-dashboard -->
+
 ## Included dashboards
 
 <!-- section-brief

package/templates/docs/datasource/docs/troubleshooting.md

@@ -40,7 +40,9 @@ Open each H2 with one sentence on when its errors occur. Add an H3 per symptom,
 To see the raw request and response for a panel, open the panel editor and click **Query inspector**.
 {{#if hasBackend}}
 
-In self-managed Grafana, you can also find more detail in the Grafana server logs:
+<!-- snippet:server-debug-logs -->
+
+In self-managed Grafana, the Grafana server logs show more detail:
 
 1. Set the log level to `debug` in the Grafana configuration file:
 
@@ -52,6 +54,8 @@ In self-managed Grafana, you can also find more detail in the Grafana server log
 1. Restart Grafana and reproduce the error.
 1. Look for log lines with `logger=plugin.{{{pluginId}}}`.
 1. Set the log level back to `info` when you're done, to keep the logs small.
+
+<!-- /snippet:server-debug-logs -->
 {{/if}}
 
 ## Get additional help

package/templates/docs/panel/docs/AGENTS.md

@@ -92,6 +92,8 @@ To fill a section:
 Briefs are not shown in the preview or the catalog, so a section you haven't written looks like a bare
 heading. `docs:validate` lists every section that still has only its brief.
 
+Text between `<!-- snippet:... -->` and `<!-- /snippet:... -->` markers is maintained by Grafana. Never edit inside it - refer to `snippets.md` in the guides.
+
 ## Validate
 
 ```bash

package/templates/docs/panel/docs/data-formats.md

@@ -24,4 +24,8 @@ To see the data the panel receives, open the panel editor, click **Query inspect
 
 ## Reshape data that doesn't match
 
+<!-- snippet:reshape-with-transformations -->
+
 If a query returns data in a different shape, you can reshape it without changing the query. Select the **Transform data** tab in the panel editor and add a transformation. For more information, refer to [Transform data](https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/transform-data/).
+
+<!-- /snippet:reshape-with-transformations -->

package/templates/docs/panel/docs/examples.md

@@ -4,8 +4,12 @@ description: "Worked examples of the {{{yamlEscape pluginName}}} panel."
 sidebar_position: 4
 ---
 
+<!-- snippet:use-example-json -->
+
 To use an example, open your dashboard and go to **Dashboard settings** > **JSON Model**. Paste the excerpt into the `panels` array and click **Save changes**.
 
+<!-- /snippet:use-example-json -->
+
 <!-- section-brief
 Fill this in: Show concrete examples of {{{pluginName}}} configured for real use cases. When the repo has panels of this plugin's type in `provisioning/dashboards/*.json`, take the examples from those before inventing any. Express each example as a `dashboard.json` panel excerpt: `type` and `options`, plus `fieldConfig` and `targets` when the example depends on them. Leave out `id`, `gridPos`, `pluginVersion`, datasource UIDs and timestamps - they are specific to one dashboard and hide the settings that matter. Pair each example with a screenshot of the rendered visualization. Only use a screenshot that the example's JSON produces: open the image and check that what it shows, such as the legend, the values and the number of series, matches the JSON. If no image matches, leave the example without one and flag it. Don't cut settings from an excerpt that its result depends on, such as some of the overrides behind a screenshot.