Skip to content

Docs: test-id #2108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Docs: test-id #2108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9f24b27
test-id
urbiz-grafana Sep 8, 2025
fcfa22f
test 2
urbiz-grafana Sep 8, 2025
c4152d5
Sweep
urbiz-grafana Sep 8, 2025
faefe33
Fix?
urbiz-grafana Sep 8, 2025
fe6eaca
Fix?
urbiz-grafana Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docusaurus/docs/key-concepts/plugin-types-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ Grafana plugin development allows for many options depending on the type of user
- **Data-source plugin** - a connection to a new database or other source of data.
- **App plugin** - an integrated out-of-the-box experience.

Refer to [Get started](../get-started.md) for instructions on how to quickly scaffold [each type](../reference/cli-commands.mdx#select-a-plugin-type) of plugin.
Refer to [Get started](../get-started.md) for instructions on how to quickly scaffold [each type](../reference/cli-commands.mdx#cli-commands-select-plugin) of plugin.

HERE

:::note

Expand Down Expand Up @@ -88,7 +90,7 @@ Note that a plugin of type `datasource` must be installed before it can be provi

### Bundling of dashboards

Data-source plugins can [include dashboards](../reference/metadata.md#includes) by referencing dashboard JSON files (including `property` and `type=dashboard`) within the `plugin.json` file. Grafana puts a dashboard in the `General` folder when it is imported.
Data-source plugins can [include dashboards](../reference/metadata.md#metadata-includes) by referencing dashboard JSON files (including `property` and `type=dashboard`) within the `plugin.json` file. Grafana puts a dashboard in the `General` folder when it is imported.

## App plugins

Expand Down Expand Up @@ -122,7 +124,7 @@ Note that the plugin must be installed before provisioning can succeed with a `p

### Bundling of apps

The app plugin type allows you to [nest other plugins inside it](../how-to-guides/app-plugins/work-with-nested-plugins); in other words, to bundle or [include](../reference/metadata.md#includes) multiple plugins in the same package.
The app plugin type allows you to [nest other plugins inside it](../how-to-guides/app-plugins/work-with-nested-plugins); in other words, to bundle or [include](../reference/metadata.md#metadata-includes) multiple plugins in the same package.

### Bundling of dashboards

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/migration-guides/update-from-grafana-versions/v7.x-v8.x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ import { cx, css } from '@emotion/css';

## Update needed for app plugins using dashboards

To make side navigation work properly - app plugins targeting Grafana `8.+` and integrating into the side menu via [addToNav](/reference/metadata.md#includes) property need to adjust their `plugin.json` and all dashboard json files to have a matching `uid`.
To make side navigation work properly - app plugins targeting Grafana `8.+` and integrating into the side menu via [addToNav](/reference/metadata.md#metadata-includes) property need to adjust their `plugin.json` and all dashboard json files to have a matching `uid`.

**`plugin.json`**

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/reference/cli-commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Use the `create-plugin` command to scaffold your plugin.

When running the `create-plugin` command, the following prompts appear:

### Select a plugin type
### Select a plugin type {#cli-commands-select-plugin}

```
? Select a plugin type …
Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/reference/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The `plugin.json` file is required for all plugins. When Grafana starts, it scan
| [**enterpriseFeatures**](#enterprisefeatures) | `object` | Grafana Enterprise specific features<br/> | |
| **executable** | `string` | The first part of the file name of the backend component executable. There can be multiple executables built for different operating system and architecture. Grafana will check for executables named `<executable>_<$GOOS>_<lower case $GOARCH><.exe for Windows>`, e.g. `plugin_linux_amd64`. Combination of $GOOS and $GOARCH can be found here: https://golang.org/doc/install/source#environment.<br/> | |
| **hideFromList** | `boolean` | [internal only] Excludes the plugin from listings in Grafana's UI. Only allowed for `builtIn` plugins.<br/> | |
| [**includes**](#includes) | `object[]` | Resources to include in plugin.<br/> | |
| [**includes**](metadata.md#metadata-includes) | `object[]` | Resources to include in plugin.<br/> | |
| **logs** | `boolean` | For data source plugins, if the plugin supports logs. It may be used to filter logs only features.<br/> | |
| **metrics** | `boolean` | For data source plugins, if the plugin supports metric queries. Used to enable the plugin in the panel editor.<br/> | |
| **multiValueFilterOperators** | `boolean` | For data source plugins, if the plugin supports multi value operators in adhoc filters.<br/> | |
Expand Down Expand Up @@ -226,7 +226,7 @@ Grafana Enterprise specific features

<a name="includes"></a>

## includes\[\]
## includes\[\] {#metadata-includes}

Resources to include in plugin.

Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/tutorials/build-an-app-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Now that you can view your app root page (page one in the example), try making a

## Add a page in the navigation menu

To add pages to the navigation menu under your app menu item, modify the `plugin.json` file's [`includes` section](../reference/metadata.md#includes).
To add pages to the navigation menu under your app menu item, modify the `plugin.json` file's [`includes` section](../reference/metadata.md#metadata-includes).

When you scaffold your plugin, the `create-plugin` tool adds some example pages to the navigation menu. Each example page follows a path such as `/a/%PLUGIN_ID%/PAGE_NAME`. Any requests sent to /a/%PLUGIN_ID%, for example, `/a/myorgid-simple-app/`, are routed to the root page of the app plugin. The root page is a React component that returns the content for a given route.

Expand Down Expand Up @@ -121,7 +121,7 @@ You don't need to register all your pages inside `includes` in your `plugin.json

:::tip

You can limit which users have access to pages in the navigation menu by using the [`role`](/reference/plugin-json#includes) property.
You can limit which users have access to pages in the navigation menu by using the [`role`](/reference/metadata.md#roles) property.

:::

Expand Down
Loading