Skip to content

Commit 89cd91c

Browse files
urbiz-grafanaurbiz-grafana
authored
docs: Ongoing doc updates (#2781)
1 parent 25c21e0 commit 89cd91c

4 files changed

Lines changed: 42 additions & 19 deletions

File tree

‎docusaurus/docs/reference/metadata.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -170,12 +170,12 @@ Dependency information related to Grafana and other plugins.
170170

171171
**Properties**
172172

173-
| Name | Type | Description | Required |
174-
| ----------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
175-
| **grafanaVersion** | `string` | (Deprecated) Required Grafana version for this plugin, e.g. `6.x.x 7.x.x` to denote plugin requires Grafana v6.x.x or v7.x.x.<br/>Pattern: `^([0-9]+)(\.[0-9x]+)?(\.[0-9x])?$`<br/> | |
176-
| **grafanaDependency** | `string` | Required Grafana version for this plugin. Validated using https://github.com/npm/node-semver.<br/>Pattern: `^(<=\|>=\|<\|>\|=\|~\|\^)?([0-9]+)(\.[0-9x\*]+)?(\.[0-9x\*]+)?(-[0-9A-Za-z-.]+)?(\s(<=\|>=\|<\|=>)?([0-9]+)(\.[0-9x\*]+)?(\.[0-9x\*]+)?(-[0-9A-Za-z-.]+)?)?(\s\\ | \\ | \s(<=\|>=\|<\|>\|=\|~\|\^)?([0-9]+)(\.[0-9x\*]+)?(\.[0-9x\*]+)?(-[0-9A-Za-z-.]+)?(\s(<=\|>=\|<\|=>)?([0-9]+)(\.[0-9x\*]+)?(\.[0-9x\*]+)?(-[0-9A-Za-z-.]+)?)?)\*$`<br/> | ✅ |
177-
| [**plugins**](#dependenciesplugins) | `object[]` | An array of required plugins on which this plugin depends. Only non-core (that is, external plugins) have to be specified in this list.<br/> | |
178-
| [**extensions**](#dependenciesextensions) | `object` | Plugin extensions that this plugin depends on.<br/> | |
173+
| Name | Type | Description | Required |
174+
| ----------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: |
175+
| **grafanaVersion** | `string` | (Deprecated) Required Grafana version for this plugin, e.g. `6.x.x 7.x.x` to denote plugin requires Grafana v6.x.x or v7.x.x.<br/>Pattern: `^([0-9]+)(\.[0-9x]+)?(\.[0-9x])?$`<br/> | |
176+
| **grafanaDependency** | `string` | Required Grafana version for this plugin. Validated using https://github.com/npm/node-semver.<br/>Pattern: `^(<=\|>=\|<\|>\|=\|~\|\^)?([0-9]+)(\.[0-9x\*]+)?(\.[0-9x\*]+)?(-[0-9A-Za-z-.]+)?(\s(<=\|>=\|<\|=>)?([0-9]+)(\.[0-9x\*]+)?(\.[0-9x\*]+)?(-[0-9A-Za-z-.]+)?)?(\s\\\|\\\|\s(<=\|>=\|<\|>\|=\|~\|\^)?([0-9]+)(\.[0-9x\*]+)?(\.[0-9x\*]+)?(-[0-9A-Za-z-.]+)?(\s(<=\|>=\|<\|=>)?([0-9]+)(\.[0-9x\*]+)?(\.[0-9x\*]+)?(-[0-9A-Za-z-.]+)?)?)*$`<br/> | ✅ |
177+
| [**plugins**](#dependenciesplugins) | `object[]` | An array of required plugins on which this plugin depends. Only non-core (that is, external plugins) have to be specified in this list.<br/> | |
178+
| [**extensions**](#dependenciesextensions) | `object` | Plugin extensions that this plugin depends on.<br/> | |
179179

180180
<a name="dependenciesplugins"></a>
181181

@@ -334,12 +334,12 @@ Parameters for the token authentication request.
334334

335335
**Properties**
336336

337-
| Name | Type | Description | Required |
338-
| ----------------- | -------- | ---------------------------------------------------------------------------------------------- | :------: |
339-
| **grant_type** | `string` | OAuth grant type<br/> | |
340-
| **client_id** | `string` | OAuth client ID<br/> | |
341-
| **client_secret** | `string` | OAuth client secret. Usually populated by decrypting the secret from the SecureJson blob.<br/> | |
342-
| **resource** | `string` | OAuth resource<br/> | |
337+
| Name | Type | Description | Required |
338+
| ------------------ | -------- | ---------------------------------------------------------------------------------------------- | :------: |
339+
| **grant\_type** | `string` | OAuth grant type<br/> | |
340+
| **client\_id** | `string` | OAuth client ID<br/> | |
341+
| **client\_secret** | `string` | OAuth client secret. Usually populated by decrypting the secret from the SecureJson blob.<br/> | |
342+
| **resource** | `string` | OAuth resource<br/> | |
343343

344344
<a name="routesjwttokenauth"></a>
345345

@@ -372,11 +372,11 @@ Parameters for the JWT token authentication request.
372372

373373
**Properties**
374374

375-
| Name | Type | Description | Required |
376-
| ---------------- | -------- | ----------- | :------: |
377-
| **token_uri** | `string` | | |
378-
| **client_email** | `string` | | |
379-
| **private_key** | `string` | | |
375+
| Name | Type | Description | Required |
376+
| ----------------- | -------- | ----------- | :------: |
377+
| **token\_uri** | `string` | | |
378+
| **client\_email** | `string` | | |
379+
| **private\_key** | `string` | | |
380380

381381
<a name="routesurlparams"></a>
382382

‎docusaurus/docs/resources.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ sidebar_position: 70
1919
Here are some additional resources related to plugins that may make your plugin development journey easier.
2020

2121
- [Grafana developer portal](https://grafana.com/developers/) - Home to plugin documentation, data structure documentation, React components library, and more.
22-
- [Grafana API reference](https://grafana.com/docs/grafana/latest/developers/http_api/) - The backend HTTP API for Grafana.
22+
- [Grafana developer resources](https://grafana.com/docs/grafana/latest/developer-resources/) - Additional resources for developers and contributors.
23+
- [Grafana API reference](https://grafana.com/docs/grafana/latest/developer-resources/api-reference/http-api/) - The backend HTTP API for Grafana.
2324
- [Grafana Community](https://community.grafana.com/) - Official Grafana Labs forums on plugin development and other topics.
2425
- [Community Slack](https://slack.grafana.com/) - Discuss plugin development at the Grafana Labs community Slack.
2526
- [Grafana Labs blog](https://grafana.com/blog/) - The latest news, features, and how-to's.
2627
- [Grafana plugins catalog](https://grafana.com/grafana/plugins/) - Find examples of many popular plugins.
27-
- [Contributor guide](https://grafana.com/docs/grafana/latest/developers/contribute/) - Developer guide for contributing to Grafana.
2828

‎docusaurus/docs/whats-new.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,24 @@ sidebar_position: 11
1414

1515
# What's new?
1616

17+
**For the latest plugin announcements refer to the [Grafana Plugin Development board](https://community.grafana.com/c/plugin-development/plugin-announcements/47) in the Community forum.**
18+
19+
## June 2026
20+
21+
To help improve the security and integrity of your projects, Grafana now requires all commits submitted to any Grafana repository to have a valid signature in order to be merged. Refer to the [Signed Commits Mandatory for All Grafana Repositories](https://community.grafana.com/t/action-required-signed-commits-mandatory-for-all-grafana-repositories/163404) blog post for more information.
22+
23+
## April 2026
24+
25+
**You can now monetize your plugin with the Grafana Marketplace**, an optional path for plugin developers, independent software vendors, and partners to sell and distribute commercial plugins through the Grafana plugin catalog.
26+
27+
Marketplace plugins can be proprietary and are published in the Grafana Catalog with a Marketplace label, subject to the approval and discretion of Grafana Labs. Paid Marketplace plugins can help you fund ongoing development, maintenance, updates, and support.
28+
29+
For more background, refer to the [Grafana Marketplace pilot](https://grafana.com/blog/grafana-marketplace-pilot/) announcement.
30+
31+
## February 2026
32+
33+
[`config.panels`](https://community.grafana.com/t/deprecating-config-panels-in-grafana-runtime-package/161606) and [`config.apps`](https://community.grafana.com/t/deprecating-config-apps-in-grafana-runtime-package/161001) have been deprecated in the `@grafana/runtime` package.
34+
1735
## October 2025
1836

1937
Find the whole letter at [Grafana Developer Newsletter - October 2025](https://community.grafana.com/t/grafana-developer-newsletter-october-2025/159137).

‎docusaurus/website/scripts/generate-markdown.sh‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ fi
1919
# Generate markdown file
2020
npx --yes jsonschema2mk --partials "$PARTIALS" --schema "$INPUT_FILE" > "$OUTPUT_FILE"
2121

22+
# jsonschema2mk escapes "|" as "\|" but leaves regex patterns' own backslashes in place,
23+
# so "\|" in a schema pattern becomes "\\|" - an escaped backslash followed by a bare pipe
24+
# that splits GFM table cells and breaks the MDX build. Add a backslash to keep the pipe escaped.
25+
perl -i -pe 's/\\\\\|/\\\\\\|/g' "$OUTPUT_FILE"
26+
2227
# Prettify the markdown file
2328
npx prettier --write "$OUTPUT_FILE"
2429

0 commit comments

Comments
 (0)