Docs: Sync master docs against next version (#32602)

Co-authored-by: Robby Milo <robbymilo@gmail.com>
This commit is contained in:
Torkel Ödegaard 2021-04-12 09:42:10 +02:00 committed by GitHub
parent 7b23ed728f
commit 9873809547
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
193 changed files with 219 additions and 219 deletions

View File

@ -36,7 +36,7 @@ jobs:
host: github.com
github_pat: '${{ secrets.GH_BOT_ACCESS_TOKEN }}'
source_folder: docs/sources
target_folder: content/docs/grafana/latest
target_folder: content/docs/grafana/next
allow_no_changes: 'true'
- shell: bash
run: |

View File

@ -1,7 +1,7 @@
.PHONY: pull docs docs-quick docs-no-pull docs-test docs-local-static
IMAGE = grafana/grafana-docs-dev:latest
CONTENT_PATH = /hugo/content/docs/grafana/latest
CONTENT_PATH = /hugo/content/docs/grafana/next
LOCAL_STATIC_PATH = ../../website/static
PORT = 3002:3002
@ -12,7 +12,7 @@ docs: pull
docker run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE)
docs-quick: pull
docker run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) /bin/bash -c "ln -s /frontend-docs/packages_api /hugo/content/docs/grafana/latest/packages_api && hugo server -p 3002 -D --bind 0.0.0.0 --environment=quick"
docker run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE) /bin/bash -c "ln -s /frontend-docs/packages_api /hugo/content/docs/grafana/next/packages_api && hugo server -p 3002 -D --bind 0.0.0.0 --environment=quick"
docs-no-pull:
docker run -v $(shell pwd)/sources:$(CONTENT_PATH):Z -p $(PORT) --rm -it $(IMAGE)

View File

@ -10,7 +10,7 @@ Yarn >= 1.22.4
## Build the doc site
1. On the command line, first change to the docs folder: `cd docs`.
1. Run `make docs-quick`. This launches a preview of the website with the current grafana docs at `http://localhost:3002/docs/grafana/latest/` which will refresh automatically when changes are made to content in the `sources` directory.
1. Run `make docs-quick`. This launches a preview of the website with the current grafana docs at `http://localhost:3002/docs/grafana/next/` which will refresh automatically when changes are made to content in the `sources` directory.
If you have the grafana/website repo checked out in the same directory as the grafana repo, then you can run `make docs-local-static` to use local assets (such as images).

View File

@ -2,7 +2,7 @@
title = "Grafana documentation"
description = "Guides, Installation and Feature Documentation"
keywords = ["grafana", "installation", "documentation"]
aliases = ["/docs/grafana/v1.1", "/docs/grafana/latest/guides/reference/admin", "/docs/grafana/v3.1"]
aliases = ["/docs/grafana/v1.1", "/docs/grafana/next/guides/reference/admin", "/docs/grafana/v3.1"]
+++
# Grafana documentation

View File

