apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
25196 Commits
2186 Branches
608 Tags
1.9 GiB
Tag: Branch: Tree: 37a2ac20c3
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '37a2ac20c3'
${ noResults }
grafana/docs/sources/developers/plugins/metadata.md

37 lines
3.2 KiB
Raw Normal View History Unescape

Docs for developing plugins (#7475) * docs(plugins): new developing plugins section Creates new section called Developing Plugins in the plugin section of the docs. 1. Some changes to the Development guide page 2. Converted defaults/editor mode blog post to new page 3. Converted snapshots blog post to new page 4. Adds new code styleguide page 5. Updates to apps and datasources pages 6. Adds plugin.json schema * docs(links): fixes broken links Fixes broken links to other pages as well as broken image links.
9 years ago
+++
Restructure plugin docs (#24381)
5 years ago
title = "plugin.json"
Docs for developing plugins (#7475) * docs(plugins): new developing plugins section Creates new section called Developing Plugins in the plugin section of the docs. 1. Some changes to the Development guide page 2. Converted defaults/editor mode blog post to new page 3. Converted snapshots blog post to new page 4. Adds new code styleguide page 5. Updates to apps and datasources pages 6. Adds plugin.json schema * docs(links): fixes broken links Fixes broken links to other pages as well as broken image links.
9 years ago
keywords = ["grafana", "plugins", "documentation"]
type = "docs"
Restructure plugin docs (#24381)
5 years ago
aliases = ["/docs/grafana/latest/plugins/developing/plugin.json/"]
Docs for developing plugins (#7475) * docs(plugins): new developing plugins section Creates new section called Developing Plugins in the plugin section of the docs. 1. Some changes to the Development guide page 2. Converted defaults/editor mode blog post to new page 3. Converted snapshots blog post to new page 4. Adds new code styleguide page 5. Updates to apps and datasources pages 6. Adds plugin.json schema * docs(links): fixes broken links Fixes broken links to other pages as well as broken image links.
9 years ago
+++
Restructure plugin docs (#24381)
5 years ago
# plugin.json
Docs for developing plugins (#7475) * docs(plugins): new developing plugins section Creates new section called Developing Plugins in the plugin section of the docs. 1. Some changes to the Development guide page 2. Converted defaults/editor mode blog post to new page 3. Converted snapshots blog post to new page 4. Adds new code styleguide page 5. Updates to apps and datasources pages 6. Adds plugin.json schema * docs(links): fixes broken links Fixes broken links to other pages as well as broken image links.
9 years ago
The plugin.json file is mandatory for all plugins. When Grafana starts it will scan the plugin folders and mount every folder that contains a plugin.json file unless the folder contains a subfolder named `dist`. In that case grafana will mount the `dist` folder instead.
Restructure plugin docs (#24381)
5 years ago
## Schema
Docs for developing plugins (#7475) * docs(plugins): new developing plugins section Creates new section called Developing Plugins in the plugin section of the docs. 1. Some changes to the Development guide page 2. Converted defaults/editor mode blog post to new page 3. Converted snapshots blog post to new page 4. Adds new code styleguide page 5. Updates to apps and datasources pages 6. Adds plugin.json schema * docs(links): fixes broken links Fixes broken links to other pages as well as broken image links.
9 years ago
Docs: Plugin.json: Fix property descriptions, add missing properties, add example (#22281) * Fix property descriptions, add missing properties Fixes incorrect property descriptions, adds missing properties, and adds an up-to-date example. * Update logo descriptions Updates the "large" and "small" logo descriptions to specify SVG image type requirement, and that they may be identical * Update docs/sources/plugins/developing/plugin.json.md
5 years ago
| Property | Description |
Restructure plugin docs (#24381)
5 years ago
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------|
| id | Unique name of the plugin. |
Docs: Plugin.json: Fix property descriptions, add missing properties, add example (#22281) * Fix property descriptions, add missing properties Fixes incorrect property descriptions, adds missing properties, and adds an up-to-date example. * Update logo descriptions Updates the "large" and "small" logo descriptions to specify SVG image type requirement, and that they may be identical * Update docs/sources/plugins/developing/plugin.json.md
5 years ago
| type | One of `app`, `datasource`, `panel` |
| name | Human-readable name of the plugin |
| dependencies.grafanaVersion | Required Grafana version for this plugin |
| dependencies.plugins | An array of required plugins on which this plugin depends |
| info.author.name | Author's name |
| info.author.url | Link to author's website |
| info.description | Description of plugin. Used for search on grafana.com |
| info.keywords | Array of plugin keywords. Used for search on grafana.com |
| info.links | An array of link objects to be displayed on this plugin's project page in the form `{name: 'foo', url: 'http://example.com'}` |
Restructure plugin docs (#24381)
5 years ago
| info.logos.small | Link to the "small" version of the plugin logo, which must be an SVG image. "Large" and "small" logos can be the same image. |
| info.logos.large | Link to the "large" version of the plugin logo, which must be an SVG image. "Large" and "small" logos can be the same image. |
Docs: Plugin.json: Fix property descriptions, add missing properties, add example (#22281) * Fix property descriptions, add missing properties Fixes incorrect property descriptions, adds missing properties, and adds an up-to-date example. * Update logo descriptions Updates the "large" and "small" logo descriptions to specify SVG image type requirement, and that they may be identical * Update docs/sources/plugins/developing/plugin.json.md
5 years ago
| info.screenshots | An array of screenshot objects in the form `{name: 'bar', path: 'img/screenshot.png'}` |
| info.updated | Date when this plugin was built. Use `%TODAY%` for Grafana to autopopulate this value. |
Restructure plugin docs (#24381)
5 years ago
| info.version | Project version of this commit. Use `%VERSION%` for Grafana to autopopulate this value. |
Docs: Plugin.json: Fix property descriptions, add missing properties, add example (#22281) * Fix property descriptions, add missing properties Fixes incorrect property descriptions, adds missing properties, and adds an up-to-date example. * Update logo descriptions Updates the "large" and "small" logo descriptions to specify SVG image type requirement, and that they may be identical * Update docs/sources/plugins/developing/plugin.json.md
5 years ago
## Plugin.json Example
Here's an example of an up-to-date plugin.json file:
https://github.com/grafana/clock-panel/blob/master/src/plugin.json