@ -2,7 +2,7 @@
title = "Configuration"
description = "Configuration documentation"
keywords = ["grafana", "configuration", "documentation"]
aliases = ["/docs/grafana/latest/installation/configuration/"]
aliases = ["/docs/grafana/next/installation/configuration/"]
weight = 150
+++
@ -168,7 +168,7 @@ Override log path using the command line argument `cfg:default.paths.logs`:
### plugins
Directory where Grafana automatically scans and looks for plugins. Manually or automatically install any [plugins](https://grafana.com/docs/grafana/latest/plugins/installation/) here.
Directory where Grafana automatically scans and looks for plugins. Manually or automatically install any [plugins](https://grafana.com/docs/grafana/next/plugins/installation/) here.
**macOS:** By default, the Mac plugin location is: `/usr/local/var/lib/grafana/plugins`.

View File

@ -2,7 +2,7 @@
title = "Configure Grafana Docker image"
description = "Guide for configuring the Grafana Docker image"
keywords = ["grafana", "configuration", "documentation", "docker"]
aliases = ["/docs/grafana/latest/installation/configure-docker/"]
aliases = ["/docs/grafana/next/installation/configure-docker/"]
weight = 200
+++

View File

@ -1,6 +1,6 @@
+++
title = "Preferences"
aliases =["/docs/grafana/latest/administration/preferences.md"]
aliases =["/docs/grafana/next/administration/preferences.md"]
weight = 50
+++

View File

@ -2,7 +2,7 @@
title = "Change home dashboard"
description = "How to replace the default home dashboard"
keywords = ["grafana", "configuration", "documentation", "home"]
aliases = ["/docs/grafana/latest/administration/change-home-dashboard/"]
aliases = ["/docs/grafana/next/administration/change-home-dashboard/"]
weight = 300
+++

View File

@ -2,7 +2,7 @@
title = "Provisioning"
description = ""
keywords = ["grafana", "provisioning"]
aliases = ["/docs/grafana/latest/installation/provisioning"]
aliases = ["/docs/grafana/next/installation/provisioning"]
weight = 800
+++

View File

@ -2,7 +2,7 @@
title = "Security"
description = "Security Docs"
keywords = ["grafana", "security", "documentation"]
aliases = ["/docs/grafana/latest/installation/security/"]
aliases = ["/docs/grafana/next/installation/security/"]
weight = 500
+++

View File

@ -1,7 +1,7 @@
+++
title = "Set up Grafana for high availability"
keywords = ["grafana", "tutorials", "HA", "high availability"]
aliases = ["/docs/grafana/latest/tutorials/ha_setup/"]
aliases = ["/docs/grafana/next/tutorials/ha_setup/"]
weight = 1200
+++
@ -22,7 +22,7 @@ Grafana will now persist all long term data in the database. How to configure th
## Alerting
Currently alerting supports a limited form of high availability. Since v4.2.0, [alert notifications](https://grafana.com/docs/grafana/latest/alerting/notifications/) are deduped when running multiple servers. This means all alerts are executed on every server but alert notifications are only sent once per alert. Grafana does not support load distribution between servers.
Currently alerting supports a limited form of high availability. Since v4.2.0, [alert notifications](https://grafana.com/docs/grafana/next/alerting/notifications/) are deduped when running multiple servers. This means all alerts are executed on every server but alert notifications are only sent once per alert. Grafana does not support load distribution between servers.
## User sessions

View File

@ -2,7 +2,7 @@
title = "Internal Grafana metrics"
description = "Internal metrics exposed by Grafana"
keywords = ["grafana", "metrics", "internal metrics"]
aliases = ["/docs/grafana/latest/admin/metrics/"]
aliases = ["/docs/grafana/next/admin/metrics/"]
weight = 200
+++

View File

@ -2,7 +2,7 @@
title = "View server settings"
description = "How to view server settings in the Grafana UI"
keywords = ["grafana", "configuration", "server", "settings"]
aliases = ["/docs/grafana/latest/admin/view-server-settings/"]
aliases = ["/docs/grafana/next/admin/view-server-settings/"]
weight = 300
+++

View File

@ -1,7 +1,7 @@
+++
title = "View server stats"
keywords = ["grafana", "server", "statistics"]
aliases = ["/docs/grafana/latest/admin/view-server-stats/"]
aliases = ["/docs/grafana/next/admin/view-server-stats/"]
weight = 400
+++

View File

@ -1,6 +1,6 @@
+++
title = "Alerts"
aliases = ["/docs/grafana/latest/alerting/rules/", "/docs/grafana/latest/alerting/metrics/"]
aliases = ["/docs/grafana/next/alerting/rules/", "/docs/grafana/next/alerting/metrics/"]
weight = 110
+++

View File

@ -2,7 +2,7 @@
title = "Auth Proxy"
description = "Grafana Auth Proxy Guide "
keywords = ["grafana", "configuration", "documentation", "proxy"]
aliases = ["/docs/grafana/latest/tutorials/authproxy/"]
aliases = ["/docs/grafana/next/tutorials/authproxy/"]
weight = 200
+++

View File

@ -2,7 +2,7 @@
title = "LDAP Authentication"
description = "Grafana LDAP Authentication Guide "
keywords = ["grafana", "configuration", "documentation", "ldap", "active directory"]
aliases = ["/docs/grafana/latest/installation/ldap/"]
aliases = ["/docs/grafana/next/installation/ldap/"]
weight = 300
+++

View File

@ -2,7 +2,7 @@
title = "SAML Authentication"
description = "Grafana SAML Authentication"
keywords = ["grafana", "saml", "documentation", "saml-auth"]
aliases = ["/docs/grafana/latest/auth/saml/"]
aliases = ["/docs/grafana/next/auth/saml/"]
weight = 1100
+++

View File

@ -2,7 +2,7 @@
title = "Team Sync"
description = "Grafana Team Sync"
keywords = ["grafana", "auth", "documentation"]
aliases = ["/docs/grafana/latest/auth/saml/"]
aliases = ["/docs/grafana/next/auth/saml/"]
weight = 1200
+++

View File

@ -2,7 +2,7 @@
title = "Glossary"
description = "Grafana glossary"
keywords = ["grafana", "intro", "glossary", "dictionary"]
aliases = ["/docs/grafana/latest/guides/glossary", "/docs/grafana/latest/getting-started/glossary"]
aliases = ["/docs/grafana/next/guides/glossary", "/docs/grafana/next/getting-started/glossary"]
weight = 800
+++
@ -32,7 +32,7 @@ This topic lists words and abbreviations that are commonly used in the Grafana d
<tr>
<td style="vertical-align: top">Explore</td>
<td>
Explore allows a user to focus on building a query. Users can refine the query to return the expected metrics before building a dashboard. For more information, refer to the <a href="https://grafana.com/docs/grafana/latest/explore">Explore</a> topic.
Explore allows a user to focus on building a query. Users can refine the query to return the expected metrics before building a dashboard. For more information, refer to the <a href="https://grafana.com/docs/grafana/next/explore">Explore</a> topic.
</td>
</tr>
<tr>
@ -109,7 +109,7 @@ This topic lists words and abbreviations that are commonly used in the Grafana d
<tr>
<td style="vertical-align: top">Transformation</td>
<td>
Transformations process the result set of a query before its passed on for visualization. For more information, refer to the <a href="https://grafana.com/docs/grafana/latest/panels/transformations">Transformations overview</a> topic.
Transformations process the result set of a query before its passed on for visualization. For more information, refer to the <a href="https://grafana.com/docs/grafana/next/panels/transformations">Transformations overview</a> topic.
</td>
</tr>
<tr>

View File

@ -2,7 +2,7 @@
title = "Time series dimensions"
description = "time series dimensions"
keywords = ["grafana", "intro", "guide", "concepts", "timeseries", "labels"]
aliases = ["/docs/grafana/latest/guides/timeseries-dimensions", "/docs/grafana/latest/getting-started/timeseries-dimensions"]
aliases = ["/docs/grafana/next/guides/timeseries-dimensions", "/docs/grafana/next/getting-started/timeseries-dimensions"]
weight = 600
+++

View File

@ -2,7 +2,7 @@
title = "Time series"
description = "Introduction to time series"
keywords = ["grafana", "intro", "guide", "concepts", "timeseries"]
aliases = ["/docs/grafana/latest/guides/timeseries", "/docs/grafana/latest/getting-started/timeseries"]
aliases = ["/docs/grafana/next/guides/timeseries", "/docs/grafana/next/getting-started/timeseries"]
weight = 500
+++

View File

@ -2,7 +2,7 @@
title = "Common observability strategies"
description = "Common observability strategies"
keywords = ["grafana", "intro", "guide", "concepts", "methods"]
aliases = ["/docs/grafana/latest/getting-started/strategies/"]
aliases = ["/docs/grafana/next/getting-started/strategies/"]
weight = 300
+++

View File

@ -1,6 +1,6 @@
+++
title = "Dashboards"
aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"]
aliases = ["/docs/grafana/next/features/dashboard/dashboards/"]
weight = 80
+++

View File

@ -1,7 +1,7 @@
+++
title = "Annotations"
keywords = ["grafana", "annotations", "documentation", "guide"]
aliases = ["/docs/grafana/latest/reference/annotations/"]
aliases = ["/docs/grafana/next/reference/annotations/"]
weight = 2
+++

View File

@ -1,7 +1,7 @@
+++
title = "Dashboard Folders"
keywords = ["grafana", "dashboard", "dashboard folders", "folder", "folders", "documentation", "guide"]
aliases = ["/docs/grafana/latest/reference/dashboard_folders/"]
aliases = ["/docs/grafana/next/reference/dashboard_folders/"]
weight = 3
+++

View File

@ -1,7 +1,7 @@
+++
title = "Dashboard Version History"
keywords = ["grafana", "dashboard", "documentation", "version", "history"]
aliases = ["/docs/grafana/latest/reference/dashboard_history/"]
aliases = ["/docs/grafana/next/reference/dashboard_history/"]
weight = 100
+++

View File

@ -1,7 +1,7 @@
+++
title = "Export and import"
keywords = ["grafana", "dashboard", "documentation", "export", "import"]
aliases = ["/docs/grafana/latest/reference/export_import/"]
aliases = ["/docs/grafana/next/reference/export_import/"]
weight = 800
+++

View File

@ -1,7 +1,7 @@
+++
title = "JSON model"
keywords = ["grafana", "dashboard", "documentation", "json", "model"]
aliases = ["/docs/grafana/latest/reference/dashboard/"]
aliases = ["/docs/grafana/next/reference/dashboard/"]
weight = 1200
+++

View File

@ -1,7 +1,7 @@
+++
title = "Playlist"
keywords = ["grafana", "dashboard", "documentation", "playlist"]
aliases = ["/docs/grafana/latest/reference/playlist/"]
aliases = ["/docs/grafana/next/reference/playlist/"]
weight = 4
+++

View File

@ -2,7 +2,7 @@
title = "Reporting"
description = ""
keywords = ["grafana", "reporting"]
aliases = ["/docs/grafana/latest/administration/reports"]
aliases = ["/docs/grafana/next/administration/reports"]
weight = 8
+++

View File

@ -1,7 +1,7 @@
+++
title = "Scripted dashboards"
keywords = ["grafana", "dashboard", "documentation", "scripted"]
aliases = ["/docs/grafana/latest/reference/scripting/"]
aliases = ["/docs/grafana/next/reference/scripting/"]
weight = 1500
+++

View File

@ -1,7 +1,7 @@
+++
title = "Search"
keywords = ["grafana", "dashboard", "documentation", "search"]
aliases =["/docs/grafana/latest/reference/search/"]
aliases =["/docs/grafana/next/reference/search/"]
weight = 5
+++

View File

@ -1,7 +1,7 @@
+++
title = "Time range controls"
keywords = ["grafana", "dashboard", "documentation", "time range"]
aliases = ["/docs/grafana/latest/reference/timerange/"]
aliases = ["/docs/grafana/next/reference/timerange/"]
weight = 7
+++

View File

@ -1,6 +1,6 @@
+++
title = "Data sources"
aliases = ["/docs/grafana/latest/datasources/overview/"]
aliases = ["/docs/grafana/next/datasources/overview/"]
weight = 60
+++

View File

@ -1,6 +1,6 @@
+++
title = "Add data source"
aliases = ["/docs/grafana/latest/features/datasources/add-a-data-source/"]
aliases = ["/docs/grafana/next/features/datasources/add-a-data-source/"]
weight = 100
+++

View File

@ -2,7 +2,7 @@
title = "Azure Monitor"
description = "Guide for using Azure Monitor in Grafana"
keywords = ["grafana", "microsoft", "azure", "monitor", "application", "insights", "log", "analytics", "guide"]
aliases = ["/docs/grafana/latest/features/datasources/azuremonitor"]
aliases = ["/docs/grafana/next/features/datasources/azuremonitor"]
weight = 300
+++

View File

@ -2,7 +2,7 @@
title = "AWS CloudWatch"
description = "Guide for using CloudWatch in Grafana"
keywords = ["grafana", "cloudwatch", "guide"]
aliases = ["/docs/grafana/latest/datasources/cloudwatch"]
aliases = ["/docs/grafana/next/datasources/cloudwatch"]
weight = 200
+++
@ -375,7 +375,7 @@ Please see the AWS documentation for [Service Quotas](https://docs.aws.amazon.co
## Configure the data source with grafana.ini
In the [Grafana configuration](https://grafana.com/docs/grafana/latest/administration/configuration/#aws) there's an `AWS` section that allows you to customize the data source.
In the [Grafana configuration](https://grafana.com/docs/grafana/next/administration/configuration/#aws) there's an `AWS` section that allows you to customize the data source.
### allowed_auth_providers
@ -387,7 +387,7 @@ Allows you to disable `assume role (ARN)` in the CloudWatch data source. By defa
### list_metrics_page_limit
When a custom namespace is specified in the query editor, the [List Metrics API](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) is used to populate the _Metrics_ field and the _Dimension_ fields. The API is paginated and returns up to 500 results per page. The CloudWatch data source also limits the number of pages to 500. However, you can change this limit using the `list_metrics_page_limit` variable in the [grafana configuration file](https://grafana.com/docs/grafana/latest/administration/configuration/#aws).
When a custom namespace is specified in the query editor, the [List Metrics API](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html) is used to populate the _Metrics_ field and the _Dimension_ fields. The API is paginated and returns up to 500 results per page. The CloudWatch data source also limits the number of pages to 500. However, you can change this limit using the `list_metrics_page_limit` variable in the [grafana configuration file](https://grafana.com/docs/grafana/next/administration/configuration/#aws).
## Configure the data source with provisioning

View File

@ -2,7 +2,7 @@
title = "Elasticsearch"
description = "Guide for using Elasticsearch in Grafana"
keywords = ["grafana", "elasticsearch", "guide"]
aliases = ["/docs/grafana/latest/features/datasources/elasticsearch"]
aliases = ["/docs/grafana/next/features/datasources/elasticsearch"]
weight = 400
+++

View File

@ -2,7 +2,7 @@
title = "Google Cloud Monitoring"
description = "Guide for using Google Cloud Monitoring in Grafana"
keywords = ["grafana", "stackdriver", "google", "guide", "cloud", "monitoring"]
aliases = ["/docs/grafana/latest/features/datasources/stackdriver", "/docs/grafana/latest/datasources/cloudmonitoring/", "/docs/grafana/latest/features/datasources/cloudmonitoring/"]
aliases = ["/docs/grafana/next/features/datasources/stackdriver", "/docs/grafana/next/datasources/cloudmonitoring/", "/docs/grafana/next/features/datasources/cloudmonitoring/"]
weight = 200
+++

View File

@ -2,7 +2,7 @@
title = "Preconfigured dashboards"
description = "Guide for using Google Cloud Monitoring in Grafana"
keywords = ["grafana", "stackdriver", "google", "guide", "cloud", "monitoring"]
aliases = ["/docs/grafana/latest/features/datasources/stackdriver", "/docs/grafana/latest/features/datasources/cloudmonitoring/"]
aliases = ["/docs/grafana/next/features/datasources/stackdriver", "/docs/grafana/next/features/datasources/cloudmonitoring/"]
weight = 10
+++

View File

@ -2,7 +2,7 @@
title = "Graphite"
description = "Guide for using graphite in Grafana"
keywords = ["grafana", "graphite", "guide"]
aliases = ["/docs/grafana/latest/features/datasources/graphite"]
aliases = ["/docs/grafana/next/features/datasources/graphite"]
weight = 600
+++

View File

@ -2,7 +2,7 @@
title = "InfluxDB"
description = "Guide for using InfluxDB in Grafana"
keywords = ["grafana", "influxdb", "guide", "flux"]
aliases = ["/docs/grafana/latest/features/datasources/influxdb"]
aliases = ["/docs/grafana/next/features/datasources/influxdb"]
weight = 700
+++

View File

@ -2,7 +2,7 @@
title = "Jaeger"
description = "Guide for using Jaeger in Grafana"
keywords = ["grafana", "jaeger", "guide", "tracing"]
aliases = ["/docs/grafana/latest/features/datasources/jaeger"]
aliases = ["/docs/grafana/next/features/datasources/jaeger"]
weight = 800
+++

View File

@ -2,7 +2,7 @@
title = "Loki"
description = "Guide for using Loki in Grafana"
keywords = ["grafana", "loki", "logging", "guide"]
aliases = ["/docs/grafana/latest/features/datasources/loki"]
aliases = ["/docs/grafana/next/features/datasources/loki"]
weight = 800
+++

View File

@ -2,7 +2,7 @@
title = "Microsoft SQL Server"
description = "Guide for using Microsoft SQL Server in Grafana"
keywords = ["grafana", "MSSQL", "Microsoft", "SQL", "guide", "Azure SQL Database"]
aliases = ["/docs/grafana/latest/features/datasources/mssql/"]
aliases = ["/docs/grafana/next/features/datasources/mssql/"]
weight = 900
+++

View File

@ -2,7 +2,7 @@
title = "MySQL"
description = "Guide for using MySQL in Grafana"
keywords = ["grafana", "mysql", "guide"]
aliases = ["/docs/grafana/latest/features/datasources/mysql/"]
aliases = ["/docs/grafana/next/features/datasources/mysql/"]
weight = 1000
+++

View File

@ -2,7 +2,7 @@
title = "OpenTSDB"
description = "Guide for using OpenTSDB in Grafana"
keywords = ["grafana", "opentsdb", "guide"]
aliases = ["/docs/grafana/latest/features/opentsdb", "/docs/grafana/latest/features/datasources/opentsdb/"]
aliases = ["/docs/grafana/next/features/opentsdb", "/docs/grafana/next/features/datasources/opentsdb/"]
weight = 1100
+++

View File

@ -2,7 +2,7 @@
title = "PostgreSQL"
description = "Guide for using PostgreSQL in Grafana"
keywords = ["grafana", "postgresql", "guide"]
aliases = ["/docs/grafana/latest/features/datasources/postgres/"]
aliases = ["/docs/grafana/next/features/datasources/postgres/"]
weight = 1200
+++

View File

@ -2,7 +2,7 @@
title = "Prometheus"
description = "Guide for using Prometheus in Grafana"
keywords = ["grafana", "prometheus", "guide"]
aliases = ["/docs/grafana/latest/features/datasources/prometheus"]
aliases = ["/docs/grafana/next/features/datasources/prometheus"]
weight = 1300
+++

View File

@ -2,7 +2,7 @@
title = "Tempo"
description = "High volume, minimal dependency trace storage. OSS tracing solution from Grafana Labs."
keywords = ["grafana", "tempo", "guide", "tracing"]
aliases = ["/docs/grafana/latest/features/datasources/tempo"]
aliases = ["/docs/grafana/next/features/datasources/tempo"]
weight = 1400
+++

View File

@ -1,7 +1,7 @@
+++
title = "TestData"
keywords = ["grafana", "dashboard", "documentation", "panels", "testdata"]
aliases = ["/docs/grafana/latest/features/datasources/testdata"]
aliases = ["/docs/grafana/next/features/datasources/testdata"]
weight = 1500
+++

View File

@ -2,7 +2,7 @@
title = "Zipkin"
description = "Guide for using Zipkin in Grafana"
keywords = ["grafana", "zipkin", "guide", "tracing"]
aliases = ["/docs/grafana/latest/datasources/zipkin"]
aliases = ["/docs/grafana/next/datasources/zipkin"]
weight = 1600
+++

View File

@ -1,6 +1,6 @@
+++
title = "Developers"
aliases = ["/docs/grafana/latest/plugins/developing/"]
aliases = ["/docs/grafana/next/plugins/developing/"]
weight = 190
+++

View File

@ -1,7 +1,7 @@
+++
title = "Contributor License Agreement (CLA)"
description = "Contributor License Agreement (CLA)"
aliases = ["/docs/grafana/latest/project/cla", "docs/contributing/cla.html"]
aliases = ["/docs/grafana/next/project/cla", "docs/contributing/cla.html"]
+++
# Grafana Labs Contributor License Agreement

View File

@ -21,7 +21,7 @@ These resources are useful for all developers.
- [Create a pull request](https://github.com/grafana/grafana/blob/master/contribute/create-pull-request.md): A guide for new contributors about how to create your first Grafana pull request.
- [REST APIs](https://grafana.com/docs/grafana/latest/http_api/) allow you to interact programmatically with the Grafana backend.
- [REST APIs](https://grafana.com/docs/grafana/next/http_api/) allow you to interact programmatically with the Grafana backend.
## Best practices and style

View File

@ -1,6 +1,6 @@
+++
title = "Build a plugin"
aliases = ["/docs/grafana/latest/plugins/developing/"]
aliases = ["/docs/grafana/next/plugins/developing/"]
+++
# Build a plugin

View File

@ -1,6 +1,6 @@
+++
title = "Add authentication for data source plugins"
aliases = ["/docs/grafana/latest/plugins/developing/auth-for-datasources/", "/docs/grafana/latest/developers/plugins/authentication/"]
aliases = ["/docs/grafana/next/plugins/developing/auth-for-datasources/", "/docs/grafana/next/developers/plugins/authentication/"]
+++
# Add authentication for data source plugins
@ -11,7 +11,7 @@ When a user saves a password or any other sensitive data as a data source option
To minimize the amount of sensitive information sent to and from the browser, data source plugins can use the Grafana _data source proxy_. When using the data source proxy, any requests containing sensitive information go through the Grafana server. No sensitive data is sent to the browser after the data is saved.
Some data sources, like [Prometheus](https://grafana.com/docs/grafana/latest/features/datasources/prometheus/) and [InfluxDB](https://grafana.com/docs/grafana/latest/features/datasources/influxdb/), allow users to configure whether to use the data source proxy, through a setting called _access modes_.
Some data sources, like [Prometheus](https://grafana.com/docs/grafana/next/features/datasources/prometheus/) and [InfluxDB](https://grafana.com/docs/grafana/next/features/datasources/influxdb/), allow users to configure whether to use the data source proxy, through a setting called _access modes_.
## Add a proxy route to your plugin

View File

@ -101,4 +101,4 @@ const firstResult = new MutableDataFrame({
});
```
For possible options, refer to [PreferredVisualisationType](https://grafana.com/docs/grafana/latest/packages_api/data/preferredvisualisationtype/).
For possible options, refer to [PreferredVisualisationType](https://grafana.com/docs/grafana/next/packages_api/data/preferredvisualisationtype/).

View File

@ -60,7 +60,7 @@ For data sources, you need to use the [getTemplateSrv]({{< relref "../../package
## Format multi-value variables
When a user selects multiple values for variable, the value of the interpolated variable depends on the [variable format](https://grafana.com/docs/grafana/latest/variables/advanced-variable-format-options/).
When a user selects multiple values for variable, the value of the interpolated variable depends on the [variable format](https://grafana.com/docs/grafana/next/variables/advanced-variable-format-options/).
A data source can define the default format option when no format is specified by adding a third argument to the interpolation function.
@ -76,7 +76,7 @@ Now, when users write `$service`, the query looks like this:
SELECT * FROM services WHERE id IN (admin,auth,billing)
```
For more information on the available variable formats, refer to [Advanced variable format options](https://grafana.com/docs/grafana/latest/variables/advanced-variable-format-options/).
For more information on the available variable formats, refer to [Advanced variable format options](https://grafana.com/docs/grafana/next/variables/advanced-variable-format-options/).
## Set a variable from your plugin

View File

@ -1,7 +1,7 @@
+++
title = "Backend plugins"
keywords = ["grafana", "plugins", "backend", "plugin", "backend-plugins", "documentation"]
aliases = ["/docs/grafana/latest/plugins/developing/backend-plugins-guide/"]
aliases = ["/docs/grafana/next/plugins/developing/backend-plugins-guide/"]
+++
# Backend plugins
@ -49,7 +49,7 @@ The resources capability allows a backend plugin to handle custom HTTP requests
Examples of use cases for implementing resources:
- Implement a custom data source proxy in case certain authentication/authorization or other requirements are required/needed that are not supported in Grafana's [built-in data proxy](https://grafana.com/docs/grafana/latest/http_api/data_source/#data-source-proxy-calls).
- Implement a custom data source proxy in case certain authentication/authorization or other requirements are required/needed that are not supported in Grafana's [built-in data proxy](https://grafana.com/docs/grafana/next/http_api/data_source/#data-source-proxy-calls).
- Return data or information in a format suitable to use within a data source query editor to provide auto-complete functionality.
- Return static resources, such as images or files.
- Send a command to a device, such as a micro controller or IOT device.

View File

@ -1,6 +1,6 @@
+++
title = "Legacy plugins"
aliases = ["/docs/grafana/latest/plugins/development/", "/docs/grafana/latest/plugins/datasources/", "/docs/grafana/latest/plugins/apps/", "/docs/grafana/latest/plugins/panels/", "/docs/grafana/latest/plugins/developing/development/"]
aliases = ["/docs/grafana/next/plugins/development/", "/docs/grafana/next/plugins/datasources/", "/docs/grafana/next/plugins/apps/", "/docs/grafana/next/plugins/panels/", "/docs/grafana/next/plugins/developing/development/"]
+++
# Legacy plugins

View File

@ -1,7 +1,7 @@
+++
title = "Legacy app plugins"
keywords = ["grafana", "plugins", "documentation"]
aliases = ["/docs/grafana/latest/plugins/developing/apps/"]
aliases = ["/docs/grafana/next/plugins/developing/apps/"]
+++
# Legacy app plugins

View File

@ -1,7 +1,7 @@
+++
title = "Legacy data source plugins"
keywords = ["grafana", "plugins", "documentation"]
aliases = ["/docs/grafana/latest/plugins/developing/datasources/"]
aliases = ["/docs/grafana/next/plugins/developing/datasources/"]
+++
# Legacy data source plugins

View File

@ -1,6 +1,6 @@
+++
title = "Legacy defaults and editor mode"
aliases = ["/docs/grafana/latest/plugins/developing/defaults-and-editor-mode/"]
aliases = ["/docs/grafana/next/plugins/developing/defaults-and-editor-mode/"]
+++
# Legacy defaults and editor mode

View File

@ -1,7 +1,7 @@
+++
title = "Legacy panel plugins"
keywords = ["grafana", "plugins", "panel", "documentation"]
aliases = ["/docs/grafana/latest/plugins/developing/panels/"]
aliases = ["/docs/grafana/next/plugins/developing/panels/"]
+++
# Legacy panel plugins

View File

@ -1,6 +1,6 @@
+++
title = "Legacy review guidelines"
aliases = ["/docs/grafana/latest/plugins/developing/plugin-review-guidelines/"]
aliases = ["/docs/grafana/next/plugins/developing/plugin-review-guidelines/"]
+++
# Legacy review guidelines

View File

@ -1,6 +1,6 @@
+++
title = "Legacy snapshot mode"
aliases = ["/docs/grafana/latest/plugins/developing/snapshot-mode/"]
aliases = ["/docs/grafana/next/plugins/developing/snapshot-mode/"]
+++
# Legacy snapshot mode

View File

@ -1,6 +1,6 @@
+++
title = "Legacy code style guide"
aliases = ["/docs/grafana/latest/plugins/developing/code-styleguide/"]
aliases = ["/docs/grafana/next/plugins/developing/code-styleguide/"]
+++
# Legacy code style guide

View File

@ -4,7 +4,7 @@
# -------------------------------------------------------------------------
title = "plugin.json"
keywords = ["grafana", "plugins", "documentation"]
aliases = ["/docs/grafana/latest/plugins/developing/plugin.json/"]
aliases = ["/docs/grafana/next/plugins/developing/plugin.json/"]
+++
# plugin.json
@ -33,7 +33,7 @@ The plugin.json file is required for all plugins. When Grafana starts, it scans
| `metrics` | boolean | No | For data source plugins. If the plugin supports metric queries. Used in the Explore feature. |
| `preload` | boolean | No | Initialize plugin on startup. By default, the plugin initializes on first use. |
| `queryOptions` | [object](#queryoptions) | No | For data source plugins. There is a query options section in the plugin's query editor and these options can be turned on if needed. |
| `routes` | [object](#routes)[] | No | For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/). |
| `routes` | [object](#routes)[] | No | For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/next/developers/plugins/authentication/). |
| `skipDataQuery` | boolean | No | For panel plugins. Hides the query editor. |
| `state` | string | No | Marks a plugin as a pre-release. Possible values are: `alpha`, `beta`. |
| `streaming` | boolean | No | For data source plugins. If the plugin supports streaming. |
@ -168,7 +168,7 @@ For data source plugins. There is a query options section in the plugin's query
## routes
For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/).
For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/next/developers/plugins/authentication/).
### Properties

View File

@ -4,7 +4,7 @@
# -------------------------------------------------------------------------
title = "plugin.json"
keywords = ["grafana", "plugins", "documentation"]
aliases = ["/docs/grafana/latest/plugins/developing/plugin.json/"]
aliases = ["/docs/grafana/next/plugins/developing/plugin.json/"]
+++
{{ .Markdown 1 }}

View File

@ -141,9 +141,9 @@ Before 7.0, data source and panel plugins exchanged data using either time serie
Grafana 7.0 is backward compatible with the old data format used in previous versions. Panels and data sources using the old format will still work with plugins using the new data frame format.
The `DataQueryResponse` returned by the `query` method can be either a [LegacyResponseData](https://grafana.com/docs/grafana/latest/packages_api/data/legacyresponsedata/) or a [DataFrame](https://grafana.com/docs/grafana/latest/packages_api/data/dataframe/).
The `DataQueryResponse` returned by the `query` method can be either a [LegacyResponseData](https://grafana.com/docs/grafana/next/packages_api/data/legacyresponsedata/) or a [DataFrame](https://grafana.com/docs/grafana/next/packages_api/data/dataframe/).
The [toDataFrame()](https://grafana.com/docs/grafana/latest/packages_api/data/todataframe/) function converts a legacy response, such as `TimeSeries` or `Table`, to a `DataFrame`. Use it to gradually move your code to the new format.
The [toDataFrame()](https://grafana.com/docs/grafana/next/packages_api/data/todataframe/) function converts a legacy response, such as `TimeSeries` or `Table`, to a `DataFrame`. Use it to gradually move your code to the new format.
```ts
import { toDataFrame } from '@grafana/data';
@ -160,7 +160,7 @@ async query(options: DataQueryRequest<MyQuery>): Promise<DataQueryResponse> {
}
```
For more information, refer to [Data frames](https://grafana.com/docs/grafana/latest/developers/plugins/data-frames/).
For more information, refer to [Data frames](https://grafana.com/docs/grafana/next/developers/plugins/data-frames/).
## Troubleshoot plugin migration

View File

@ -1,7 +1,7 @@
+++
title = "Package a plugin"
type = "docs"
aliases = ["/docs/grafana/latest/developers/plugins/share-a-plugin/"]
aliases = ["/docs/grafana/next/developers/plugins/share-a-plugin/"]
+++
# Package a plugin

View File

@ -322,10 +322,10 @@
},
"routes": {
"type": "array",
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/).",
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/next/developers/plugins/authentication/).",
"items": {
"type": "object",
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/).",
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/next/developers/plugins/authentication/).",
"additionalProperties": false,
"properties": {
"path": {

View File

@ -13,7 +13,7 @@ If your license has expired, most of Grafana keeps working as normal. Some enter
## Update your license
1. Locate your current `license.jwt` file. In a standard installation it is stored inside Grafana's data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration](https://grafana.com/docs/grafana/latest/administration/configuration/).
1. Locate your current `license.jwt` file. In a standard installation it is stored inside Grafana's data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration](https://grafana.com/docs/grafana/next/administration/configuration/).
```ini
[enterprise]

View File

@ -22,7 +22,7 @@ In the context of licensing, each user is classified as either a viewer or an ed
- An editor is a user who has permission to edit and save a dashboard. Examples of editors are as follows:
- Grafana server administrators.
- Users who are assigned an organizational role of Editor or Admin.
- Users that have been granted Admin or Edit permissions at the dashboard or folder level. Refer to [Dashboard and folder permissions](https://grafana.com/docs/grafana/latest/permissions/dashboard-folder-permissions/).
- Users that have been granted Admin or Edit permissions at the dashboard or folder level. Refer to [Dashboard and folder permissions](https://grafana.com/docs/grafana/next/permissions/dashboard-folder-permissions/).
- A viewer is a user with the Viewer role, which does not permit the user to save a dashboard.
Restrictions are applied separately for viewers and editors.
@ -39,7 +39,7 @@ Given a limit of three sessions, the longest inactive session is signed out of w
You can request Grafana Labs to turn on usage billing to allow an unlimited number of active users. When usage billing is enabled, Grafana does not enforce active user limits. Instead, we charge for active users above the limit, according to your customer contract.
Usage billing must be agreed upon with Grafana Labs, and it is only available if Grafana Enterprise is configured to [automatically refresh its license](https://grafana.com/docs/grafana/latest/enterprise/enterprise-configuration/#auto_refresh_license).
Usage billing must be agreed upon with Grafana Labs, and it is only available if Grafana Enterprise is configured to [automatically refresh its license](https://grafana.com/docs/grafana/next/enterprise/enterprise-configuration/#auto_refresh_license).
## Expiration date

View File

@ -2,7 +2,7 @@
title = "Reporting"
description = ""
keywords = ["grafana", "reporting"]
aliases = ["/docs/grafana/latest/administration/reports"]
aliases = ["/docs/grafana/next/administration/reports"]
weight = 400
+++

View File

@ -2,7 +2,7 @@
title = "SAML Authentication"
description = "Grafana SAML Authentication"
keywords = ["grafana", "saml", "documentation", "saml-auth"]
aliases = ["/docs/grafana/latest/auth/saml/"]
aliases = ["/docs/grafana/next/auth/saml/"]
weight = 500
+++

View File

@ -2,7 +2,7 @@
title = "Team sync"
description = "Grafana Team Sync"
keywords = ["grafana", "auth", "documentation"]
aliases = ["/docs/grafana/latest/auth/saml/"]
aliases = ["/docs/grafana/next/auth/saml/"]
weight = 600
+++

View File

@ -2,7 +2,7 @@
title = "Usage insights"
description = "Understand how your Grafana instance is used"
keywords = ["grafana", "usage-insights", "enterprise"]
aliases = ["/docs/grafana/latest/enterprise/usage-insights/"]
aliases = ["/docs/grafana/next/enterprise/usage-insights/"]
weight = 100
+++

View File

@ -2,7 +2,7 @@
title = "Dashboard and data source insights"
description = "Understand how your dashboards and data sources are used"
keywords = ["grafana", "usage-insights", "enterprise"]
aliases = ["/docs/grafana/latest/enterprise/usage-insights/dashboard-datasource-insights.md"]
aliases = ["/docs/grafana/next/enterprise/usage-insights/dashboard-datasource-insights.md"]
weight = 200
+++

View File

@ -2,7 +2,7 @@
title = "Export logs of usage insights"
description = "Export logs of usage insights"
keywords = ["grafana", "export", "usage-insights", "enterprise"]
aliases = ["/docs/grafana/latest/enterprise/usage-insights/export-logs.md"]
aliases = ["/docs/grafana/next/enterprise/usage-insights/export-logs.md"]
weight = 500
+++

View File

@ -2,7 +2,7 @@
title = "Sort dashboards by using insights data"
description = "Sort dashboards by using insights data"
keywords = ["grafana", "search", "sort", "enterprise"]
aliases = ["/docs/grafana/latest/enterprise/usage-insights/improved-search.md"]
aliases = ["/docs/grafana/next/enterprise/usage-insights/improved-search.md"]
weight = 400
+++

View File

@ -2,7 +2,7 @@
title = "Presence indicator"
description = "Know who is looking at the same dashboard as you are"
keywords = ["grafana", "presence-indicator", "enterprise"]
aliases = ["/docs/grafana/latest/enterprise/usage-insights/presence-indicator.md"]
aliases = ["/docs/grafana/next/enterprise/usage-insights/presence-indicator.md"]
weight = 300
+++

View File

@ -2,7 +2,7 @@
title = "White labeling"
description = "Change the look of Grafana to match your corporate brand"
keywords = ["grafana", "white-labeling", "enterprise"]
aliases = ["/docs/grafana/latest/enterprise/white-labeling/"]
aliases = ["/docs/grafana/next/enterprise/white-labeling/"]
weight = 700
+++

View File

@ -1,7 +1,7 @@
+++
title = "Explore"
keywords = ["explore", "loki", "logs"]
aliases = ["/docs/grafana/latest/features/explore/"]
aliases = ["/docs/grafana/next/features/explore/"]
weight = 90
+++
@ -17,7 +17,7 @@ If you just want to explore your data and do not want to create a dashboard, the
## Start exploring
In order to access Explore, you must have an editor or an administrator role. Refer to [Organization roles](https://grafana.com/docs/grafana/latest/permissions/organization_roles/) for more information on what each role has access to.
In order to access Explore, you must have an editor or an administrator role. Refer to [Organization roles](https://grafana.com/docs/grafana/next/permissions/organization_roles/) for more information on what each role has access to.
To access Explore:

View File

@ -97,4 +97,4 @@ Optional fields:
| stackTraces | string[] | List of stack traces associated with the current span. |
| errorIconColor | string | Color of the error icon in case span is tagged with `error: true`. |
For details about the types see [TraceSpanRow](https://grafana.com/docs/grafana/latest/packages_api/data/tracespanrow/), [TraceKeyValuePair](https://grafana.com/docs/grafana/latest/packages_api/data/tracekeyvaluepair/) and [TraceLog](https://grafana.com/docs/grafana/latest/packages_api/data/tracelog/)
For details about the types see [TraceSpanRow](https://grafana.com/docs/grafana/next/packages_api/data/tracespanrow/), [TraceKeyValuePair](https://grafana.com/docs/grafana/next/packages_api/data/tracekeyvaluepair/) and [TraceLog](https://grafana.com/docs/grafana/next/packages_api/data/tracelog/)

View File

@ -1,7 +1,7 @@
+++
title = "Getting started"
weight = 10
aliases = ["/docs/grafana/latest/guides/what-is-grafana"]
aliases = ["/docs/grafana/next/guides/what-is-grafana"]
+++
# Getting started

View File

@ -2,7 +2,7 @@
title = "With Grafana and Prometheus"
description = "Guide for getting started with Grafana"
keywords = ["grafana", "intro", "guide", "started"]
aliases = ["/docs/grafana/latest/guides/gettingstarted","/docs/grafana/latest/guides/getting_started"]
aliases = ["/docs/grafana/next/guides/gettingstarted","/docs/grafana/next/guides/getting_started"]
weight = 300
+++

View File

@ -2,7 +2,7 @@
title = "With Grafana and MS SQL Server"
description = "Guide for getting started with Grafana"
keywords = ["grafana", "intro", "guide", "started", "SQL", "MSSQL"]
aliases = ["/docs/grafana/latest/guides/gettingstarted","/docs/grafana/latest/guides/getting_started"]
aliases = ["/docs/grafana/next/guides/gettingstarted","/docs/grafana/next/guides/getting_started"]
weight = 400
+++

View File

@ -2,7 +2,7 @@
title = "With Grafana"
description = "Guide for getting started with Grafana"
keywords = ["grafana", "intro", "guide", "started"]
aliases = ["/docs/grafana/latest/guides/gettingstarted","/docs/grafana/latest/guides/getting_started"]
aliases = ["/docs/grafana/next/guides/gettingstarted","/docs/grafana/next/guides/getting_started"]
weight = 200
+++

View File

@ -2,7 +2,7 @@
title = "HTTP API"
description = "Grafana HTTP API"
keywords = ["grafana", "http", "documentation", "api", "overview"]
aliases = ["/docs/grafana/latest/overview"]
aliases = ["/docs/grafana/next/overview"]
weight = 170
+++

View File

@ -2,7 +2,7 @@
title = "Admin HTTP API "
description = "Grafana Admin HTTP API"
keywords = ["grafana", "http", "documentation", "api", "admin"]
aliases = ["/docs/grafana/latest/http_api/admin/"]
aliases = ["/docs/grafana/next/http_api/admin/"]
+++
# Admin API
@ -225,7 +225,7 @@ Content-Type: application/json
}
```
Note that `OrgId` is an optional parameter that can be used to assign a new user to a different organization when [auto_assign_org](https://grafana.com/docs/grafana/latest/administration/configuration/#auto-assign-org) is set to `true`.
Note that `OrgId` is an optional parameter that can be used to assign a new user to a different organization when [auto_assign_org](https://grafana.com/docs/grafana/next/administration/configuration/#auto-assign-org) is set to `true`.
**Example Response**:

View File

@ -2,7 +2,7 @@
title = "Alerting HTTP API "
description = "Grafana Alerts HTTP API"
keywords = ["grafana", "http", "documentation", "api", "alerting", "alerts"]
aliases = ["/docs/grafana/latest/http_api/alerting/"]
aliases = ["/docs/grafana/next/http_api/alerting/"]
+++
# Alerting API

View File

@ -2,7 +2,7 @@
title = "Annotations HTTP API "
description = "Grafana Annotations HTTP API"
keywords = ["grafana", "http", "documentation", "api", "annotation", "annotations", "comment"]
aliases = ["/docs/grafana/latest/http_api/annotations/"]
aliases = ["/docs/grafana/next/http_api/annotations/"]
+++
# Annotations resources / actions

View File

@ -2,7 +2,7 @@
title = "Authentication HTTP API "
description = "Grafana Authentication HTTP API"
keywords = ["grafana", "http", "documentation", "api", "authentication"]
aliases = ["/docs/grafana/latest/http_api/authentication/"]
aliases = ["/docs/grafana/next/http_api/authentication/"]
+++
# Authentication API

View File

@ -1,7 +1,7 @@
+++
title = "API Tutorial: Create API tokens and dashboards for an organization"
keywords = ["grafana", "tutorials", "API", "Token", "Org", "Organization"]
aliases =["/docs/grafana/latest/tutorials/api_org_token_howto/"]
aliases =["/docs/grafana/next/tutorials/api_org_token_howto/"]
weight = 150
+++

View File

@ -2,7 +2,7 @@
title = "Dashboard HTTP API "
description = "Grafana Dashboard HTTP API"
keywords = ["grafana", "http", "documentation", "api", "dashboard"]
aliases = ["/docs/grafana/latest/http_api/dashboard/"]
aliases = ["/docs/grafana/next/http_api/dashboard/"]
+++
# Dashboard API

View File

@ -2,7 +2,7 @@
title = "Dashboard Permissions HTTP API "
description = "Grafana Dashboard Permissions HTTP API"
keywords = ["grafana", "http", "documentation", "api", "dashboard", "permission", "permissions", "acl"]
aliases = ["/docs/grafana/latest/http_api/dashboardpermissions/"]
aliases = ["/docs/grafana/next/http_api/dashboardpermissions/"]
+++
# Dashboard Permissions API

View File

@ -2,7 +2,7 @@
title = "Dashboard Versions HTTP API "
description = "Grafana Dashboard Versions HTTP API"
keywords = ["grafana", "http", "documentation", "api", "dashboard", "versions"]
aliases = ["/docs/grafana/latest/http_api/dashboardversions/"]
aliases = ["/docs/grafana/next/http_api/dashboardversions/"]
+++
# Dashboard Versions

Some files were not shown because too many files have changed in this diff Show More