From abee02dbcd5fc3dae047d45180647f63bb279a29 Mon Sep 17 00:00:00 2001 From: Robby Milo Date: Mon, 9 Nov 2020 21:26:49 +0100 Subject: [PATCH] Docs: updates for file-based menu (#28500) * initial * cleanup * remove bad aliases * cleanup, fix links * add docs-file-based-command * update docs * update readme * fix broken links * fix spelling Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> --- docs/Makefile | 4 +- docs/README.md | 2 +- docs/sources/_index.md | 1 - docs/sources/administration/_index.md | 6 +-- .../administration/change-home-dashboard.md | 17 +++---- .../administration/change-your-password.md | 4 -- docs/sources/administration/cli.md | 3 -- docs/sources/administration/configuration.md | 5 -- .../administration/configure-docker.md | 5 -- .../sources/administration/image_rendering.md | 3 -- .../administration/jaeger-instrumentation.md | 3 -- docs/sources/administration/metrics.md | 9 ++-- docs/sources/administration/preferences.md | 4 -- docs/sources/administration/provisioning.md | 3 -- docs/sources/administration/security.md | 7 +-- .../set-up-for-high-availability.md | 2 - .../administration/view-server-settings.md | 5 -- .../administration/view-server-stats.md | 2 - docs/sources/alerting/_index.md | 4 -- docs/sources/alerting/alerts-overview.md | 6 +-- docs/sources/alerting/create-alerts.md | 5 -- docs/sources/alerting/notifications.md | 5 -- docs/sources/alerting/pause-an-alert-rule.md | 4 -- docs/sources/alerting/troubleshoot-alerts.md | 5 -- docs/sources/alerting/view-alerts.md | 5 -- docs/sources/auth/_index.md | 19 +++----- docs/sources/auth/auth-proxy.md | 5 -- docs/sources/auth/azuread.md | 9 +--- docs/sources/auth/enhanced_ldap.md | 5 -- docs/sources/auth/generic-oauth.md | 11 ++--- docs/sources/auth/github.md | 9 +--- docs/sources/auth/gitlab.md | 9 +--- docs/sources/auth/google.md | 7 +-- docs/sources/auth/grafana.md | 5 -- docs/sources/auth/ldap.md | 22 +-------- docs/sources/auth/okta.md | 5 -- docs/sources/auth/overview.md | 23 ++++------ docs/sources/auth/saml.md | 4 -- docs/sources/auth/team-sync.md | 4 -- docs/sources/best-practices/_index.md | 5 +- .../best-practices-for-creating-dashboards.md | 6 +-- .../best-practices-for-managing-dashboards.md | 6 +-- .../common-observability-strategies.md | 6 +-- .../dashboard-management-maturity-levels.md | 10 ++-- docs/sources/dashboards/_index.md | 7 +-- docs/sources/dashboards/annotations.md | 4 -- docs/sources/dashboards/dashboard_folders.md | 4 -- docs/sources/dashboards/dashboard_history.md | 4 -- docs/sources/dashboards/export-import.md | 5 +- docs/sources/dashboards/json-model.md | 4 -- docs/sources/dashboards/playlist.md | 46 +++++++++---------- docs/sources/dashboards/reporting.md | 3 -- .../sources/dashboards/scripted-dashboards.md | 3 -- docs/sources/dashboards/search.md | 3 -- docs/sources/dashboards/share-dashboard.md | 3 -- docs/sources/dashboards/share-panel.md | 3 -- docs/sources/dashboards/shortcuts.md | 3 -- .../sources/dashboards/time-range-controls.md | 4 -- docs/sources/datasources/_index.md | 7 +-- docs/sources/datasources/add-a-data-source.md | 7 +-- docs/sources/datasources/azuremonitor.md | 4 -- docs/sources/datasources/cloudmonitoring.md | 4 -- docs/sources/datasources/cloudwatch.md | 5 -- docs/sources/datasources/elasticsearch.md | 6 +-- docs/sources/datasources/graphite.md | 5 -- docs/sources/datasources/influxdb.md | 8 +--- docs/sources/datasources/jaeger.md | 4 -- docs/sources/datasources/loki.md | 4 -- docs/sources/datasources/mssql.md | 4 -- docs/sources/datasources/mysql.md | 4 -- docs/sources/datasources/opentsdb.md | 4 -- docs/sources/datasources/postgres.md | 4 -- docs/sources/datasources/prometheus.md | 4 -- docs/sources/datasources/tempo.md | 4 -- docs/sources/datasources/testdata.md | 10 ++-- docs/sources/datasources/zipkin.md | 6 +-- docs/sources/developers/_index.md | 2 +- docs/sources/developers/cla.md | 1 - docs/sources/developers/contribute.md | 1 - docs/sources/developers/plugins/_index.md | 1 - ...-authentication-for-data-source-plugins.md | 1 - .../plugins/add-support-for-annotations.md | 1 - .../add-support-for-explore-queries.md | 1 - .../plugins/add-support-for-variables.md | 1 - .../developers/plugins/backend/_index.md | 1 - .../backend/grafana-plugin-sdk-for-go.md | 1 - .../plugins/backend/plugin-protocol.md | 1 - .../build-a-logs-data-source-plugin.md | 1 - .../build-a-streaming-data-source-plugin.md | 1 - .../sources/developers/plugins/data-frames.md | 1 - .../developers/plugins/error-handling.md | 1 - .../developers/plugins/legacy/_index.md | 1 - .../sources/developers/plugins/legacy/apps.md | 1 - .../developers/plugins/legacy/data-sources.md | 1 - .../legacy/defaults-and-editor-mode.md | 1 - .../developers/plugins/legacy/panels.md | 1 - .../plugins/legacy/review-guidelines.md | 1 - .../plugins/legacy/snapshot-mode.md | 1 - .../developers/plugins/legacy/style-guide.md | 1 - docs/sources/developers/plugins/metadata.md | 1 - .../developers/plugins/metadata.md.tpl | 1 - .../developers/plugins/migration-guide.md | 1 - .../developers/plugins/sign-a-plugin.md | 1 - .../plugins/working-with-data-frames.md | 1 - docs/sources/enterprise/_index.md | 6 +-- docs/sources/enterprise/auditing.md | 3 -- .../enterprise/datasource_permissions.md | 5 -- docs/sources/enterprise/enhanced_ldap.md | 5 -- .../enterprise/enterprise-configuration.md | 5 -- docs/sources/enterprise/export-pdf.md | 3 -- docs/sources/enterprise/license-expiration.md | 3 -- docs/sources/enterprise/reporting.md | 19 ++++---- docs/sources/enterprise/saml.md | 25 ++++------ docs/sources/enterprise/team-sync.md | 4 -- docs/sources/enterprise/usage-insights.md | 6 +-- docs/sources/enterprise/vault.md | 5 +- docs/sources/enterprise/white-labeling.md | 4 -- docs/sources/explore/index.md | 4 -- docs/sources/getting-started/_index.md | 4 -- .../getting-started-prometheus.md | 4 -- .../getting-started/getting-started.md | 6 +-- docs/sources/getting-started/glossary.md | 7 +-- .../getting-started/intro-histograms.md | 4 -- .../getting-started/timeseries-dimensions.md | 5 -- docs/sources/getting-started/timeseries.md | 11 ++--- .../getting-started/what-is-grafana.md | 15 ++---- docs/sources/http_api/_index.md | 6 +-- docs/sources/http_api/admin.md | 4 -- docs/sources/http_api/alerting.md | 4 -- .../alerting_notification_channels.md | 4 -- docs/sources/http_api/annotations.md | 5 -- docs/sources/http_api/auth.md | 4 -- .../http_api/create-api-tokens-for-org.md | 6 +-- docs/sources/http_api/curl-examples.md | 2 - docs/sources/http_api/dashboard.md | 4 -- .../sources/http_api/dashboard_permissions.md | 4 -- docs/sources/http_api/dashboard_versions.md | 4 -- docs/sources/http_api/data_source.md | 4 -- .../http_api/datasource_permissions.md | 4 -- docs/sources/http_api/external_group_sync.md | 4 -- docs/sources/http_api/folder.md | 4 -- .../http_api/folder_dashboard_search.md | 4 -- docs/sources/http_api/folder_permissions.md | 4 -- docs/sources/http_api/org.md | 4 -- docs/sources/http_api/other.md | 4 -- docs/sources/http_api/playlist.md | 5 -- docs/sources/http_api/preferences.md | 4 -- docs/sources/http_api/reporting.md | 4 -- docs/sources/http_api/short_url.md | 4 -- docs/sources/http_api/snapshot.md | 4 -- docs/sources/http_api/team.md | 4 -- docs/sources/http_api/user.md | 4 -- docs/sources/installation/_index.md | 4 -- docs/sources/installation/debian.md | 18 +++----- docs/sources/installation/docker.md | 5 -- docs/sources/installation/mac.md | 5 +- docs/sources/installation/requirements.md | 7 +-- docs/sources/installation/rpm.md | 11 ++--- docs/sources/installation/upgrading.md | 5 -- docs/sources/installation/windows.md | 9 ++-- docs/sources/jsearch.md | 15 ------ docs/sources/linking/_index.md | 5 +- docs/sources/linking/dashboard-links.md | 5 +- docs/sources/linking/data-link-variables.md | 3 +- docs/sources/linking/data-links.md | 5 +- docs/sources/linking/linking-overview.md | 4 -- docs/sources/linking/panel-links.md | 11 ++--- docs/sources/manage-users/_index.md | 6 +-- .../add-or-remove-user-from-team.md | 4 -- .../manage-users/add-or-remove-user.md | 4 -- .../manage-users/create-or-remove-team.md | 4 -- .../manage-users/enable-or-disable-user.md | 4 -- docs/sources/panels/_index.md | 5 +- docs/sources/panels/add-a-panel.md | 5 -- docs/sources/panels/calculations-list.md | 4 -- docs/sources/panels/field-options/_index.md | 2 - .../field-options/configure-all-fields.md | 1 - .../configure-specific-fields.md | 1 - .../field-options/standard-field-options.md | 1 - docs/sources/panels/inspect-panel.md | 14 ++---- docs/sources/panels/panel-editor.md | 3 -- docs/sources/panels/panels-overview.md | 4 -- docs/sources/panels/queries.md | 20 ++++---- docs/sources/panels/share-query-results.md | 4 -- docs/sources/panels/thresholds.md | 8 +--- docs/sources/panels/transformations.md | 4 -- docs/sources/panels/transformations/_index.md | 6 +-- .../transformations/apply-transformations.md | 4 -- .../panels/transformations/types-options.md | 4 -- docs/sources/panels/visualizations/_index.md | 5 +- .../panels/visualizations/alert-list-panel.md | 4 -- .../panels/visualizations/bar-gauge-panel.md | 1 - .../visualizations/dashboard-list-panel.md | 4 -- .../panels/visualizations/gauge-panel.md | 1 - .../panels/visualizations/graph-panel.md | 15 +++--- docs/sources/panels/visualizations/heatmap.md | 4 -- .../panels/visualizations/logs-panel.md | 4 -- .../panels/visualizations/news-panel.md | 4 -- .../panels/visualizations/stat-panel.md | 1 - .../panels/visualizations/table/_index.md | 8 +--- .../table/filter-table-columns.md | 1 - .../table/table-field-options.md | 3 +- .../panels/visualizations/text-panel.md | 6 +-- docs/sources/permissions/_index.md | 4 -- .../dashboard_folder_permissions.md | 5 -- .../permissions/datasource_permissions.md | 5 -- .../sources/permissions/organization_roles.md | 5 -- docs/sources/plugins/_index.md | 6 +-- docs/sources/plugins/installation.md | 3 -- docs/sources/search.md | 10 ---- docs/sources/sharing/{_index => _index.md} | 0 docs/sources/sharing/playlists.md | 46 +++++++++---------- docs/sources/sharing/share-dashboard.md | 3 -- docs/sources/sharing/share-panel.md | 3 -- docs/sources/test.md | 4 -- docs/sources/troubleshooting/_index.md | 4 +- docs/sources/troubleshooting/diagnostics.md | 2 - .../troubleshoot-dashboards.md | 2 - .../troubleshooting/troubleshoot-queries.md | 2 - docs/sources/variables/_index.md | 5 +- .../advanced-variable-format-options.md | 6 +-- .../variables/filter-variables-with-regex.md | 4 -- .../formatting-multi-value-variables.md | 4 -- .../variables/repeat-panels-or-rows.md | 4 -- docs/sources/variables/syntax.md | 8 +--- docs/sources/variables/variable-examples.md | 4 -- .../variables/variable-selection-options.md | 6 +-- .../variables/variable-types/_index.md | 3 -- .../variable-types/add-ad-hoc-filters.md | 4 -- .../variable-types/add-constant-variable.md | 10 ++-- .../variable-types/add-custom-variable.md | 6 +-- .../add-data-source-variable.md | 4 -- .../variable-types/add-interval-variable.md | 4 -- .../variable-types/add-query-variable.md | 8 +--- .../variable-types/add-text-box-variable.md | 6 +-- .../variable-types/chained-variables.md | 10 ++-- .../variable-types/global-variables.md | 6 +-- docs/sources/variables/variable-value-tags.md | 10 ++-- docs/sources/versions.html_fragment | 7 --- docs/sources/whatsnew/_index.md | 4 -- ...hats-new-in-v2.md => whats-new-in-v2-0.md} | 2 +- docs/sources/whatsnew/whats-new-in-v2-1.md | 2 +- docs/sources/whatsnew/whats-new-in-v2-5.md | 2 +- docs/sources/whatsnew/whats-new-in-v2-6.md | 2 +- ...hats-new-in-v3.md => whats-new-in-v3-0.md} | 7 +-- docs/sources/whatsnew/whats-new-in-v3-1.md | 7 +-- ...hats-new-in-v4.md => whats-new-in-v4-0.md} | 7 +-- docs/sources/whatsnew/whats-new-in-v4-1.md | 7 +-- docs/sources/whatsnew/whats-new-in-v4-2.md | 7 +-- docs/sources/whatsnew/whats-new-in-v4-3.md | 7 +-- docs/sources/whatsnew/whats-new-in-v4-4.md | 7 +-- docs/sources/whatsnew/whats-new-in-v4-5.md | 7 +-- docs/sources/whatsnew/whats-new-in-v4-6.md | 7 +-- ...hats-new-in-v5.md => whats-new-in-v5-0.md} | 7 +-- docs/sources/whatsnew/whats-new-in-v5-1.md | 7 +-- docs/sources/whatsnew/whats-new-in-v5-2.md | 7 +-- docs/sources/whatsnew/whats-new-in-v5-3.md | 7 +-- docs/sources/whatsnew/whats-new-in-v5-4.md | 7 +-- docs/sources/whatsnew/whats-new-in-v6-0.md | 7 +-- docs/sources/whatsnew/whats-new-in-v6-1.md | 7 +-- docs/sources/whatsnew/whats-new-in-v6-2.md | 7 +-- docs/sources/whatsnew/whats-new-in-v6-3.md | 7 +-- docs/sources/whatsnew/whats-new-in-v6-4.md | 7 +-- docs/sources/whatsnew/whats-new-in-v6-5.md | 7 +-- docs/sources/whatsnew/whats-new-in-v6-6.md | 11 ++--- docs/sources/whatsnew/whats-new-in-v6-7.md | 13 ++---- docs/sources/whatsnew/whats-new-in-v7-0.md | 9 +--- docs/sources/whatsnew/whats-new-in-v7-1.md | 7 +-- docs/sources/whatsnew/whats-new-in-v7-2.md | 7 +-- docs/sources/whatsnew/whats-new-in-v7-3.md | 31 ++++++------- docs/versions.json | 19 -------- 271 files changed, 260 insertions(+), 1266 deletions(-) delete mode 100644 docs/sources/jsearch.md delete mode 100644 docs/sources/search.md rename docs/sources/sharing/{_index => _index.md} (100%) delete mode 100644 docs/sources/test.md delete mode 100644 docs/sources/versions.html_fragment rename docs/sources/whatsnew/{whats-new-in-v2.md => whats-new-in-v2-0.md} (99%) rename docs/sources/whatsnew/{whats-new-in-v3.md => whats-new-in-v3-0.md} (98%) rename docs/sources/whatsnew/{whats-new-in-v4.md => whats-new-in-v4-0.md} (98%) rename docs/sources/whatsnew/{whats-new-in-v5.md => whats-new-in-v5-0.md} (98%) delete mode 100644 docs/versions.json diff --git a/docs/Makefile b/docs/Makefile index ae035da788fa1..b5e2bcffad851 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,10 +5,10 @@ IMAGE = grafana/grafana-docs-dev:latest docs: docker pull $(IMAGE) docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest -p 3002:3002 --rm -it $(IMAGE) - + docs-no-pull: docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest -p 3002:3002 --rm -it $(IMAGE) docs-test: docker pull $(IMAGE) - docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest --rm -it $(IMAGE) /bin/bash -c 'make prod' + docker run -v $(shell pwd)/sources:/hugo/content/docs/grafana/latest --rm -it $(IMAGE) /bin/bash -c 'make prod' \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 305282120c393..235deb629055f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,7 +24,7 @@ Use the Hugo shortcode [relref](https://gohugo.io/content-management/cross-refer ### Edit the side menu -Edit [sources/menu.yaml](sources/menu.yaml) to make changes to the sidebar. Stop and rerun the `make docs` command for changes to take effect. +The side menu is automatically build from the file structure. Use the [weight](https://gohugo.io/templates/lists/#by-weight) front matter parameter to order pages. ### Add images diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 1420306a66052..072d6814544d8 100755 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -2,7 +2,6 @@ title = "Grafana documentation" description = "Guides, Installation and Feature Documentation" keywords = ["grafana", "installation", "documentation"] -type = "docs" aliases = ["/docs/grafana/v1.1", "/docs/grafana/latest/guides/reference/admin", "/docs/grafana/v3.1"] +++ diff --git a/docs/sources/administration/_index.md b/docs/sources/administration/_index.md index ae8c3bb5da5cf..2138067c5fa08 100644 --- a/docs/sources/administration/_index.md +++ b/docs/sources/administration/_index.md @@ -1,11 +1,7 @@ +++ title = "Administration" description = "Administration" -type = "docs" -[menu.docs] -name = "Administration" -identifier = "admin" -weight = 20 +weight = 40 +++ # Administration diff --git a/docs/sources/administration/change-home-dashboard.md b/docs/sources/administration/change-home-dashboard.md index 643262c5474bc..8e886bb1553d3 100644 --- a/docs/sources/administration/change-home-dashboard.md +++ b/docs/sources/administration/change-home-dashboard.md @@ -2,17 +2,12 @@ title = "Change the default home dashboard" description = "How to replace the default home dashboard" keywords = ["grafana", "configuration", "documentation", "home"] -type = "docs" -[menu.docs] -name = "Home Dashboard" -identifier = "change-home-dashboard" -parent = "admin" weight = 100 +++ # Change the default home dashboard -You can change the default dashboard on the organization, team and user level. The home dashboard you set for the whole organization is the one all users will see by default. The team dashboard applies to all users assigned to the team in Grafana. The team dashboard overrides the organization dashboard settings. Personal dashboard settings override team dashboard settings. +You can change the default dashboard on the organization, team and user level. The home dashboard you set for the whole organization is the one all users will see by default. The team dashboard applies to all users assigned to the team in Grafana. The team dashboard overrides the organization dashboard settings. Personal dashboard settings override team dashboard settings. ## Set the home dashboard for your organization @@ -34,7 +29,7 @@ You can provide your own JSON file to change the home dashboard. No user will be 1. In the **Export** tab, click on **Save to file**. #### Use a JSON file as the home dashboard -1. Save your JSON file somewhere that Grafana can access it, for example, in the Grafana `data` folder of Grafana. +1. Save your JSON file somewhere that Grafana can access it, for example, in the Grafana `data` folder of Grafana. 1. Update your configuration file to set the path to the JSON file. Read how to update this file in the [configuration]({{< relref "./configuration.md">}}) documentation. ```ini [dashboards] @@ -45,14 +40,14 @@ default_home_dashboard_path = data/main-dashboard.json ## Set home dashboard for your team 1. Navigate to the dashboard you want to set as the home dashboard. -1. Star this dashboard by clicking on the star next to the dashboard title. +1. Star this dashboard by clicking on the star next to the dashboard title. 1. On the left menu, hover your cursor over the **Configuration** (gear) icon and then click **Teams**. 1. Click on the team you want to change the home dashboard for and then navigate to the **Settings** tab. -1. In the **Home Dashboard** field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards. +1. In the **Home Dashboard** field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards. ## Set your personal home dashboard 1. Navigate to the dashboard you want to set as the home dashboard. -1. Star this dashboard by clicking on the star next to the dashboard title. +1. Star this dashboard by clicking on the star next to the dashboard title. 1. On the left menu, hover your cursor over your avatar and then click **Preferences**. -1. In the **Home Dashboard** field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards. +1. In the **Home Dashboard** field, select the dashboard you want to use for your home dashboard. Options include all starred dashboards. diff --git a/docs/sources/administration/change-your-password.md b/docs/sources/administration/change-your-password.md index 20776521bf96e..372f0dc10f390 100644 --- a/docs/sources/administration/change-your-password.md +++ b/docs/sources/administration/change-your-password.md @@ -2,10 +2,6 @@ title = "Change your password" description = "How to change your Grafana password" keywords = ["grafana", "password", "change", "preferences"] -type = "docs" -[menu.docs] -identifier = "change-your-password" -parent = "administration" weight = 100 +++ diff --git a/docs/sources/administration/cli.md b/docs/sources/administration/cli.md index f5edd13ce8e2f..c76dd1fadeaf8 100644 --- a/docs/sources/administration/cli.md +++ b/docs/sources/administration/cli.md @@ -2,9 +2,6 @@ title = "Grafana CLI" description = "Guide to using grafana-cli" keywords = ["grafana", "cli", "grafana-cli", "command line interface"] -type = "docs" -[menu.docs] -parent = "admin" weight = 8 +++ diff --git a/docs/sources/administration/configuration.md b/docs/sources/administration/configuration.md index f5653b6a53337..4e2a9b9906a9b 100644 --- a/docs/sources/administration/configuration.md +++ b/docs/sources/administration/configuration.md @@ -2,12 +2,7 @@ title = "Configuration" description = "Configuration documentation" keywords = ["grafana", "configuration", "documentation"] -type = "docs" aliases = ["/docs/grafana/latest/installation/configuration/"] -[menu.docs] -name = "Configuration" -identifier = "config" -parent = "admin" weight = 300 +++ diff --git a/docs/sources/administration/configure-docker.md b/docs/sources/administration/configure-docker.md index 99b95399f9543..5c3fe9c4f8b71 100644 --- a/docs/sources/administration/configure-docker.md +++ b/docs/sources/administration/configure-docker.md @@ -2,12 +2,7 @@ title = "Configure Grafana Docker image" description = "Guide for configuring the Grafana Docker image" keywords = ["grafana", "configuration", "documentation", "docker"] -type = "docs" aliases = ["/docs/grafana/latest/installation/configure-docker/"] -[menu.docs] -name = "Configure Grafana Docker image" -identifier = "configure-docker" -parent = "administration" weight = 400 +++ diff --git a/docs/sources/administration/image_rendering.md b/docs/sources/administration/image_rendering.md index 6c7ba5e9356c5..60d4fdf628a7b 100755 --- a/docs/sources/administration/image_rendering.md +++ b/docs/sources/administration/image_rendering.md @@ -2,9 +2,6 @@ title = "Image rendering" description = "" keywords = ["grafana", "image", "rendering", "plugin"] -type = "docs" -[menu.docs] -parent = "features" weight = 8 +++ diff --git a/docs/sources/administration/jaeger-instrumentation.md b/docs/sources/administration/jaeger-instrumentation.md index 8f4cf64b49734..bc4c61eb85413 100644 --- a/docs/sources/administration/jaeger-instrumentation.md +++ b/docs/sources/administration/jaeger-instrumentation.md @@ -2,9 +2,6 @@ title = "Jaeger instrumentation" description = "Jaeger traces emitted and propagation by Grafana" keywords = ["grafana", "jaeger", "tracing"] -type = "docs" -[menu.docs] -parent = "admin" weight = 9 +++ diff --git a/docs/sources/administration/metrics.md b/docs/sources/administration/metrics.md index b8a87563b01c0..b50ed943c5ffd 100644 --- a/docs/sources/administration/metrics.md +++ b/docs/sources/administration/metrics.md @@ -2,9 +2,6 @@ title = "Internal Grafana metrics" description = "Internal metrics exposed by Grafana" keywords = ["grafana", "metrics", "internal metrics"] -type = "docs" -[menu.docs] -parent = "admin" weight = 8 +++ @@ -29,7 +26,7 @@ When enabled, Grafana exposes a number of metrics, including: These instructions assume you have already added Prometheus as a data source in Grafana. -1. Enable Prometheus to scrape metrics from Grafana. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options: +1. Enable Prometheus to scrape metrics from Grafana. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options: ``` # Metrics available at HTTP API Url /metrics @@ -57,7 +54,7 @@ These instructions assume you have already added Prometheus as a data source in scrape_interval: 15s scrape_timeout: 5s - + static_configs: - targets: ['localhost:3000'] ``` @@ -70,7 +67,7 @@ These instructions assume you have already added Prometheus as a data source in These instructions assume you have already added Graphite as a data source in Grafana. -1. Enable sending metrics to Graphite. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options: +1. Enable sending metrics to Graphite. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options: ``` # Metrics available at HTTP API Url /metrics diff --git a/docs/sources/administration/preferences.md b/docs/sources/administration/preferences.md index 15c5a360b98d1..b2d6a8516c70c 100644 --- a/docs/sources/administration/preferences.md +++ b/docs/sources/administration/preferences.md @@ -2,10 +2,6 @@ title = "Change your preferences" description = "How to change your Grafana preferences" keywords = ["grafana", "profile", "change", "preferences"] -type = "docs" -[menu.docs] -identifier = "preferences" -parent = "administration" weight = 200 +++ diff --git a/docs/sources/administration/provisioning.md b/docs/sources/administration/provisioning.md index 0093bc18f158e..0956c66b17007 100644 --- a/docs/sources/administration/provisioning.md +++ b/docs/sources/administration/provisioning.md @@ -2,10 +2,7 @@ title = "Provisioning" description = "" keywords = ["grafana", "provisioning"] -type = "docs" aliases = ["/docs/grafana/latest/installation/provisioning"] -[menu.docs] -parent = "admin" weight = 8 +++ diff --git a/docs/sources/administration/security.md b/docs/sources/administration/security.md index 247915abc6f2a..22304963f8ccd 100644 --- a/docs/sources/administration/security.md +++ b/docs/sources/administration/security.md @@ -2,12 +2,7 @@ title = "Security" description = "Security Docs" keywords = ["grafana", "security", "documentation"] -type = "docs" aliases = ["/docs/grafana/latest/installation/security/"] -[menu.docs] -name = "Security" -identifier = "security" -parent = "admin" weight = 500 +++ @@ -23,7 +18,7 @@ You can configure Grafana to only allow certain IP addresses or hostnames to be ## Firewall rules -Configure a firewall to restrict Grafana from making network requests to sensitive internal web services. +Configure a firewall to restrict Grafana from making network requests to sensitive internal web services. There are many firewall tools available, refer to the documentation for your specific security tool. For example, Linux users can use [iptables](https://en.wikipedia.org/wiki/Iptables). diff --git a/docs/sources/administration/set-up-for-high-availability.md b/docs/sources/administration/set-up-for-high-availability.md index 7e957f3422451..f34d273ef7437 100644 --- a/docs/sources/administration/set-up-for-high-availability.md +++ b/docs/sources/administration/set-up-for-high-availability.md @@ -1,9 +1,7 @@ +++ title = "Set up Grafana for high availability" -type = "docs" keywords = ["grafana", "tutorials", "HA", "high availability"] aliases = ["/docs/grafana/latest/tutorials/ha_setup/"] -[menu.docs] weight = 1200 +++ diff --git a/docs/sources/administration/view-server-settings.md b/docs/sources/administration/view-server-settings.md index d9e0c54d574ca..05d8f654a01b4 100644 --- a/docs/sources/administration/view-server-settings.md +++ b/docs/sources/administration/view-server-settings.md @@ -2,11 +2,6 @@ title = "View server settings" description = "How to view server settings in the Grafana UI" keywords = ["grafana", "configuration", "server", "settings"] -type = "docs" -[menu.docs] -name = "Configuration" -identifier = "config" -parent = "admin" weight = 350 +++ diff --git a/docs/sources/administration/view-server-stats.md b/docs/sources/administration/view-server-stats.md index f14f98d08e562..f3c6e9a8e946b 100644 --- a/docs/sources/administration/view-server-stats.md +++ b/docs/sources/administration/view-server-stats.md @@ -1,8 +1,6 @@ +++ title = "View server stats" -type = "docs" keywords = ["grafana", "server", "statistics"] -[menu.docs] weight = 1150 +++ diff --git a/docs/sources/alerting/_index.md b/docs/sources/alerting/_index.md index deb9bf1007373..cac8c33e3989a 100644 --- a/docs/sources/alerting/_index.md +++ b/docs/sources/alerting/_index.md @@ -1,9 +1,5 @@ +++ title = "Alerting" -type = "docs" -[menu.docs] -identifier = "alerting" -parent = "features" weight = 100 +++ diff --git a/docs/sources/alerting/alerts-overview.md b/docs/sources/alerting/alerts-overview.md index 68f7a461dd3c1..558da54de3511 100644 --- a/docs/sources/alerting/alerts-overview.md +++ b/docs/sources/alerting/alerts-overview.md @@ -1,10 +1,6 @@ +++ title = "Alerts overview" -type = "docs" -[menu.docs] -identifier = "alerting" -parent = "Alerting" -aliases = ["/docs/grafana/latest/alerting/rules/", "/docs/grafana/latest/alerting/metrics/", "/docs/grafana/latest/alerting/rules/#query-condition-example", "/docs/grafana/latest/alerting/rules/#for", "/docs/grafana/latest/alerting/rules/#rule-config"] +aliases = ["/docs/grafana/latest/alerting/rules/", "/docs/grafana/latest/alerting/metrics/"] weight = 100 +++ diff --git a/docs/sources/alerting/create-alerts.md b/docs/sources/alerting/create-alerts.md index 262c2906479be..3cd0fd28a4c66 100644 --- a/docs/sources/alerting/create-alerts.md +++ b/docs/sources/alerting/create-alerts.md @@ -2,11 +2,6 @@ title = "Create alerts" description = "Configure alert rules" keywords = ["grafana", "alerting", "guide", "rules"] -type = "docs" -[menu.docs] -name = "Create alerts" -identifier = "create-alerts" -parent = "alerting" weight = 200 +++ diff --git a/docs/sources/alerting/notifications.md b/docs/sources/alerting/notifications.md index 7630594a65037..7a38e0df53c03 100644 --- a/docs/sources/alerting/notifications.md +++ b/docs/sources/alerting/notifications.md @@ -2,11 +2,6 @@ title = "Alert notifications" description = "Alerting notifications guide" keywords = ["Grafana", "alerting", "guide", "notifications"] -type = "docs" -[menu.docs] -name = "Notifications" -identifier = "alert-notification" -parent = "alerting" weight = 100 +++ diff --git a/docs/sources/alerting/pause-an-alert-rule.md b/docs/sources/alerting/pause-an-alert-rule.md index 395238171ac88..1d8afafaded12 100644 --- a/docs/sources/alerting/pause-an-alert-rule.md +++ b/docs/sources/alerting/pause-an-alert-rule.md @@ -2,10 +2,6 @@ title = "Pause alert rule" description = "Pause an existing alert rule" keywords = ["grafana", "alerting", "guide", "rules", "view"] -type = "docs" -[menu.docs] -identifier = "pause-alerts" -parent = "alerting" weight = 400 +++ diff --git a/docs/sources/alerting/troubleshoot-alerts.md b/docs/sources/alerting/troubleshoot-alerts.md index dca120e9ebffb..36c156d177999 100644 --- a/docs/sources/alerting/troubleshoot-alerts.md +++ b/docs/sources/alerting/troubleshoot-alerts.md @@ -2,11 +2,6 @@ title = "Troubleshoot alerts" description = "Troubleshoot alert rules" keywords = ["grafana", "alerting", "guide", "rules", "troubleshoot"] -type = "docs" -[menu.docs] -name = "Troubleshoot alerts" -identifier = "troubleshoot-alerts" -parent = "alerting" weight = 500 +++ diff --git a/docs/sources/alerting/view-alerts.md b/docs/sources/alerting/view-alerts.md index 1bf9a07811f77..79fb9a3e0183e 100644 --- a/docs/sources/alerting/view-alerts.md +++ b/docs/sources/alerting/view-alerts.md @@ -2,11 +2,6 @@ title = "View alerts" description = "View existing alert rules" keywords = ["grafana", "alerting", "guide", "rules", "view"] -type = "docs" -[menu.docs] -name = "View alerts" -identifier = "view-alerts" -parent = "alerting" weight = 400 +++ diff --git a/docs/sources/auth/_index.md b/docs/sources/auth/_index.md index ed7d23fc6be49..b73023209d914 100644 --- a/docs/sources/auth/_index.md +++ b/docs/sources/auth/_index.md @@ -1,11 +1,6 @@ +++ title = "Authentication" description = "Authentication" -type = "docs" -[menu.docs] -name = "Authentication" -identifier = "authentication" -parent = "admin" weight = 30 +++ @@ -18,13 +13,13 @@ Here is a table showing all supported authentication providers and the features See also, [Grafana Authentication]({{< relref "grafana.md" >}}). Provider | Support | Role mapping | Team sync
*(Enterprise only)* | Active sync
*(Enterprise only)* --------- | :-----: | :----------: | :-------: | :---------: -[Auth Proxy]({{< relref "auth-proxy.md" >}}) | v2.1+ | - | v6.3+ | - -[Azure AD OAuth]({{< relref "azuread.md" >}}) | v6.7+ | v6.7+ | v6.7+ | - -[Generic OAuth]({{< relref "generic-oauth.md" >}}) | v4.0+ | v6.5+ | - | - +-------- | :-----: | :----------: | :-------: | :---------: +[Auth Proxy]({{< relref "auth-proxy.md" >}}) | v2.1+ | - | v6.3+ | - +[Azure AD OAuth]({{< relref "azuread.md" >}}) | v6.7+ | v6.7+ | v6.7+ | - +[Generic OAuth]({{< relref "generic-oauth.md" >}}) | v4.0+ | v6.5+ | - | - [GitHub OAuth]({{< relref "github.md" >}}) | v2.0+ | - | v6.3+ | - [GitLab OAuth]({{< relref "gitlab.md" >}}) | v5.3+ | - | v6.4+ | - -[Google OAuth]({{< relref "google.md" >}}) | v2.0+ | - | - | - +[Google OAuth]({{< relref "google.md" >}}) | v2.0+ | - | - | - [LDAP]({{< relref "ldap.md" >}}) | v2.1+ | v2.1+ | v5.3+ | v6.3+ -[Okta OAuth]({{< relref "okta.md" >}}) | v7.0+ | v7.0+ | v7.0+ | - -[SAML]({{< relref "../enterprise/saml.md" >}}) (Enterprise only) | v6.3+ | v7.0+ | v7.0+ | - +[Okta OAuth]({{< relref "okta.md" >}}) | v7.0+ | v7.0+ | v7.0+ | - +[SAML]({{< relref "../enterprise/saml.md" >}}) (Enterprise only) | v6.3+ | v7.0+ | v7.0+ | - diff --git a/docs/sources/auth/auth-proxy.md b/docs/sources/auth/auth-proxy.md index 903dba5758bc1..5cb6a5341d7c0 100755 --- a/docs/sources/auth/auth-proxy.md +++ b/docs/sources/auth/auth-proxy.md @@ -2,12 +2,7 @@ title = "Auth Proxy" description = "Grafana Auth Proxy Guide " keywords = ["grafana", "configuration", "documentation", "proxy"] -type = "docs" aliases = ["/docs/grafana/latest/tutorials/authproxy/"] -[menu.docs] -name = "Auth Proxy" -identifier = "auth-proxy" -parent = "authentication" weight = 200 +++ diff --git a/docs/sources/auth/azuread.md b/docs/sources/auth/azuread.md index 198a0d5067136..7fd8317d77ff6 100644 --- a/docs/sources/auth/azuread.md +++ b/docs/sources/auth/azuread.md @@ -2,11 +2,6 @@ title = "Azure AD OAuth2 authentication" description = "Grafana Azure AD OAuth Guide " keywords = ["grafana", "configuration", "documentation", "oauth"] -type = "docs" -[menu.docs] -name = "Azure AD" -identifier = "azuread_oauth2" -parent = "authentication" weight = 700 +++ @@ -24,7 +19,7 @@ To enable the Azure AD OAuth2 you must register your application with Azure AD. 1. Under **Manage** in the side menu, click **App Registrations** and then **New Registration**. Provide a fitting name. -1. Under **Redirect URI**, select **Web** as the app type. +1. Under **Redirect URI**, select **Web** as the app type. 1. Add the redirect URL `https:///login/azuread`, then click **Register**. @@ -88,7 +83,7 @@ To enable the Azure AD OAuth2 you must register your application with Azure AD. 1. Go to **Azure Active Directory** and then to **Enterprise Applications**. Search for your application and click on it. -1. Click on **Users and Groups** and add Users/Groups to the Grafana roles by using **Add User**. +1. Click on **Users and Groups** and add Users/Groups to the Grafana roles by using **Add User**. ## Enable Azure AD OAuth in Grafana diff --git a/docs/sources/auth/enhanced_ldap.md b/docs/sources/auth/enhanced_ldap.md index f49ed647dd58c..b07a7b9010f2d 100755 --- a/docs/sources/auth/enhanced_ldap.md +++ b/docs/sources/auth/enhanced_ldap.md @@ -2,11 +2,6 @@ title = "Enhanced LDAP Integration" description = "Grafana Enhanced LDAP Integration Guide " keywords = ["grafana", "configuration", "documentation", "ldap", "active directory", "enterprise"] -type = "docs" -[menu.docs] -name = "Enhanced LDAP" -identifier = "enhanced-ldap" -parent = "authentication" weight = 400 +++ diff --git a/docs/sources/auth/generic-oauth.md b/docs/sources/auth/generic-oauth.md index 2f3474ca24b11..e1947ac318003 100755 --- a/docs/sources/auth/generic-oauth.md +++ b/docs/sources/auth/generic-oauth.md @@ -2,11 +2,6 @@ title = "OAuth authentication" description = "Grafana OAuthentication Guide " keywords = ["grafana", "configuration", "documentation", "oauth"] -type = "docs" -[menu.docs] -name = "Generic OAuth" -identifier = "generic_oauth" -parent = "authentication" weight = 500 +++ @@ -47,8 +42,8 @@ tls_client_ca = Set `api_url` to the resource that returns [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo) compatible information. -You can also specify the SSL/TLS configuration used by the client. -- Set `tls_client_cert` to the path of the certificate. +You can also specify the SSL/TLS configuration used by the client. +- Set `tls_client_cert` to the path of the certificate. - Set `tls_client_key` to the path containing the key. - Set `tls_client_ca` to the path containing a trusted certificate authority list. @@ -75,7 +70,7 @@ See [JMESPath examples](#jmespath-examples) for more information. Customize user login using `login_attribute_path` configuration option. Order of operations is as follows: -1. Grafana evaluates the `login_attribute_path` JMESPath expression against the ID token. +1. Grafana evaluates the `login_attribute_path` JMESPath expression against the ID token. 1. If Grafana finds no value, then Grafana evaluates expression against the JSON data obtained from UserInfo endpoint. The UserInfo endpoint URL is specified in the `api_url` configuration option. You can customize the attribute name used to extract the ID token from the returned OAuth token with the `id_token_attribute_name` option. diff --git a/docs/sources/auth/github.md b/docs/sources/auth/github.md index a5dcf2b780332..b3753de676dd2 100644 --- a/docs/sources/auth/github.md +++ b/docs/sources/auth/github.md @@ -2,11 +2,6 @@ title = "GitHub OAuth2 Authentication" description = "Grafana OAuthentication Guide " keywords = ["grafana", "configuration", "documentation", "oauth"] -type = "docs" -[menu.docs] -name = "GitHub" -identifier = "github_oauth2" -parent = "authentication" weight = 800 +++ @@ -46,7 +41,7 @@ team_ids = allowed_organizations = ``` -You may have to set the `root_url` option of `[server]` for the callback URL to be +You may have to set the `root_url` option of `[server]` for the callback URL to be correct. For example in case you are serving Grafana behind a proxy. Restart the Grafana back-end. You should now see a GitHub login button @@ -104,7 +99,7 @@ allowed_organizations = github google > Only available in Grafana Enterprise v6.3+ With Team Sync you can map your GitHub org teams to teams in Grafana so that your users will automatically be added to -the correct teams. +the correct teams. Your GitHub teams can be referenced in two ways: diff --git a/docs/sources/auth/gitlab.md b/docs/sources/auth/gitlab.md index 27c1eed7a89b6..7ec1ff99eccc6 100644 --- a/docs/sources/auth/gitlab.md +++ b/docs/sources/auth/gitlab.md @@ -2,11 +2,6 @@ title = "GitLab OAuth2 Authentication" description = "Grafana OAuthentication Guide " keywords = ["grafana", "configuration", "documentation", "oauth"] -type = "docs" -[menu.docs] -name = "GitLab" -identifier = "gitlab_oauth" -parent = "authentication" weight = 900 +++ @@ -58,7 +53,7 @@ api_url = https://gitlab.com/api/v4 allowed_groups = ``` -You may have to set the `root_url` option of `[server]` for the callback URL to be +You may have to set the `root_url` option of `[server]` for the callback URL to be correct. For example in case you are serving Grafana behind a proxy. Restart the Grafana backend for your changes to take effect. @@ -121,7 +116,7 @@ allowed_groups = example, foo/bar > Only available in Grafana Enterprise v6.4+ With Team Sync you can map your GitLab groups to teams in Grafana so that your users will automatically be added to -the correct teams. +the correct teams. Your GitLab groups can be referenced in the same way as `allowed_groups`, like `example` or `foo/bar`. diff --git a/docs/sources/auth/google.md b/docs/sources/auth/google.md index 5e0a55cca47fd..72d04d2c49379 100644 --- a/docs/sources/auth/google.md +++ b/docs/sources/auth/google.md @@ -2,11 +2,6 @@ title = "Google OAuth2 Authentication" description = "Grafana OAuthentication Guide " keywords = ["grafana", "configuration", "documentation", "oauth"] -type = "docs" -[menu.docs] -name = "Google" -identifier = "google_oauth2" -parent = "authentication" weight = 600 +++ @@ -45,7 +40,7 @@ allowed_domains = mycompany.com mycompany.org allow_sign_up = true ``` -You may have to set the `root_url` option of `[server]` for the callback URL to be +You may have to set the `root_url` option of `[server]` for the callback URL to be correct. For example in case you are serving Grafana behind a proxy. Restart the Grafana back-end. You should now see a Google login button diff --git a/docs/sources/auth/grafana.md b/docs/sources/auth/grafana.md index 97f187ae0dd03..b19ae0d72f385 100644 --- a/docs/sources/auth/grafana.md +++ b/docs/sources/auth/grafana.md @@ -2,11 +2,6 @@ title = "Grafana Authentication" description = "Grafana OAuthentication Guide " keywords = ["grafana", "configuration", "documentation", "oauth"] -type = "docs" -[menu.docs] -name = "GitLab" -identifier = "grafana-oauth" -parent = "authentication" weight = 100 +++ diff --git a/docs/sources/auth/ldap.md b/docs/sources/auth/ldap.md index facac356c7441..106c4e5daaa2f 100644 --- a/docs/sources/auth/ldap.md +++ b/docs/sources/auth/ldap.md @@ -2,12 +2,7 @@ title = "LDAP Authentication" description = "Grafana LDAP Authentication Guide " keywords = ["grafana", "configuration", "documentation", "ldap", "active directory"] -type = "docs" aliases = ["/docs/grafana/latest/installation/ldap/"] -[menu.docs] -name = "LDAP" -identifier = "ldap" -parent = "authentication" weight = 300 +++ @@ -85,9 +80,6 @@ search_base_dns = ["dc=grafana,dc=org"] # Specify names of the LDAP attributes your LDAP uses [servers.attributes] -name = "givenName" -surname = "sn" -username = "cn" member_of = "memberOf" email = "email" ``` @@ -105,7 +97,7 @@ bind_password = "${LDAP_ADMIN_PASSWORD}" > Only available in Grafana v6.4+ Grafana has an LDAP debug view built-in which allows you to test your LDAP configuration directly within Grafana. At the moment of writing, only Grafana admins can use the LDAP debug view. - + Within this view, you'll be able to see which LDAP servers are currently reachable and test your current configuration. {{< docs-imagebox img="/img/docs/ldap_debug.png" class="docs-image--no-shadow" max-width="600px" >}} @@ -243,9 +235,6 @@ search_filter = "(cn=%s)" search_base_dns = ["dc=grafana,dc=org"] [servers.attributes] -name = "givenName" -surname = "sn" -username = "cn" member_of = "memberOf" email = "email" @@ -272,9 +261,6 @@ search_filter = "(cn=%s)" search_base_dns = ["ou=users,dc=grafana,dc=org"] [servers.attributes] -name = "givenName" -surname = "sn" -username = "cn" member_of = "memberOf" email = "email" @@ -298,9 +284,6 @@ search_filter = "(cn=%s)" search_base_dns = ["ou=users,dc=grafana,dc=org"] [servers.attributes] -name = "givenName" -surname = "sn" -username = "cn" member_of = "memberOf" email = "email" @@ -336,9 +319,6 @@ search_filter = "(sAMAccountName=%s)" search_base_dns = ["dc=corp,dc=local"] [servers.attributes] -name = "givenName" -surname = "sn" -username = "sAMAccountName" member_of = "memberOf" email = "mail" diff --git a/docs/sources/auth/okta.md b/docs/sources/auth/okta.md index d015ce92071e8..14046e5a68a30 100644 --- a/docs/sources/auth/okta.md +++ b/docs/sources/auth/okta.md @@ -2,11 +2,6 @@ title = "Okta OAuth2 authentication" description = "Grafana Okta OAuth Guide " keywords = ["grafana", "configuration", "documentation", "oauth"] -type = "docs" -[menu.docs] -name = "Okta" -identifier = "okta_oauth2" -parent = "authentication" weight = 1000 +++ diff --git a/docs/sources/auth/overview.md b/docs/sources/auth/overview.md index b458f53f8a477..aa52df076765e 100644 --- a/docs/sources/auth/overview.md +++ b/docs/sources/auth/overview.md @@ -1,11 +1,6 @@ +++ title = "Overview" description = "Overview for auth" -type = "docs" -[menu.docs] -name = "Overview" -identifier = "overview-auth" -parent = "authentication" weight = 1 +++ @@ -16,16 +11,16 @@ Grafana provides many ways to authenticate users. Some authentication integratio Here is a table showing all supported authentication providers and the features available for them. [Team sync]({{< relref "../enterprise/team-sync.md" >}}) and [active sync]({{< relref "../enterprise/enhanced_ldap.md#active-ldap-synchronization" >}}) are only available in Grafana Enterprise. Provider | Support | Role mapping | Team sync
*(Enterprise only)* | Active sync
*(Enterprise only)* --------- | :-----: | :----------: | :-------: | :---------: -[Auth Proxy]({{< relref "auth-proxy.md" >}}) | v2.1+ | - | v6.3+ | - -[Azure AD OAuth]({{< relref "azuread.md" >}}) | v6.7+ | v6.7+ | v6.7+ | - -[Generic OAuth]({{< relref "generic-oauth.md" >}}) | v4.0+ | v6.5+ | - | - +-------- | :-----: | :----------: | :-------: | :---------: +[Auth Proxy]({{< relref "auth-proxy.md" >}}) | v2.1+ | - | v6.3+ | - +[Azure AD OAuth]({{< relref "azuread.md" >}}) | v6.7+ | v6.7+ | v6.7+ | - +[Generic OAuth]({{< relref "generic-oauth.md" >}}) | v4.0+ | v6.5+ | - | - [GitHub OAuth]({{< relref "github.md" >}}) | v2.0+ | - | v6.3+ | - [GitLab OAuth]({{< relref "gitlab.md" >}}) | v5.3+ | - | v6.4+ | - -[Google OAuth]({{< relref "google.md" >}}) | v2.0+ | - | - | - +[Google OAuth]({{< relref "google.md" >}}) | v2.0+ | - | - | - [LDAP]({{< relref "ldap.md" >}}) | v2.1+ | v2.1+ | v5.3+ | v6.3+ -[Okta OAuth]({{< relref "okta.md" >}}) | v7.0+ | v7.0+ | v7.0+ | - -[SAML]({{< relref "../enterprise/saml.md" >}}) (Enterprise only) | v6.3+ | v7.0+ | v7.0+ | - +[Okta OAuth]({{< relref "okta.md" >}}) | v7.0+ | v7.0+ | v7.0+ | - +[SAML]({{< relref "../enterprise/saml.md" >}}) (Enterprise only) | v6.3+ | v7.0+ | v7.0+ | - ## Grafana Auth @@ -61,11 +56,11 @@ login_cookie_name = grafana_session # The maximum lifetime (duration) an authenticated user can be inactive before being required to login at next visit. Default is 7 days (7d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month). The lifetime resets at each successful token rotation (token_rotation_interval_minutes). -login_maximum_inactive_lifetime_duration = +login_maximum_inactive_lifetime_duration = # The maximum lifetime (duration) an authenticated user can be logged in since login time before being required to login. Default is 30 days (30d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month). -login_maximum_lifetime_duration = +login_maximum_lifetime_duration = # How often should auth tokens be rotated for authenticated users when being active. The default is each 10 minutes. token_rotation_interval_minutes = 10 diff --git a/docs/sources/auth/saml.md b/docs/sources/auth/saml.md index f5df611b0f01e..79021c58bd91a 100644 --- a/docs/sources/auth/saml.md +++ b/docs/sources/auth/saml.md @@ -3,10 +3,6 @@ title = "SAML Authentication" description = "Grafana SAML Authentication" keywords = ["grafana", "saml", "documentation", "saml-auth"] aliases = ["/docs/grafana/latest/auth/saml/"] -type = "docs" -[menu.docs] -name = "SAML" -parent = "authentication" weight = 1100 +++ diff --git a/docs/sources/auth/team-sync.md b/docs/sources/auth/team-sync.md index d8d88666b1bcf..1ade642c705ff 100644 --- a/docs/sources/auth/team-sync.md +++ b/docs/sources/auth/team-sync.md @@ -3,10 +3,6 @@ title = "Team Sync" description = "Grafana Team Sync" keywords = ["grafana", "auth", "documentation"] aliases = ["/docs/grafana/latest/auth/saml/"] -type = "docs" -[menu.docs] -name = "Team Sync" -parent = "authentication" weight = 1200 +++ diff --git a/docs/sources/best-practices/_index.md b/docs/sources/best-practices/_index.md index cd0b4f2f5551e..d7e4bc4bc658c 100644 --- a/docs/sources/best-practices/_index.md +++ b/docs/sources/best-practices/_index.md @@ -1,9 +1,6 @@ +++ title = "Best practices" description = "Best practices for working with Grafana" -type = "docs" -[menu.docs] -identifier = "best-practices" weight = 20 +++ @@ -15,5 +12,5 @@ This section provides information about best practices for intermediate Grafana - [Best practices for managing dashboards]({{< relref "best-practices-for-managing-dashboards" >}}) - [Common observability strategies]({{< relref "common-observability-strategies" >}}) - [Dashboard management maturity model]({{< relref "dashboard-management-maturity-levels" >}}) - + \ No newline at end of file diff --git a/docs/sources/best-practices/best-practices-for-creating-dashboards.md b/docs/sources/best-practices/best-practices-for-creating-dashboards.md index c9034348c2802..f615358527624 100644 --- a/docs/sources/best-practices/best-practices-for-creating-dashboards.md +++ b/docs/sources/best-practices/best-practices-for-creating-dashboards.md @@ -1,10 +1,6 @@ +++ title = "Best practices for creating dashboards" description = "Best practices for creating dashboards in Grafana" -type = "docs" -[menu.docs] -identifier = "best-practices-for-creating-dashboards" -parent = "best-practices" weight = 100 +++ @@ -49,7 +45,7 @@ Once you have a strategy or design guidelines, write them down to help maintain - If you create many related dashboards, think about how to cross-reference them for easy navigation. Refer to [Best practices for managing dashboards]({{< relref "best-practices-for-managing-dashboards.md" >}}) for more information. - Grafana retrieves data from a data source. A basic understanding of [data sources]({{< relref "../datasources/_index.md" >}}) in general and your specific is important. - Avoid unnecessary dashboard refreshing to reduce the load on the network or backend. For example, if your data changes every hour, then you don't need to set the dashboard refresh rate to 30 seconds. -- Use the left and right Y-axes when displaying time series with different units or ranges. +- Use the left and right Y-axes when displaying time series with different units or ranges. - Add documentation to dashboards and panels. - To add documentation to a dashboard, add a [Text panel visualization]({{< relref "../panels/visualizations/text-panel.md" >}}) to the dashboard. Record things like the purpose of the dashboard, useful resource links, and any instructions users might need to interact with the dashboard. Check out this [Wikimedia example](https://grafana.wikimedia.org/d/000000066/resourceloader?orgId=1). - To add documentation to a panel, [edit the panel settings]({{< relref "../panels/add-a-panel.md#edit-panel-settings" >}}) and add a description. Any text you add will appear if you hover your cursor over the small `i` in the top left corner of the panel. diff --git a/docs/sources/best-practices/best-practices-for-managing-dashboards.md b/docs/sources/best-practices/best-practices-for-managing-dashboards.md index 448eaf7513cc1..d3208b1f9ad35 100644 --- a/docs/sources/best-practices/best-practices-for-managing-dashboards.md +++ b/docs/sources/best-practices/best-practices-for-managing-dashboards.md @@ -1,10 +1,6 @@ +++ title = "Best practices for managing dashboards" description = "Best practices for managing dashboards in Grafana" -type = "docs" -[menu.docs] -identifier = "best-practices-for-managing-dashboards" -parent = "best-practices" weight = 200 +++ @@ -18,7 +14,7 @@ Here are some principles to consider before you start managing dashboards. ### Strategic observability -There are several [common observability strategies]({{< relref "common-observability-strategies.md" >}}). You should research them and decide whether one of them works for you or if you want to come up with your own. Either way, have a plan, write it down, and stick to it. +There are several [common observability strategies]({{< relref "common-observability-strategies.md" >}}). You should research them and decide whether one of them works for you or if you want to come up with your own. Either way, have a plan, write it down, and stick to it. Adapt your strategy to changing needs as necessary. diff --git a/docs/sources/best-practices/common-observability-strategies.md b/docs/sources/best-practices/common-observability-strategies.md index f5ffd641e866e..c5d977963751f 100644 --- a/docs/sources/best-practices/common-observability-strategies.md +++ b/docs/sources/best-practices/common-observability-strategies.md @@ -3,10 +3,6 @@ title = "Common observability strategies" description = "Common observability strategies" keywords = ["grafana", "intro", "guide", "concepts", "methods"] aliases = ["/docs/grafana/latest/getting-started/strategies/"] -type = "docs" -[menu.docs] -identifier = "common-observability-strategies" -parent = "best-practices" weight = 300 +++ @@ -19,7 +15,7 @@ A logical strategy allows you to make uniform dashboards and scale your observab ## Guidelines for usage - The USE method tells you how happy your machines are, the RED method tells you how happy your users are. -- USE reports on causes of issues. +- USE reports on causes of issues. - RED reports on user experience and is more likely to report symptoms of problems. - The best practice of alerting is to alert on symptoms rather than causes, so alerting should be done on RED dashboards. diff --git a/docs/sources/best-practices/dashboard-management-maturity-levels.md b/docs/sources/best-practices/dashboard-management-maturity-levels.md index 51c56cb0fd045..46f8a653011ce 100644 --- a/docs/sources/best-practices/dashboard-management-maturity-levels.md +++ b/docs/sources/best-practices/dashboard-management-maturity-levels.md @@ -1,10 +1,6 @@ +++ title = "Dashboard management maturity model" description = "Explanation of dashboard management maturity model" -type = "docs" -[menu.docs] -identifier = "best-management-for-maturity-model" -parent = "best-practices" weight = 400 +++ @@ -35,8 +31,8 @@ At this stage, you are starting to manage your dashboard use with methodical das How can you tell you are here? -- Prevent sprawl by using template variables. For example, you don't need a separate dashboard for each node, you can use query variables. Even better, you can make the data source a template variable too, so you can reuse the same dashboard across different clusters and monitoring backends. - +- Prevent sprawl by using template variables. For example, you don't need a separate dashboard for each node, you can use query variables. Even better, you can make the data source a template variable too, so you can reuse the same dashboard across different clusters and monitoring backends. + Refer to the list of [Variable examples]({{< relref "../variables/variable-examples.md" >}}) if you want some ideas. - Methodical dashboards according to an [observability strategy]({{< relref "common-observability-strategies.md" >}}). @@ -49,7 +45,7 @@ How can you tell you are here? {{< imgbox max-width="100%" img="/img/docs/best-practices/service-hierarchy-example.png" caption="Example of a service hierarchy" >}} - Compare like to like: split service dashboards when the magnitude differs. Make sure aggregated metrics don't drown out important information. -- Expressive charts with meaningful use of color and normalizing axes where you can. +- Expressive charts with meaningful use of color and normalizing axes where you can. - Example of meaningful color: Blue means it's good, red means it's bad. [Thresholds]({{< relref "../panels/thresholds.md" >}}) can help with that. - Example of normalizing axes: When comparing CPU usage, measure by percentage rather than raw number, because machines can have a different number of cores. Normalizing CPU usage by the number of cores reduces cognitive load because the viewer can trust that at 100% all cores are being used, without having to know the number of CPUs. - Directed browsing cuts down on "guessing." diff --git a/docs/sources/dashboards/_index.md b/docs/sources/dashboards/_index.md index 05502ce5b225d..282e1dc7c1ba3 100644 --- a/docs/sources/dashboards/_index.md +++ b/docs/sources/dashboards/_index.md @@ -1,10 +1,7 @@ +++ -title = "Dashboard overview" -type = "docs" +title = "Dashboards" aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"] -[menu.docs] -identifier = "dashboards" -weight = 100 +weight = 80 +++ # Dashboard overview diff --git a/docs/sources/dashboards/annotations.md b/docs/sources/dashboards/annotations.md index 32c4c3fd94d0d..8b57719ca472e 100644 --- a/docs/sources/dashboards/annotations.md +++ b/docs/sources/dashboards/annotations.md @@ -1,11 +1,7 @@ +++ title = "Annotations" keywords = ["grafana", "annotations", "documentation", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/reference/annotations/"] -[menu.docs] -name = "Annotations" -parent = "dashboard_features" weight = 2 +++ diff --git a/docs/sources/dashboards/dashboard_folders.md b/docs/sources/dashboards/dashboard_folders.md index a88a01cdff68c..e910ff75caef0 100644 --- a/docs/sources/dashboards/dashboard_folders.md +++ b/docs/sources/dashboards/dashboard_folders.md @@ -1,11 +1,7 @@ +++ title = "Dashboard Folders" keywords = ["grafana", "dashboard", "dashboard folders", "folder", "folders", "documentation", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/reference/dashboard_folders/"] -[menu.docs] -name = "Folders" -parent = "dashboard_features" weight = 3 +++ diff --git a/docs/sources/dashboards/dashboard_history.md b/docs/sources/dashboards/dashboard_history.md index 741986f0da4da..45abe97107a44 100644 --- a/docs/sources/dashboards/dashboard_history.md +++ b/docs/sources/dashboards/dashboard_history.md @@ -1,11 +1,7 @@ +++ title = "Dashboard Version History" keywords = ["grafana", "dashboard", "documentation", "version", "history"] -type = "docs" aliases = ["/docs/grafana/latest/reference/dashboard_history/"] -[menu.docs] -name = "Dashboard Version History" -parent = "dashboard_features" weight = 100 +++ diff --git a/docs/sources/dashboards/export-import.md b/docs/sources/dashboards/export-import.md index b37a50778408c..5fe0f3ea01a3b 100644 --- a/docs/sources/dashboards/export-import.md +++ b/docs/sources/dashboards/export-import.md @@ -1,10 +1,7 @@ +++ title = "Export and import" keywords = ["grafana", "dashboard", "documentation", "export", "import"] -type = "docs" aliases = ["/docs/grafana/latest/reference/export_import/"] -[menu.docs] -parent = "dashboard_features" weight = 800 +++ @@ -30,7 +27,7 @@ the dashboard, and will also be added as a required input when the dashboard is ## Importing a dashboard -To import a dashboard click the + icon in the side menu, and then click **Import**. +To import a dashboard click the + icon in the side menu, and then click **Import**. {{< docs-imagebox img="/img/docs/v70/import_step1.png" max-width="700px" >}} diff --git a/docs/sources/dashboards/json-model.md b/docs/sources/dashboards/json-model.md index f7807b2dce97f..884818b39caf1 100644 --- a/docs/sources/dashboards/json-model.md +++ b/docs/sources/dashboards/json-model.md @@ -1,11 +1,7 @@ +++ title = "JSON model" keywords = ["grafana", "dashboard", "documentation", "json", "model"] -type = "docs" aliases = ["/docs/grafana/latest/reference/dashboard/"] -[menu.docs] -name = "JSON Model" -parent = "dashboard_features" weight = 1200 +++ diff --git a/docs/sources/dashboards/playlist.md b/docs/sources/dashboards/playlist.md index 21ff4a322527c..582486590a812 100644 --- a/docs/sources/dashboards/playlist.md +++ b/docs/sources/dashboards/playlist.md @@ -1,11 +1,7 @@ +++ title = "Playlist" keywords = ["grafana", "dashboard", "documentation", "playlist"] -type = "docs" aliases = ["/docs/grafana/latest/reference/playlist/"] -[menu.docs] -parent = "dashboard_features" -identifier = "feature_playlist" weight = 4 +++ @@ -22,7 +18,7 @@ You can access the Playlist feature from Grafana's side menu, in the Dashboards ## Create a playlist -You create a playlist to present dashboards in a sequence, with a set order and time interval between dashboards. +You create a playlist to present dashboards in a sequence, with a set order and time interval between dashboards. 1. To access the Playlist feature, hover your cursor over Grafana's side menu. 1. Click **Playlists**. @@ -32,7 +28,7 @@ You create a playlist to present dashboards in a sequence, with a set order and The time interval is the amount of time for Grafana to stay on a particular dashboard before advancing to the next one on the playlist. -1. Next to the dashboard(s) you want to add to your playlist, click **Add to playlist**. +1. Next to the dashboard(s) you want to add to your playlist, click **Add to playlist**. 1. Click **Create**. ## Edit a playlist @@ -46,7 +42,7 @@ You can edit playlists while creating them or after saving them. ### Edit the Name of a playlist 1. Double-click within the **Name** text box. -1. Enter a name. +1. Enter a name. 1. Click **Save** to save your changes. ### Edit the Interval of a playlist @@ -62,9 +58,9 @@ You can edit playlists while creating them or after saving them. ### Search for a dashboard to add -1. Click the **Search dashboards by name** text box. -1. Search for the playlist by name or regular expression. -1. If needed, filter your results by starred status or tags. +1. Click the **Search dashboards by name** text box. +1. Search for the playlist by name or regular expression. +1. If needed, filter your results by starred status or tags. By default, your starred dashboards will appear as options to add to the Playlist. 1. Click **Save** to save your changes. @@ -85,18 +81,18 @@ You can edit playlists while creating them or after saving them. ## Save a playlist -You can save a playlist to add it to your **Playlists** page, where you can start it. Be sure that all the dashboards you want to appear in your playlist are added when creating or editing the playlist before saving it. +You can save a playlist to add it to your **Playlists** page, where you can start it. Be sure that all the dashboards you want to appear in your playlist are added when creating or editing the playlist before saving it. 1. To access the Playlist feature, hover your cursor over Grafana's side menu. 1. Click **Playlists**. 1. Click on the playlist. 1. Edit the playlist. * Ensure that your playlist has a **Name**, **Interval**, and at least one **Dashboard** added to it. -1. Click **Save**. +1. Click **Save**. ## Start a playlist -You can start a playlist in five different view modes, which determine how the menus and navigation bar are displayed on the dashboards. +You can start a playlist in five different view modes, which determine how the menus and navigation bar are displayed on the dashboards. By default, each dashboard is displayed for the amount of time entered in the Interval field, which can be set while creating or editing a playlist. Once a playlist is started, it can be controlled using the navbar at the top of your screen. @@ -104,24 +100,24 @@ By default, each dashboard is displayed for the amount of time entered in the In 1. Next to the playlist you want to start, click **Start playlist**. 1. In the dropdown, select the mode you want the playlist to display in. - **Normal mode:** - - The side menu remains visible. + - The side menu remains visible. - The navbar, row and panel controls appear at the top of the screen. - **TV mode:** - - The side menu is hidden/removed. + - The side menu is hidden/removed. - The navbar, row and panel controls appear at the top of the screen. - Enabled automatically after one minute of user inactivity. - - You can enable it manually using the `d v` sequence shortcut, or by appending the parameter `?inactive` to the dashboard URL. - - You can disable it with any mouse movement or keyboard action. - - **TV mode (with auto fit panels):** - - The side menu is hidden/removed. + - You can enable it manually using the `d v` sequence shortcut, or by appending the parameter `?inactive` to the dashboard URL. + - You can disable it with any mouse movement or keyboard action. + - **TV mode (with auto fit panels):** + - The side menu is hidden/removed. - The navbar, row and panel controls appear at the top of the screen. - Dashboard panels automatically adjust to optimize space on screen. - - **Kiosk mode:** - - The side menu, navbar, row and panel controls are completely hidden/removed from view. + - **Kiosk mode:** + - The side menu, navbar, row and panel controls are completely hidden/removed from view. - You can enable it manually using the `d v` sequence shortcut after the playlist has started. - You can disable it manually with the same shortcut. - - **Kiosk mode (with auto fit panels):** - - The side menu, navbar, row and panel controls are completely hidden/removed from view. + - **Kiosk mode (with auto fit panels):** + - The side menu, navbar, row and panel controls are completely hidden/removed from view. - Dashboard panels automatically adjust to optimize space on screen. ## Control a playlist @@ -141,12 +137,12 @@ You can control a playlist in **Normal** or **TV** mode after it's started, usin ## Share a playlist in a view mode -You can share a playlist by copying the link address on the view mode you prefer, and pasting the URL to your destination. +You can share a playlist by copying the link address on the view mode you prefer, and pasting the URL to your destination. 1. From the Dashboards submenu, click **Playlists**. 1. Next to the playlist you want to share, click **Start playlist**. 1. In the dropdown, right click the view mode you prefer. -1. Click **Copy Link Address** to copy the URL to your clipboard. +1. Click **Copy Link Address** to copy the URL to your clipboard. Example: The URL for the first playlist on the Grafana Play site in Kiosk mode will look like this: [https://play.grafana.org/playlists/play/1?kiosk](https://play.grafana.org/playlists/play/1?kiosk). diff --git a/docs/sources/dashboards/reporting.md b/docs/sources/dashboards/reporting.md index 7209eac7adc2b..6f70d585fa45e 100644 --- a/docs/sources/dashboards/reporting.md +++ b/docs/sources/dashboards/reporting.md @@ -2,10 +2,7 @@ title = "Reporting" description = "" keywords = ["grafana", "reporting"] -type = "docs" aliases = ["/docs/grafana/latest/administration/reports"] -[menu.docs] -parent = "features" weight = 8 +++ diff --git a/docs/sources/dashboards/scripted-dashboards.md b/docs/sources/dashboards/scripted-dashboards.md index 445e86c6ffadb..9877a78591de2 100644 --- a/docs/sources/dashboards/scripted-dashboards.md +++ b/docs/sources/dashboards/scripted-dashboards.md @@ -1,10 +1,7 @@ +++ title = "Scripted dashboards" keywords = ["grafana", "dashboard", "documentation", "scripted"] -type = "docs" aliases = ["/docs/grafana/latest/reference/scripting/"] -[menu.docs] -parent = "dashboard_features" weight = 1500 +++ diff --git a/docs/sources/dashboards/search.md b/docs/sources/dashboards/search.md index 4556b32243a9e..20b004024342e 100644 --- a/docs/sources/dashboards/search.md +++ b/docs/sources/dashboards/search.md @@ -1,10 +1,7 @@ +++ title = "Search" keywords = ["grafana", "dashboard", "documentation", "search"] -type = "docs" aliases =["/docs/grafana/latest/reference/search/"] -[menu.docs] -parent = "dashboard_features" weight = 5 +++ diff --git a/docs/sources/dashboards/share-dashboard.md b/docs/sources/dashboards/share-dashboard.md index d606353da6c97..475c3391c02df 100644 --- a/docs/sources/dashboards/share-dashboard.md +++ b/docs/sources/dashboards/share-dashboard.md @@ -1,10 +1,7 @@ +++ title = "Share dashboard" keywords = ["grafana", "dashboard", "documentation", "sharing"] -type = "docs" aliases = ["/docs/grafana/latest/reference/share_dashboard/"] -[menu.docs] -parent = "dashboard_features" weight = 500 +++ diff --git a/docs/sources/dashboards/share-panel.md b/docs/sources/dashboards/share-panel.md index bb571303bf548..fab3949417cbc 100644 --- a/docs/sources/dashboards/share-panel.md +++ b/docs/sources/dashboards/share-panel.md @@ -1,10 +1,7 @@ +++ title = "Share panel" keywords = ["grafana", "dashboard", "documentation", "sharing"] -type = "docs" aliases = ["/docs/grafana/latest/reference/share_panel/"] -[menu.docs] -parent = "dashboard_features" weight = 600 +++ diff --git a/docs/sources/dashboards/shortcuts.md b/docs/sources/dashboards/shortcuts.md index e2e8e5e5ef63b..cd63e625df6be 100644 --- a/docs/sources/dashboards/shortcuts.md +++ b/docs/sources/dashboards/shortcuts.md @@ -1,8 +1,5 @@ +++ title = "Keyboard shortcuts" -type = "docs" -[menu.docs] -parent = "features" weight = 7 +++ diff --git a/docs/sources/dashboards/time-range-controls.md b/docs/sources/dashboards/time-range-controls.md index 5236560b5abff..1ee581bd16072 100644 --- a/docs/sources/dashboards/time-range-controls.md +++ b/docs/sources/dashboards/time-range-controls.md @@ -2,10 +2,6 @@ title = "Time range controls" keywords = ["grafana", "dashboard", "documentation", "time range"] aliases = ["/docs/grafana/latest/reference/timerange/"] -type = "docs" -[menu.docs] -name = "Time range controls" -parent = "dashboards" weight = 7 +++ diff --git a/docs/sources/datasources/_index.md b/docs/sources/datasources/_index.md index ef005b16f3571..598af8b5cabfe 100644 --- a/docs/sources/datasources/_index.md +++ b/docs/sources/datasources/_index.md @@ -1,12 +1,7 @@ +++ title = "Data sources" -type = "docs" aliases = ["/docs/grafana/latest/datasources/overview/"] -[menu.docs] -name = "Data sources" -identifier = "datasources" -parent = "features" -weight = 50 +weight = 60 +++ # Data sources diff --git a/docs/sources/datasources/add-a-data-source.md b/docs/sources/datasources/add-a-data-source.md index e000b3207024e..3c3372ca791b2 100644 --- a/docs/sources/datasources/add-a-data-source.md +++ b/docs/sources/datasources/add-a-data-source.md @@ -1,11 +1,6 @@ +++ title = "Add data source" -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/add-a-data-source/"] -[menu.docs] -name = "Add a data source" -identifier = "add_data_source" -parent = "features" weight = 100 +++ @@ -23,7 +18,7 @@ Before you create your first dashboard, you need to add your data source. Follow {{< docs-imagebox img="/img/docs/v52/add-datasource.png" max-width="700px" class="docs-image--no-shadow">}} -1. In the **Name** box, enter a name for this data source. +1. In the **Name** box, enter a name for this data source. {{< docs-imagebox img="/img/docs/v52/datasource-settings.png" max-width="700px" class="docs-image--no-shadow">}} diff --git a/docs/sources/datasources/azuremonitor.md b/docs/sources/datasources/azuremonitor.md index 0348b420547df..4340de1cece0d 100644 --- a/docs/sources/datasources/azuremonitor.md +++ b/docs/sources/datasources/azuremonitor.md @@ -2,11 +2,7 @@ title = "Azure Monitor" description = "Guide for using Azure Monitor in Grafana" keywords = ["grafana", "microsoft", "azure", "monitor", "application", "insights", "log", "analytics", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/azuremonitor"] -[menu.docs] -name = "Azure Monitor" -parent = "datasources" weight = 300 +++ diff --git a/docs/sources/datasources/cloudmonitoring.md b/docs/sources/datasources/cloudmonitoring.md index 496d3f9a093f8..2d80e29b55356 100644 --- a/docs/sources/datasources/cloudmonitoring.md +++ b/docs/sources/datasources/cloudmonitoring.md @@ -2,11 +2,7 @@ title = "Cloud Monitoring" description = "Guide for using Google Cloud Monitoring in Grafana" keywords = ["grafana", "stackdriver", "google", "guide", "cloud", "monitoring"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/stackdriver", "/docs/grafana/latest/features/datasources/cloudmonitoring/"] -[menu.docs] -name = "Google Cloud Monitoring" -parent = "datasources" weight = 200 +++ diff --git a/docs/sources/datasources/cloudwatch.md b/docs/sources/datasources/cloudwatch.md index 1aa011a44f7f2..01ab6433d6568 100644 --- a/docs/sources/datasources/cloudwatch.md +++ b/docs/sources/datasources/cloudwatch.md @@ -2,12 +2,7 @@ title = "AWS CloudWatch" description = "Guide for using CloudWatch in Grafana" keywords = ["grafana", "cloudwatch", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/datasources/cloudwatch"] -[menu.docs] -name = "AWS Cloudwatch" -identifier = "cloudwatch" -parent = "datasources" weight = 200 +++ diff --git a/docs/sources/datasources/elasticsearch.md b/docs/sources/datasources/elasticsearch.md index 4a96529175f43..e4e2629c8967b 100644 --- a/docs/sources/datasources/elasticsearch.md +++ b/docs/sources/datasources/elasticsearch.md @@ -2,11 +2,7 @@ title = "Elasticsearch" description = "Guide for using Elasticsearch in Grafana" keywords = ["grafana", "elasticsearch", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/elasticsearch"] -[menu.docs] -name = "Elasticsearch" -parent = "datasources" weight = 400 +++ @@ -95,7 +91,7 @@ For example, if you're using a default setup of Filebeat for shipping logs to El Data links create a link from a specified field that can be accessed in logs view in Explore. -Each data link configuration consists of: +Each data link configuration consists of: - **Field -** Name of the field used by the data link. - **URL/query -** If the link is external, then enter the full link URL. If the link is internal link, then this input serves as query for the target data source. In both cases, you can interpolate the value from the field with `${__value.raw }` macro. - **Internal link -** Select if the link is internal or external. In case of internal link, a data source selector allows you to select the target data source. Only tracing data sources are supported. diff --git a/docs/sources/datasources/graphite.md b/docs/sources/datasources/graphite.md index 9a74c278c27a8..59f6b4d6e649f 100644 --- a/docs/sources/datasources/graphite.md +++ b/docs/sources/datasources/graphite.md @@ -2,12 +2,7 @@ title = "Graphite" description = "Guide for using graphite in Grafana" keywords = ["grafana", "graphite", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/graphite"] -[menu.docs] -name = "Graphite" -identifier = "graphite" -parent = "datasources" weight = 600 +++ diff --git a/docs/sources/datasources/influxdb.md b/docs/sources/datasources/influxdb.md index 4e53a76155f5f..314ef69639f86 100644 --- a/docs/sources/datasources/influxdb.md +++ b/docs/sources/datasources/influxdb.md @@ -2,11 +2,7 @@ title = "InfluxDB" description = "Guide for using InfluxDB in Grafana" keywords = ["grafana", "influxdb", "guide", "flux"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/influxdb"] -[menu.docs] -name = "InfluxDB" -parent = "datasources" weight = 700 +++ @@ -68,7 +64,7 @@ Identifier | Description {{< docs-imagebox img="/img/docs/v45/influxdb_query_still.png" class="docs-image--no-shadow" animated-gif="/img/docs/v45/influxdb_query.gif" >}} -You can access the InfluxDB editor under the metrics tab when you are in the edit mode of the Graph or Singlestat panels. +You can access the InfluxDB editor under the metrics tab when you are in the edit mode of the Graph or Singlestat panels. Enter edit mode by clicking the panel title and clicking **Edit**. The editor allows you to select metrics and tags. ### Filter data (WHERE) @@ -180,7 +176,7 @@ You can view the interpolated version of a query with the Query Inspector. > Only available in Grafana v6.3+. -Querying and displaying log data from InfluxDB is available in [Explore]({{< relref "../explore" >}}), and in the [logs panel]({{< relref "../panels/visualizations/logs-panel.md" >}}) in dashboards. +Querying and displaying log data from InfluxDB is available in [Explore]({{< relref "../explore" >}}), and in the [logs panel]({{< relref "../panels/visualizations/logs-panel.md" >}}) in dashboards. Select the InfluxDB data source, and then enter a query to display your logs. ### Log Queries diff --git a/docs/sources/datasources/jaeger.md b/docs/sources/datasources/jaeger.md index 7fb158924c0d1..a3ebe839e9e8b 100644 --- a/docs/sources/datasources/jaeger.md +++ b/docs/sources/datasources/jaeger.md @@ -2,11 +2,7 @@ title = "Jaeger" description = "Guide for using Jaeger in Grafana" keywords = ["grafana", "jaeger", "guide", "tracing"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/jaeger"] -[menu.docs] -name = "Jaeger" -parent = "datasources" weight = 800 +++ diff --git a/docs/sources/datasources/loki.md b/docs/sources/datasources/loki.md index d29189fd7fe76..9809b7c94e1f8 100644 --- a/docs/sources/datasources/loki.md +++ b/docs/sources/datasources/loki.md @@ -2,11 +2,7 @@ title = "Loki" description = "Guide for using Loki in Grafana" keywords = ["grafana", "loki", "logging", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/loki"] -[menu.docs] -name = "Loki" -parent = "datasources" weight = 800 +++ diff --git a/docs/sources/datasources/mssql.md b/docs/sources/datasources/mssql.md index e81773ad73685..410779fecb280 100644 --- a/docs/sources/datasources/mssql.md +++ b/docs/sources/datasources/mssql.md @@ -2,11 +2,7 @@ title = "Microsoft SQL Server" description = "Guide for using Microsoft SQL Server in Grafana" keywords = ["grafana", "MSSQL", "Microsoft", "SQL", "guide", "Azure SQL Database"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/mssql/"] -[menu.docs] -name = "Microsoft SQL Server" -parent = "datasources" weight = 900 +++ diff --git a/docs/sources/datasources/mysql.md b/docs/sources/datasources/mysql.md index 81327210ddb18..f6769a6d4b382 100644 --- a/docs/sources/datasources/mysql.md +++ b/docs/sources/datasources/mysql.md @@ -2,11 +2,7 @@ title = "MySQL" description = "Guide for using MySQL in Grafana" keywords = ["grafana", "mysql", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/mysql/"] -[menu.docs] -name = "MySQL" -parent = "datasources" weight = 1000 +++ diff --git a/docs/sources/datasources/opentsdb.md b/docs/sources/datasources/opentsdb.md index e9994f312fe80..75d884b53e3c5 100644 --- a/docs/sources/datasources/opentsdb.md +++ b/docs/sources/datasources/opentsdb.md @@ -2,11 +2,7 @@ title = "OpenTSDB" description = "Guide for using OpenTSDB in Grafana" keywords = ["grafana", "opentsdb", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/features/opentsdb", "/docs/grafana/latest/features/datasources/opentsdb/"] -[menu.docs] -name = "OpenTSDB" -parent = "datasources" weight = 1100 +++ diff --git a/docs/sources/datasources/postgres.md b/docs/sources/datasources/postgres.md index b7d9af94fa1fa..4904f8b844482 100644 --- a/docs/sources/datasources/postgres.md +++ b/docs/sources/datasources/postgres.md @@ -2,11 +2,7 @@ title = "PostgreSQL" description = "Guide for using PostgreSQL in Grafana" keywords = ["grafana", "postgresql", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/postgres/"] -[menu.docs] -name = "PostgreSQL" -parent = "datasources" weight = 1200 +++ diff --git a/docs/sources/datasources/prometheus.md b/docs/sources/datasources/prometheus.md index ce11f9eb0272c..6302b2ecd8460 100644 --- a/docs/sources/datasources/prometheus.md +++ b/docs/sources/datasources/prometheus.md @@ -2,11 +2,7 @@ title = "Prometheus" description = "Guide for using Prometheus in Grafana" keywords = ["grafana", "prometheus", "guide"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/prometheus"] -[menu.docs] -name = "Prometheus" -parent = "datasources" weight = 1300 +++ diff --git a/docs/sources/datasources/tempo.md b/docs/sources/datasources/tempo.md index 06e949df772fa..49ba9bfea5a74 100644 --- a/docs/sources/datasources/tempo.md +++ b/docs/sources/datasources/tempo.md @@ -2,11 +2,7 @@ title = "Tempo" description = "High volume, minimal dependency trace storage. OSS tracing solution from Grafana Labs." keywords = ["grafana", "tempo", "guide", "tracing"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/tempo"] -[menu.docs] -name = "Tempo" -parent = "datasources" weight = 800 +++ diff --git a/docs/sources/datasources/testdata.md b/docs/sources/datasources/testdata.md index 0d7e4310eda77..fed671a3a2dab 100644 --- a/docs/sources/datasources/testdata.md +++ b/docs/sources/datasources/testdata.md @@ -1,11 +1,7 @@ +++ title = "TestData" keywords = ["grafana", "dashboard", "documentation", "panels", "testdata"] -type = "docs" aliases = ["/docs/grafana/latest/features/datasources/testdata"] -[menu.docs] -name = "TestData" -parent = "datasources" weight = 1400 +++ @@ -17,9 +13,9 @@ This makes it much easier to verify functionality since the data can be shared v ## Enable -The `TestData DB` data source is not enabled by default. To enable it: +The `TestData DB` data source is not enabled by default. To enable it: -1. In the **Configuration** menu (small gear on the left side of the screen), click **Data Sources**. +1. In the **Configuration** menu (small gear on the left side of the screen), click **Data Sources**. 1. Click **Add Data Source**. 1. Search and click `TestData DB`. 1. Click **Save & Test** to enable it. @@ -39,7 +35,7 @@ Once you provided the numbers, `TestData DB` distributes them evenly based on th ## Dashboards -`TestData DB` also contains some dashboards with examples. +`TestData DB` also contains some dashboards with examples. 1. Click **Configuration** > **Data Sources** > **TestData DB** > **Dashboards**. 1. **Import** the **Simple Streaming Example** dashboard. diff --git a/docs/sources/datasources/zipkin.md b/docs/sources/datasources/zipkin.md index 1a02e9d25fbf3..f6daa62a98c88 100644 --- a/docs/sources/datasources/zipkin.md +++ b/docs/sources/datasources/zipkin.md @@ -2,11 +2,7 @@ title = "Zipkin" description = "Guide for using Zipkin in Grafana" keywords = ["grafana", "zipkin", "guide", "tracing"] -type = "docs" aliases = ["/docs/grafana/latest/datasources/zipkin"] -[menu.docs] -name = "Zipkin" -parent = "datasources" weight = 1500 +++ @@ -36,7 +32,7 @@ Querying and displaying traces from Zipkin is available via [Explore]({{< relref The Zipkin query editor allows you to query by trace ID directly or selecting a trace from trace selector. To query by trace ID, insert the ID into the text input. -{{< docs-imagebox img="/img/docs/v70/zipkin-query-editor-open.png" class="docs-image--no-shadow" caption="Screenshot of the Zipkin query editor with trace selector expanded" >}} +{{< docs-imagebox img="/img/docs/v70/zipkin-query-editor-open.png" class="docs-image--no-shadow" caption="Screenshot of the Zipkin query editor with trace selector expanded" >}} Use the trace selector to pick particular trace from all traces logged in the time range you have selected in Explore. The trace selector has three levels of nesting: 1. The service you are interested in. diff --git a/docs/sources/developers/_index.md b/docs/sources/developers/_index.md index 20dec5156ae80..6b523397bf247 100644 --- a/docs/sources/developers/_index.md +++ b/docs/sources/developers/_index.md @@ -1,7 +1,7 @@ +++ title = "Developers" -type = "docs" aliases = ["/docs/plugins/developing/"] +weight = 190 +++ # Developers diff --git a/docs/sources/developers/cla.md b/docs/sources/developers/cla.md index 6f4678d71a891..8fd11240586af 100644 --- a/docs/sources/developers/cla.md +++ b/docs/sources/developers/cla.md @@ -1,7 +1,6 @@ +++ title = "Contributor License Agreement (CLA)" description = "Contributor License Agreement (CLA)" -type = "docs" aliases = ["/docs/grafana/latest/project/cla", "docs/contributing/cla.html"] +++ diff --git a/docs/sources/developers/contribute.md b/docs/sources/developers/contribute.md index c3a125b2da2b6..fcffb054d453f 100644 --- a/docs/sources/developers/contribute.md +++ b/docs/sources/developers/contribute.md @@ -1,7 +1,6 @@ +++ title = "Contribute to Grafana" keywords = ["grafana", "documentation", "developers", "resources"] -type = "docs" +++ # Contribute to Grafana diff --git a/docs/sources/developers/plugins/_index.md b/docs/sources/developers/plugins/_index.md index c8207ba2b12a6..0ebcfd4285d77 100644 --- a/docs/sources/developers/plugins/_index.md +++ b/docs/sources/developers/plugins/_index.md @@ -1,6 +1,5 @@ +++ title = "Build a plugin." -type = "docs" +++ # Build a plugin diff --git a/docs/sources/developers/plugins/add-authentication-for-data-source-plugins.md b/docs/sources/developers/plugins/add-authentication-for-data-source-plugins.md index fce221e72b82a..36bcccef666aa 100644 --- a/docs/sources/developers/plugins/add-authentication-for-data-source-plugins.md +++ b/docs/sources/developers/plugins/add-authentication-for-data-source-plugins.md @@ -1,6 +1,5 @@ +++ title = "Add authentication for data source plugins" -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/auth-for-datasources/", "/docs/grafana/latest/developers/plugins/authentication/"] +++ diff --git a/docs/sources/developers/plugins/add-support-for-annotations.md b/docs/sources/developers/plugins/add-support-for-annotations.md index 208e944d5f012..8fdb2cdb16799 100644 --- a/docs/sources/developers/plugins/add-support-for-annotations.md +++ b/docs/sources/developers/plugins/add-support-for-annotations.md @@ -1,6 +1,5 @@ +++ title = "Add support for annotations" -type = "docs" +++ # Add support for annotations diff --git a/docs/sources/developers/plugins/add-support-for-explore-queries.md b/docs/sources/developers/plugins/add-support-for-explore-queries.md index d59a2177f947c..1dc35b4894517 100644 --- a/docs/sources/developers/plugins/add-support-for-explore-queries.md +++ b/docs/sources/developers/plugins/add-support-for-explore-queries.md @@ -1,6 +1,5 @@ +++ title = "Add support for Explore queries" -type = "docs" +++ # Add support for Explore queries diff --git a/docs/sources/developers/plugins/add-support-for-variables.md b/docs/sources/developers/plugins/add-support-for-variables.md index 086eca4b0d914..f1a55abc518d9 100644 --- a/docs/sources/developers/plugins/add-support-for-variables.md +++ b/docs/sources/developers/plugins/add-support-for-variables.md @@ -1,6 +1,5 @@ +++ title = "Add support for variables in plugins" -type = "docs" +++ # Add support for variables in plugins diff --git a/docs/sources/developers/plugins/backend/_index.md b/docs/sources/developers/plugins/backend/_index.md index 600e88ef269f1..2c4e18d02f69f 100644 --- a/docs/sources/developers/plugins/backend/_index.md +++ b/docs/sources/developers/plugins/backend/_index.md @@ -1,7 +1,6 @@ +++ title = "Backend plugins" keywords = ["grafana", "plugins", "backend", "plugin", "backend-plugins", "documentation"] -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/backend-plugins-guide/"] +++ diff --git a/docs/sources/developers/plugins/backend/grafana-plugin-sdk-for-go.md b/docs/sources/developers/plugins/backend/grafana-plugin-sdk-for-go.md index 8dde98e85e0b8..72d52085dacf4 100644 --- a/docs/sources/developers/plugins/backend/grafana-plugin-sdk-for-go.md +++ b/docs/sources/developers/plugins/backend/grafana-plugin-sdk-for-go.md @@ -1,7 +1,6 @@ +++ title = "Grafana Plugin SDK for Go" keywords = ["grafana", "plugins", "backend", "plugin", "backend-plugins", "sdk", "documentation"] -type = "docs" +++ # Grafana plugin SDK for Go diff --git a/docs/sources/developers/plugins/backend/plugin-protocol.md b/docs/sources/developers/plugins/backend/plugin-protocol.md index 63ddc77544c4d..6abd367d6a199 100644 --- a/docs/sources/developers/plugins/backend/plugin-protocol.md +++ b/docs/sources/developers/plugins/backend/plugin-protocol.md @@ -1,7 +1,6 @@ +++ title = "Plugin protocol" keywords = ["grafana", "plugins", "backend", "plugin", "backend-plugins", "documentation"] -type = "docs" +++ # Plugin protocol diff --git a/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md b/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md index 029d35dae09d5..7a46142f6ea18 100644 --- a/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md +++ b/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md @@ -1,6 +1,5 @@ +++ title = "Build a logs data source plugin" -type = "docs" +++ # Build a logs data source plugin diff --git a/docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md b/docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md index d68d7e050c4da..b9985c2a9a20e 100644 --- a/docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md +++ b/docs/sources/developers/plugins/build-a-streaming-data-source-plugin.md @@ -1,6 +1,5 @@ +++ title = "Build a streaming data source plugin" -type = "docs" +++ # Build a streaming data source plugin diff --git a/docs/sources/developers/plugins/data-frames.md b/docs/sources/developers/plugins/data-frames.md index e7d0f7225694d..faa23b0dcda46 100644 --- a/docs/sources/developers/plugins/data-frames.md +++ b/docs/sources/developers/plugins/data-frames.md @@ -1,6 +1,5 @@ +++ title = "Data frames" -type = "docs" +++ # Data frames diff --git a/docs/sources/developers/plugins/error-handling.md b/docs/sources/developers/plugins/error-handling.md index c381077b2d7f8..c36ba32319c24 100644 --- a/docs/sources/developers/plugins/error-handling.md +++ b/docs/sources/developers/plugins/error-handling.md @@ -1,6 +1,5 @@ +++ title = "Error handling" -type = "docs" +++ # Error handling diff --git a/docs/sources/developers/plugins/legacy/_index.md b/docs/sources/developers/plugins/legacy/_index.md index fdbc18cc04e11..971ad735e2784 100644 --- a/docs/sources/developers/plugins/legacy/_index.md +++ b/docs/sources/developers/plugins/legacy/_index.md @@ -1,6 +1,5 @@ +++ title = "Legacy plugins" -type = "docs" 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/"] +++ diff --git a/docs/sources/developers/plugins/legacy/apps.md b/docs/sources/developers/plugins/legacy/apps.md index ad9728dfeed1f..d4da640a775e5 100644 --- a/docs/sources/developers/plugins/legacy/apps.md +++ b/docs/sources/developers/plugins/legacy/apps.md @@ -1,7 +1,6 @@ +++ title = "Legacy app plugins" keywords = ["grafana", "plugins", "documentation"] -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/apps/"] +++ diff --git a/docs/sources/developers/plugins/legacy/data-sources.md b/docs/sources/developers/plugins/legacy/data-sources.md index f6fcce44061d7..77ec4f1327380 100644 --- a/docs/sources/developers/plugins/legacy/data-sources.md +++ b/docs/sources/developers/plugins/legacy/data-sources.md @@ -1,7 +1,6 @@ +++ title = "Legacy data source plugins" keywords = ["grafana", "plugins", "documentation"] -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/datasources/"] +++ diff --git a/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md b/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md index 5a8e907404bd5..a8ec4bf4b6d81 100644 --- a/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md +++ b/docs/sources/developers/plugins/legacy/defaults-and-editor-mode.md @@ -1,6 +1,5 @@ +++ title = "Legacy defaults and editor mode" -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/defaults-and-editor-mode/"] +++ diff --git a/docs/sources/developers/plugins/legacy/panels.md b/docs/sources/developers/plugins/legacy/panels.md index a2af7700ce45a..0b6ecac406be8 100644 --- a/docs/sources/developers/plugins/legacy/panels.md +++ b/docs/sources/developers/plugins/legacy/panels.md @@ -1,7 +1,6 @@ +++ title = "Legacy panel plugins" keywords = ["grafana", "plugins", "panel", "documentation"] -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/panels/"] +++ diff --git a/docs/sources/developers/plugins/legacy/review-guidelines.md b/docs/sources/developers/plugins/legacy/review-guidelines.md index b0d93a3d2b4d4..7449b5f63181f 100644 --- a/docs/sources/developers/plugins/legacy/review-guidelines.md +++ b/docs/sources/developers/plugins/legacy/review-guidelines.md @@ -1,6 +1,5 @@ +++ title = "Legacy review guidelines" -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/plugin-review-guidelines/"] +++ diff --git a/docs/sources/developers/plugins/legacy/snapshot-mode.md b/docs/sources/developers/plugins/legacy/snapshot-mode.md index 5e41963de651d..65061bbcaf112 100644 --- a/docs/sources/developers/plugins/legacy/snapshot-mode.md +++ b/docs/sources/developers/plugins/legacy/snapshot-mode.md @@ -1,6 +1,5 @@ +++ title = "Legacy snapshot mode" -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/snapshot-mode/"] +++ diff --git a/docs/sources/developers/plugins/legacy/style-guide.md b/docs/sources/developers/plugins/legacy/style-guide.md index c77152764f03b..73a6e8d0bfd4e 100644 --- a/docs/sources/developers/plugins/legacy/style-guide.md +++ b/docs/sources/developers/plugins/legacy/style-guide.md @@ -1,6 +1,5 @@ +++ title = "Legacy code style guide" -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/code-styleguide/"] +++ diff --git a/docs/sources/developers/plugins/metadata.md b/docs/sources/developers/plugins/metadata.md index bf6be4baf88c0..9a40f8c732a80 100644 --- a/docs/sources/developers/plugins/metadata.md +++ b/docs/sources/developers/plugins/metadata.md @@ -4,7 +4,6 @@ # ------------------------------------------------------------------------- title = "plugin.json" keywords = ["grafana", "plugins", "documentation"] -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/plugin.json/"] +++ diff --git a/docs/sources/developers/plugins/metadata.md.tpl b/docs/sources/developers/plugins/metadata.md.tpl index 3fc7c59e07b30..d120da9fb8f13 100644 --- a/docs/sources/developers/plugins/metadata.md.tpl +++ b/docs/sources/developers/plugins/metadata.md.tpl @@ -4,7 +4,6 @@ # ------------------------------------------------------------------------- title = "plugin.json" keywords = ["grafana", "plugins", "documentation"] -type = "docs" aliases = ["/docs/grafana/latest/plugins/developing/plugin.json/"] +++ diff --git a/docs/sources/developers/plugins/migration-guide.md b/docs/sources/developers/plugins/migration-guide.md index 4354db6b4e49f..51808e435d6fe 100644 --- a/docs/sources/developers/plugins/migration-guide.md +++ b/docs/sources/developers/plugins/migration-guide.md @@ -1,6 +1,5 @@ +++ title = "Plugin migration guide" -type = "docs" +++ # Plugin migration guide diff --git a/docs/sources/developers/plugins/sign-a-plugin.md b/docs/sources/developers/plugins/sign-a-plugin.md index b1e387b187c68..0d1d72c42099a 100644 --- a/docs/sources/developers/plugins/sign-a-plugin.md +++ b/docs/sources/developers/plugins/sign-a-plugin.md @@ -1,6 +1,5 @@ +++ title = "Sign a plugin" -type = "docs" +++ # Sign a plugin diff --git a/docs/sources/developers/plugins/working-with-data-frames.md b/docs/sources/developers/plugins/working-with-data-frames.md index 4a14243e55a05..567a001bcbbf5 100644 --- a/docs/sources/developers/plugins/working-with-data-frames.md +++ b/docs/sources/developers/plugins/working-with-data-frames.md @@ -1,6 +1,5 @@ +++ title = "Working with data frames" -type = "docs" +++ # Working with data frames diff --git a/docs/sources/enterprise/_index.md b/docs/sources/enterprise/_index.md index d56032de7c3b5..24cf52c620e90 100644 --- a/docs/sources/enterprise/_index.md +++ b/docs/sources/enterprise/_index.md @@ -2,11 +2,7 @@ title = "Grafana Enterprise" description = "Grafana Enterprise overview" keywords = ["grafana", "documentation", "datasource", "permissions", "ldap", "licensing", "enterprise", "insights", "reporting"] -type = "docs" -[menu.docs] -name = "Grafana Enterprise" -identifier = "enterprise" -weight = 100 +weight = 150 +++ # Grafana Enterprise diff --git a/docs/sources/enterprise/auditing.md b/docs/sources/enterprise/auditing.md index 477bf3f6593d9..bb53594ca555f 100644 --- a/docs/sources/enterprise/auditing.md +++ b/docs/sources/enterprise/auditing.md @@ -2,9 +2,6 @@ title = "Auditing" description = "Auditing" keywords = ["grafana", "auditing", "audit", "logs"] -type = "docs" -[menu.docs] -parent = "enterprise" weight = 700 +++ diff --git a/docs/sources/enterprise/datasource_permissions.md b/docs/sources/enterprise/datasource_permissions.md index 1555258585522..af4b80d5237b6 100644 --- a/docs/sources/enterprise/datasource_permissions.md +++ b/docs/sources/enterprise/datasource_permissions.md @@ -2,11 +2,6 @@ title = "Data source permissions" description = "Grafana Datasource Permissions Guide " keywords = ["grafana", "configuration", "documentation", "datasource", "permissions", "users", "teams", "enterprise"] -type = "docs" -[menu.docs] -name = "Datasource" -identifier = "datasource-permissions" -parent = "enterprise" weight = 200 +++ diff --git a/docs/sources/enterprise/enhanced_ldap.md b/docs/sources/enterprise/enhanced_ldap.md index 3c673a9d309fc..b1966d4d497eb 100644 --- a/docs/sources/enterprise/enhanced_ldap.md +++ b/docs/sources/enterprise/enhanced_ldap.md @@ -2,11 +2,6 @@ title = "Enhanced LDAP Integration" description = "Grafana Enhanced LDAP Integration Guide " keywords = ["grafana", "configuration", "documentation", "ldap", "active directory", "enterprise"] -type = "docs" -[menu.docs] -name = "Enhanced LDAP" -identifier = "enhanced-ldap" -parent = "enterprise" weight = 300 +++ diff --git a/docs/sources/enterprise/enterprise-configuration.md b/docs/sources/enterprise/enterprise-configuration.md index cd8be1a84ab7a..7ddc3bd0049d9 100644 --- a/docs/sources/enterprise/enterprise-configuration.md +++ b/docs/sources/enterprise/enterprise-configuration.md @@ -2,11 +2,6 @@ title = "Enterprise configuration" description = "Enterprise configuration documentation" keywords = ["grafana", "configuration", "documentation", "enterprise"] -type = "docs" -[menu.docs] -name = "Enterprise configuration" -identifier = "enterprise-config" -parent = "enterprise" weight = 300 +++ diff --git a/docs/sources/enterprise/export-pdf.md b/docs/sources/enterprise/export-pdf.md index 6883c4125395a..4d626b3fa83f0 100644 --- a/docs/sources/enterprise/export-pdf.md +++ b/docs/sources/enterprise/export-pdf.md @@ -2,9 +2,6 @@ title = "Export dashboard as PDF" description = "" keywords = ["grafana", "export", "pdf", "share"] -type = "docs" -[menu.docs] -parent = "enterprise" weight = 900 +++ diff --git a/docs/sources/enterprise/license-expiration.md b/docs/sources/enterprise/license-expiration.md index f4d3ba78700c4..72d5c6444e82a 100644 --- a/docs/sources/enterprise/license-expiration.md +++ b/docs/sources/enterprise/license-expiration.md @@ -2,9 +2,6 @@ title = "License Expiration" description = "" keywords = ["grafana", "licensing"] -type = "docs" -[menu.docs] -parent = "enterprise" weight = 8 +++ diff --git a/docs/sources/enterprise/reporting.md b/docs/sources/enterprise/reporting.md index 5c2af1655c498..79068572d642a 100644 --- a/docs/sources/enterprise/reporting.md +++ b/docs/sources/enterprise/reporting.md @@ -2,10 +2,7 @@ title = "Reporting" description = "" keywords = ["grafana", "reporting"] -type = "docs" aliases = ["/docs/grafana/latest/administration/reports"] -[menu.docs] -parent = "enterprise" weight = 400 +++ @@ -38,8 +35,8 @@ Currently only Organization Admins can create reports. - **Time range -** (optional) Use custom time range for the report. For more information check [Report time range]({{< relref "#report-time-range" >}}). 1. **Preview PDF** to make sure the report appears as you expect. Update if necessary. 1. Enter scheduling information. Options vary depending on the frequency you select. -1. Select the orientation option for generated report: **Portrait** or **Landscape**. -1. Select the layout option for generated report: **Simple** or **Grid**. +1. Select the orientation option for generated report: **Portrait** or **Landscape**. +1. Select the layout option for generated report: **Simple** or **Grid**. 1. **Save** the report. 1. **Send test email** to verify that the whole configuration is working as expected. @@ -67,7 +64,7 @@ All scheduling indicates when the reporting service will start rendering the das Hourly reports are generated once per hour. All fields are required. - **At minute -** The number of minutes after full hour when the report should be generated. -- **Time zone -** Time zone to determine the offset of the full hour. Does not currently change the time in the rendered report. +- **Time zone -** Time zone to determine the offset of the full hour. Does not currently change the time in the rendered report. #### Daily @@ -141,12 +138,12 @@ image_scale_factor = 2 > Setting custom report time range is available in Grafana Enterprise v7.2+. By default, reports use the saved time range of the dashboard. Changing the time range of the report can be done by: -- Saving a modified time range to the dashboard. +- Saving a modified time range to the dashboard. - Setting a time range via **Time range** field in the report form. If specified, then this custom time range overrides the one from the report's dashboard. The page header of the report displays the time range for the dashboard's data queries. Dashboards set to use the browser's time zone will use the time zone on the Grafana server. -If the time zone is set differently between your Grafana server and its remote image renderer, then the time ranges in the report might be different between the page header and the time axes in the panels. We advise always setting the time zone to UTC for dashboards when using a remote renderer to avoid this. +If the time zone is set differently between your Grafana server and its remote image renderer, then the time ranges in the report might be different between the page header and the time axes in the panels. We advise always setting the time zone to UTC for dashboards when using a remote renderer to avoid this. ## Reports settings @@ -154,7 +151,7 @@ If the time zone is set differently between your Grafana server and its remote i You can configure organization-wide report settings in the **Settings** tab on the **Reporting** page. Settings are applied to all the reports for current organization. -You can customize the branding options. +You can customize the branding options. Report branding: **Company logo URL** - Company logo displayed in the report PDF. Defaults to the Grafana logo. @@ -163,8 +160,8 @@ Email branding: - **Company logo URL** - Company logo displayed in the report PDF. Defaults to the Grafana logo. - **Email footer** - Toggle to enable report email footer. Select **Sent by** or **None**. - **Footer link text** - Text for the link in the report email footer. Defaults to "Grafana". -- **Footer link URL** - Link for the report email footer. - +- **Footer link URL** - Link for the report email footer. + {{< docs-imagebox img="/img/docs/enterprise/reports_settings.png" max-width="500px" class="docs-image--no-shadow" >}} ## Troubleshoot reporting diff --git a/docs/sources/enterprise/saml.md b/docs/sources/enterprise/saml.md index bc5c0a78e0b6c..b157a4a0d2dec 100644 --- a/docs/sources/enterprise/saml.md +++ b/docs/sources/enterprise/saml.md @@ -3,10 +3,6 @@ title = "SAML Authentication" description = "Grafana SAML Authentication" keywords = ["grafana", "saml", "documentation", "saml-auth"] aliases = ["/docs/grafana/latest/auth/saml/"] -type = "docs" -[menu.docs] -name = "SAML" -parent = "authentication" weight = 500 +++ @@ -30,10 +26,10 @@ Grafana supports the following SAML 2.0 bindings: - `HTTP-POST` binding In terms of security: -- Grafana supports signed and encrypted assertions. +- Grafana supports signed and encrypted assertions. - Grafana does not support signed or encrypted requests. -In terms of initiation: +In terms of initiation: - Grafana supports SP-initiated requests. - Grafana does not support IdP-initiated request. @@ -67,7 +63,7 @@ The table below describes all SAML configuration options. Continue reading below ### Enable SAML authentication -To use the SAML integration, in the `auth.saml` section of in the Grafana custom configuration file, set `enabled` to `true`. +To use the SAML integration, in the `auth.saml` section of in the Grafana custom configuration file, set `enabled` to `true`. Refer to [Configuration]({{< relref "../administration/configuration.md" >}}) for more information about configuring Grafana. @@ -75,8 +71,8 @@ Refer to [Configuration]({{< relref "../administration/configuration.md" >}}) fo The SAML SSO standard uses asymmetric encryption to exchange information between the SP (Grafana) and the IdP. To perform such encryption, you need a public part and a private part. In this case, the X.509 certificate provides the public part, while the private key provides the private part. -Grafana supports two ways of specifying both the `certificate` and `private_key`. -- Without a suffix (`certificate` or `private_key`), the configuration assumes you've supplied the base64-encoded file contents. +Grafana supports two ways of specifying both the `certificate` and `private_key`. +- Without a suffix (`certificate` or `private_key`), the configuration assumes you've supplied the base64-encoded file contents. - With the `_path` suffix (`certificate_path` or `private_key_path`), then Grafana treats the value entered as a file path and attempts to read the file from the file system. You can only use one form of each configuration option. Using multiple forms, such as both `certificate` and `certificate_path`, results in an error. @@ -91,7 +87,7 @@ The SAML standard recommends using a digital signature for some types of message You also need to define the public part of the IdP for message verification. The SAML IdP metadata XML defines where and how Grafana exchanges user information. -Grafana supports three ways of specifying the IdP metadata. +Grafana supports three ways of specifying the IdP metadata. - Without a suffix `idp_metadata`, Grafana assumes base64-encoded XML file contents. - With the `_path` suffix, Grafana assumes a file path and attempts to read the file from the file system. - With the `_url` suffix, Grafana assumes a URL and attempts to load the metadata from the given location. @@ -139,7 +135,6 @@ For Grafana to map the user information, it looks at the individual attributes w Grafana provides configuration options that let you modify which keys to look at for these values. The data we need to create the user in Grafana is Name, Login handle, and email. -An example is `assertion_attribute_name = "givenName"` where Grafana looks within the assertion for an attribute with a friendly name or name of `givenName`. Both, the friendly name (e.g. `givenName`) or the name (e.g. `urn:oid:2.5.4.42`) can be used interchangeably as the value for the configuration option. ### Configure team sync @@ -180,7 +175,7 @@ role_values_grafana_admin = superadmin > Only available in Grafana v7.0+ -Organization mapping allows you to assign users to particular organization in Grafana depending on attribute value obtained from identity provider. +Organization mapping allows you to assign users to particular organization in Grafana depending on attribute value obtained from identity provider. 1. In configuration file, set [`assertion_attribute_org`]({{< relref "./enterprise-configuration.md#assertion-attribute-org" >}}) to the attribute name you store organization info in. 1. Set [`org_mapping`]({{< relref "./enterprise-configuration.md#org-mapping" >}}) option to the comma-separated list of `Organization:OrgId` pairs to map organization from IdP to Grafana organization specified by id. @@ -250,13 +245,13 @@ To configure SAML integration with Okta, create integration inside the Okta orga - In the **Audience URI (SP Entity ID)** field, use the `/saml/metadata` endpoint URL, for example, `https://grafana.example.com/saml/metadata`. - Leave the default values for **Name ID format** and **Application username**. - In the **ATTRIBUTE STATEMENTS (OPTIONAL)** section, enter the SAML attributes to be shared with Grafana, for example: - + | Attribute name (in Grafana) | Value (in Okta profile) | | --------------------------- | -------------------------------------- | | Login | `user.login` | | Email | `user.email` | | DisplayName | `user.firstName + " " + user.lastName` | - + - In the **GROUP ATTRIBUTE STATEMENTS (OPTIONAL)** section, enter a group attribute name (for example, `Group`) and set filter to `Matches regex .*` to return all user groups. 1. Click **Next**. 1. On the final Feedback tab, fill out the form and then click **Finish**. @@ -269,7 +264,7 @@ Once the application is created, configure Grafana to use it for SAML authentica 1. Configure the [certificate and private key]({{< relref "#certificate-and-private-key" >}}). 1. On the Okta application page where you have been redirected after application created, navigate to the **Sign On** tab and find **Identity Provider metadata** link in the **Settings** section. 1. Set the [`idp_metadata_url`]({{< relref "./enterprise-configuration.md#idp-metadata-url" >}}) to the URL obtained from the previous step. The URL should look like `https://.okta.com/app//sso/saml/metadata`. -1. Set the following options to the attribute names configured at the **step 10** of the SAML integration setup. You can find this attributes on the **General** tab of the application page (**ATTRIBUTE STATEMENTS** and **GROUP ATTRIBUTE STATEMENTS** in the **SAML Settings** section). +1. Set the following options to the attribute names configured at the **step 10** of the SAML integration setup. You can find this attributes on the **General** tab of the application page (**ATTRIBUTE STATEMENTS** and **GROUP ATTRIBUTE STATEMENTS** in the **SAML Settings** section). - [`assertion_attribute_login`]({{< relref "./enterprise-configuration.md#assertion-attribute-login" >}}) - [`assertion_attribute_email`]({{< relref "./enterprise-configuration.md#assertion-attribute-email" >}}) - [`assertion_attribute_name`]({{< relref "./enterprise-configuration.md#assertion-attribute-name" >}}) diff --git a/docs/sources/enterprise/team-sync.md b/docs/sources/enterprise/team-sync.md index a0499c77b4d5e..c9e799c845d69 100644 --- a/docs/sources/enterprise/team-sync.md +++ b/docs/sources/enterprise/team-sync.md @@ -3,10 +3,6 @@ title = "Team sync" description = "Grafana Team Sync" keywords = ["grafana", "auth", "documentation"] aliases = ["/docs/grafana/latest/auth/saml/"] -type = "docs" -[menu.docs] -name = "Team sync" -parent = "enterprise" weight = 600 +++ diff --git a/docs/sources/enterprise/usage-insights.md b/docs/sources/enterprise/usage-insights.md index 09cfee0ec035b..a03d1c24f51aa 100644 --- a/docs/sources/enterprise/usage-insights.md +++ b/docs/sources/enterprise/usage-insights.md @@ -3,10 +3,6 @@ title = "Usage-insights" description = "Usage-insights" keywords = ["grafana", "usage-insights", "enterprise"] aliases = ["/docs/grafana/latest/enterprise/usage-insights/"] -type = "docs" -[menu.docs] -name = "Usage-insights" -parent = "enterprise" weight = 700 +++ @@ -24,7 +20,7 @@ Usage insights allow you to have a better understanding of how your Grafana inst The presence indicator is visible to all signed-in users on all dashboards. It shows the avatars of users who interacted with the dashboard recently (last 10 minutes by default). You can see the user's name by hovering your cursor over the user's avatar. The avatars come from [Gravatar](https://gravatar.com) based on the user's email. -When more users are active on a dashboard than can fit in the presence indicator section, click on the `+X` icon that opens [dashboard insights]({{< relref "#dashboard-insights" >}}) to see more details about recent user activity. +When more users are active on a dashboard than can fit in the presence indicator section, click on the `+X` icon that opens [dashboard insights]({{< relref "#dashboard-insights" >}}) to see more details about recent user activity. {{< docs-imagebox img="/img/docs/enterprise/presence_indicators.png" max-width="400px" class="docs-image--no-shadow" >}} diff --git a/docs/sources/enterprise/vault.md b/docs/sources/enterprise/vault.md index 96ce1dd63cc04..b52b9360836e0 100644 --- a/docs/sources/enterprise/vault.md +++ b/docs/sources/enterprise/vault.md @@ -2,9 +2,6 @@ title = "Vault" description = "" keywords = ["grafana", "vault", "configuration"] -type = "docs" -[menu.docs] -parent = "enterprise" weight = 700 +++ @@ -76,7 +73,7 @@ authorized user. Grafana supports a subset of these which are most likely to be #### Key/Value Grafana supports Vault's [K/V version 2](https://www.vaultproject.io/docs/secrets/kv/kv-v2) storage engine which -is used to store and retrieve arbitrary secrets as `kv`. +is used to store and retrieve arbitrary secrets as `kv`. ```ini $__vault{kv:secret/grafana/smtp:username} diff --git a/docs/sources/enterprise/white-labeling.md b/docs/sources/enterprise/white-labeling.md index 1d93239790ffe..e4bc9a9b1d613 100644 --- a/docs/sources/enterprise/white-labeling.md +++ b/docs/sources/enterprise/white-labeling.md @@ -3,10 +3,6 @@ title = "White-labeling" description = "White-labeling" keywords = ["grafana", "white-labeling", "enterprise"] aliases = ["/docs/grafana/latest/enterprise/white-labeling/"] -type = "docs" -[menu.docs] -name = "White-labeling" -parent = "enterprise" weight = 700 +++ diff --git a/docs/sources/explore/index.md b/docs/sources/explore/index.md index c55c0f2e8c42b..1e3bb1ad4be2b 100644 --- a/docs/sources/explore/index.md +++ b/docs/sources/explore/index.md @@ -1,11 +1,7 @@ +++ title = "Explore" keywords = ["explore", "loki", "logs"] -type = "docs" aliases = ["/docs/grafana/latest/features/explore/"] -[menu.docs] -name = "Explore" -identifier = "explore" weight = 90 +++ diff --git a/docs/sources/getting-started/_index.md b/docs/sources/getting-started/_index.md index 963aec2ac7524..2a9a53bc557d6 100644 --- a/docs/sources/getting-started/_index.md +++ b/docs/sources/getting-started/_index.md @@ -1,9 +1,5 @@ +++ title = "Getting started" -type = "docs" -[menu.docs] -name = "Getting started" -identifier = "getting-started" weight = 10 +++ diff --git a/docs/sources/getting-started/getting-started-prometheus.md b/docs/sources/getting-started/getting-started-prometheus.md index b91e15745dd86..dfe66059fad1b 100644 --- a/docs/sources/getting-started/getting-started-prometheus.md +++ b/docs/sources/getting-started/getting-started-prometheus.md @@ -2,11 +2,7 @@ title = "Getting started with Grafana and Prometheus" description = "Guide for getting started with Grafana" keywords = ["grafana", "intro", "guide", "started"] -type = "docs" aliases = ["/docs/grafana/latest/guides/gettingstarted","/docs/grafana/latest/guides/getting_started"] -[menu.docs] -identifier = "getting_started-grafana-prometheus" -parent = "guides" weight = 300 +++ diff --git a/docs/sources/getting-started/getting-started.md b/docs/sources/getting-started/getting-started.md index e5273dffc673a..87f5a46d24a13 100644 --- a/docs/sources/getting-started/getting-started.md +++ b/docs/sources/getting-started/getting-started.md @@ -2,11 +2,7 @@ title = "Getting started with Grafana" description = "Guide for getting started with Grafana" keywords = ["grafana", "intro", "guide", "started"] -type = "docs" aliases = ["/docs/grafana/latest/guides/gettingstarted","/docs/grafana/latest/guides/getting_started"] -[menu.docs] -identifier = "getting_started-grafana" -parent = "guides" weight = 200 +++ @@ -43,7 +39,7 @@ To create your first dashboard: ## Next steps - Continue to experiment with what you have built, try the [explore workflow]({{< relref "../explore/index.md" >}}) or another visualization feature. Refer to [Data sources]({{< relref "../datasources/_index.md" >}}) for a list of supported data sources and instructions on how to [add a data source]({{< relref "../datasources/add-a-data-source.md" >}}). The following topics will be of interest to you: + Continue to experiment with what you have built, try the [explore workflow]({{< relref "../explore/index.md" >}}) or another visualization feature. Refer to [Data sources]({{< relref "../datasources" >}}) for a list of supported data sources and instructions on how to [add a data source]({{< relref "../datasources/add-a-data-source.md" >}}). The following topics will be of interest to you: - [Panels]({{< relref "../panels/panels-overview.md" >}}) - [Dashboards]({{< relref "../dashboards/_index.md" >}}) diff --git a/docs/sources/getting-started/glossary.md b/docs/sources/getting-started/glossary.md index 73274625ae6e5..2e5e3b7a2e163 100644 --- a/docs/sources/getting-started/glossary.md +++ b/docs/sources/getting-started/glossary.md @@ -2,12 +2,7 @@ title = "Glossary" description = "Grafana glossary" keywords = ["grafana", "intro", "glossary", "dictionary"] -type = "docs" aliases = ["/docs/grafana/latest/guides/glossary"] -[menu.docs] -name = "Glossary" -identifier = "glossary" -parent = "guides" weight = 500 +++ @@ -114,7 +109,7 @@ This topic lists words and abbreviations that are commonly used in the Grafana d Transformation - Transformations process the result set of a query before it’s passed on for visualization. + Transformations process the result set of a query before it’s passed on for visualization. diff --git a/docs/sources/getting-started/intro-histograms.md b/docs/sources/getting-started/intro-histograms.md index eeb2bd34096cb..c48bb243506c6 100644 --- a/docs/sources/getting-started/intro-histograms.md +++ b/docs/sources/getting-started/intro-histograms.md @@ -2,10 +2,6 @@ title = "Histograms and heatmaps" description = "An introduction to histograms and heatmaps" keywords = ["grafana", "heatmap", "panel", "documentation", "histogram"] -type = "docs" -[menu.docs] -name = "intro-to-histograms" -parent = "panels" weight = 400 +++ diff --git a/docs/sources/getting-started/timeseries-dimensions.md b/docs/sources/getting-started/timeseries-dimensions.md index 86b53c013b0df..fc39148437229 100644 --- a/docs/sources/getting-started/timeseries-dimensions.md +++ b/docs/sources/getting-started/timeseries-dimensions.md @@ -2,12 +2,7 @@ title = "Time series dimensions" description = "time series dimensions" keywords = ["grafana", "intro", "guide", "concepts", "timeseries", "labels"] -type = "docs" aliases = ["/docs/grafana/latest/guides/timeseries-dimensions"] -[menu.docs] -name = "Time series dimensions" -identifier = "time_series_dimensions" -parent = "guides" weight = 300 +++ diff --git a/docs/sources/getting-started/timeseries.md b/docs/sources/getting-started/timeseries.md index 739c034143bfd..c5cd174908c0a 100644 --- a/docs/sources/getting-started/timeseries.md +++ b/docs/sources/getting-started/timeseries.md @@ -2,12 +2,7 @@ title = "Time series" description = "Introduction to time series" keywords = ["grafana", "intro", "guide", "concepts", "timeseries"] -type = "docs" aliases = ["/docs/grafana/latest/guides/timeseries"] -[menu.docs] -name = "Time series" -identifier = "time_series" -parent = "guides" weight = 300 +++ @@ -38,7 +33,7 @@ While each of these examples are sequences of chronologically ordered measuremen - New data is appended at the end, at regular intervals—for example, hourly at 09:00, 10:00, 11:00, and so on. - Measurements are seldom updated after they were added—for example, yesterday's temperature doesn't change. -Time series are powerful. They help you understand the past by letting you analyze the state of the system at any point in time. Time series could tell you that the server crashed moments after the free disk space went down to zero. +Time series are powerful. They help you understand the past by letting you analyze the state of the system at any point in time. Time series could tell you that the server crashed moments after the free disk space went down to zero. Time series can also help you predict the future, by uncovering trends in your data. If the number of registered users has been increasing monthly by 4% for the past few months, you can predict how big your user base is going to be at the end of the year. @@ -65,9 +60,9 @@ In the IT industry, time series data is often collected to monitor things like i ### Time series databases -A time series database (TSDB) is a database explicitly designed for time series data. While it's possible to use any regular database to store measurements, a TSDB comes with some useful optimizations. +A time series database (TSDB) is a database explicitly designed for time series data. While it's possible to use any regular database to store measurements, a TSDB comes with some useful optimizations. -Modern time series databases take advantage of the fact that measurements are only ever appended, and rarely updated or removed. For example, the timestamps for each measurement change very little over time, which results in redundant data being stored. +Modern time series databases take advantage of the fact that measurements are only ever appended, and rarely updated or removed. For example, the timestamps for each measurement change very little over time, which results in redundant data being stored. Look at this sequence of Unix timestamps: diff --git a/docs/sources/getting-started/what-is-grafana.md b/docs/sources/getting-started/what-is-grafana.md index 7b34bb838c570..f9e52903d4185 100644 --- a/docs/sources/getting-started/what-is-grafana.md +++ b/docs/sources/getting-started/what-is-grafana.md @@ -2,12 +2,7 @@ title = "What is Grafana?" description = "Overview of Grafana and features" keywords = ["grafana", "intro", "guide", "started"] -type = "docs" -[menu.docs] aliases = ["/docs/grafana/latest/guides/what-is-grafana"] -name = "What is Grafana?" -identifier = "what_is_grafana" -parent = "guides" weight = 200 +++ @@ -17,7 +12,7 @@ This topic provides a high-level look at Grafana, the Grafana process, and Grafa Grafana is open source visualization and analytics software. It allows you to query, visualize, alert on, and explore your metrics no matter where they are stored. In plain English, it provides you with tools to turn your time-series database (TSDB) data into beautiful graphs and visualizations. -After creating a dashboard like you do in [Getting started]({{< relref "getting-started.md" >}}), there are many possible things you might do next. It all depends on your needs and your use case. +After creating a dashboard like you do in [Getting started]({{< relref "getting-started.md" >}}), there are many possible things you might do next. It all depends on your needs and your use case. For example, if you want to view weather data and statistics about your smart home, then you might create a playlist. If you are the administrator for a corporation and are managing Grafana for multiple teams, then you might need to set up provisioning and authentication. @@ -25,13 +20,13 @@ The following sections provide an overview of things you might want to do with y ## Explore metrics and logs -Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. +Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. Refer to [Explore]({{< relref "../explore/index.md" >}}) for more information. ## Alerts -If you're using Grafana alerting, then you can have alerts sent through a number of different [alert notifiers]({{< relref "../alerting/notifications.md" >}}), including PagerDuty, SMS, email, VictorOps, OpsGenie, or Slack. +If you're using Grafana alerting, then you can have alerts sent through a number of different [alert notifiers]({{< relref "../alerting/notifications.md" >}}), including PagerDuty, SMS, email, VictorOps, OpsGenie, or Slack. Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules]({{< relref "../alerting/alerts-overview.md" >}}) for your most important metrics. @@ -45,7 +40,7 @@ Refer to [Annotations]({{< relref "../dashboards/annotations.md" >}}) for more i ## Dashboard variables -[Template variables]({{< relref "../variables/_index.md" >}}) allow you to create dashboards that can be reused for lots of different use cases. Values aren't hard-coded with these templates, so for instance, if you have a production server and a test server, you can use the same dashboard for both. +[Template variables]({{< relref "../variables/_index.md" >}}) allow you to create dashboards that can be reused for lots of different use cases. Values aren't hard-coded with these templates, so for instance, if you have a production server and a test server, you can use the same dashboard for both. Templating allows you to drill down into your data, say, from all data to North America data, down to Texas data, and beyond. You can also share these dashboards across teams within your organization—or if you create a great dashboard template for a popular data source, you can contribute it to the whole community to customize and use. @@ -69,7 +64,7 @@ Refer to [Grafana Enterprise]({{< relref "../enterprise/_index.md" >}}) for more ## Provisioning -While it's easy to click, drag, and drop to create a single dashboard, power users in need of many dashboards will want to automate the setup with a script. You can script anything in Grafana. +While it's easy to click, drag, and drop to create a single dashboard, power users in need of many dashboards will want to automate the setup with a script. You can script anything in Grafana. For example, if you're spinning up a new Kubernetes cluster, you can also spin up a Grafana automatically with a script that would have the right server, IP address, and data sources preset and locked in so users cannot change them. It's also a way of getting control over a lot of dashboards. diff --git a/docs/sources/http_api/_index.md b/docs/sources/http_api/_index.md index 5f924e661517e..8e73fa83a1485 100644 --- a/docs/sources/http_api/_index.md +++ b/docs/sources/http_api/_index.md @@ -3,11 +3,7 @@ title = "HTTP API" description = "Grafana HTTP API" keywords = ["grafana", "http", "documentation", "api", "overview"] aliases = ["/docs/grafana/latest/overview"] -type = "docs" -[menu.docs] -name = "HTTP API" -identifier = "http_api" -weight = 9 +weight = 170 +++ diff --git a/docs/sources/http_api/admin.md b/docs/sources/http_api/admin.md index 69c72f41890c4..17197770ae817 100644 --- a/docs/sources/http_api/admin.md +++ b/docs/sources/http_api/admin.md @@ -3,10 +3,6 @@ title = "Admin HTTP API " description = "Grafana Admin HTTP API" keywords = ["grafana", "http", "documentation", "api", "admin"] aliases = ["/docs/grafana/latest/http_api/admin/"] -type = "docs" -[menu.docs] -name = "Admin" -parent = "http_api" +++ # Admin API diff --git a/docs/sources/http_api/alerting.md b/docs/sources/http_api/alerting.md index 5d6637fe3b83a..ffad5b223bc67 100644 --- a/docs/sources/http_api/alerting.md +++ b/docs/sources/http_api/alerting.md @@ -3,10 +3,6 @@ title = "Alerting HTTP API " description = "Grafana Alerts HTTP API" keywords = ["grafana", "http", "documentation", "api", "alerting", "alerts"] aliases = ["/docs/grafana/latest/http_api/alerting/"] -type = "docs" -[menu.docs] -name = "Alerting" -parent = "http_api" +++ # Alerting API diff --git a/docs/sources/http_api/alerting_notification_channels.md b/docs/sources/http_api/alerting_notification_channels.md index 47f2e209b540b..e78cf7f8351a2 100644 --- a/docs/sources/http_api/alerting_notification_channels.md +++ b/docs/sources/http_api/alerting_notification_channels.md @@ -3,10 +3,6 @@ title = "Alerting Notification Channels HTTP API " description = "Grafana Alerting Notification Channel HTTP API" keywords = ["grafana", "http", "documentation", "api", "alerting", "alerts", "notifications"] aliases = [] -type = "docs" -[menu.docs] -name = "Alerting Notification Channels" -parent = "http_api" +++ # Alerting Notification Channels API diff --git a/docs/sources/http_api/annotations.md b/docs/sources/http_api/annotations.md index 739fdaa214169..71c2194722058 100644 --- a/docs/sources/http_api/annotations.md +++ b/docs/sources/http_api/annotations.md @@ -3,11 +3,6 @@ title = "Annotations HTTP API " description = "Grafana Annotations HTTP API" keywords = ["grafana", "http", "documentation", "api", "annotation", "annotations", "comment"] aliases = ["/docs/grafana/latest/http_api/annotations/"] -type = "docs" -[menu.docs] -name = "Annotations" -identifier = "annotationshttp" -parent = "http_api" +++ # Annotations resources / actions diff --git a/docs/sources/http_api/auth.md b/docs/sources/http_api/auth.md index 068df5bd99fff..5f0755c604b75 100755 --- a/docs/sources/http_api/auth.md +++ b/docs/sources/http_api/auth.md @@ -3,10 +3,6 @@ title = "Authentication HTTP API " description = "Grafana Authentication HTTP API" keywords = ["grafana", "http", "documentation", "api", "authentication"] aliases = ["/docs/grafana/latest/http_api/authentication/"] -type = "docs" -[menu.docs] -name = "Authentication HTTP API" -parent = "http_api" +++ # Authentication API diff --git a/docs/sources/http_api/create-api-tokens-for-org.md b/docs/sources/http_api/create-api-tokens-for-org.md index f04d34b423adc..d1e4adaf6e7bb 100644 --- a/docs/sources/http_api/create-api-tokens-for-org.md +++ b/docs/sources/http_api/create-api-tokens-for-org.md @@ -1,9 +1,7 @@ +++ title = "API Tutorial: Create API tokens and dashboards for an organization" -type = "docs" keywords = ["grafana", "tutorials", "API", "Token", "Org", "Organization"] aliases =["/docs/grafana/latest/tutorials/api_org_token_howto/"] -[menu.docs] weight = 150 +++ @@ -13,9 +11,9 @@ Use the Grafana API to set up new Grafana organizations or to add dynamically ge ## Authentication -There are two authentication methods to access the API: +There are two authentication methods to access the API: -- Basic authentication: A Grafana Admin user can access some parts of the Grafana API through basic authentication. +- Basic authentication: A Grafana Admin user can access some parts of the Grafana API through basic authentication. - API Tokens: All organization actions are accessed through an API Token. An API Token is associated with an organization. It can be used to create dashboards and other components specific for that organization. ## How to create a new organization and an API Token diff --git a/docs/sources/http_api/curl-examples.md b/docs/sources/http_api/curl-examples.md index cb1399c3d77ff..20d77a7b6f7bf 100644 --- a/docs/sources/http_api/curl-examples.md +++ b/docs/sources/http_api/curl-examples.md @@ -2,8 +2,6 @@ title = "cURL examples" description = "cURL examples" keywords = ["grafana", "http", "documentation", "api", "curl"] -type = "docs" -[menu.docs] +++ # cURL examples diff --git a/docs/sources/http_api/dashboard.md b/docs/sources/http_api/dashboard.md index 8fdbbf8df290c..b8b7684c2d95c 100644 --- a/docs/sources/http_api/dashboard.md +++ b/docs/sources/http_api/dashboard.md @@ -3,10 +3,6 @@ title = "Dashboard HTTP API " description = "Grafana Dashboard HTTP API" keywords = ["grafana", "http", "documentation", "api", "dashboard"] aliases = ["/docs/grafana/latest/http_api/dashboard/"] -type = "docs" -[menu.docs] -name = "Dashboard" -parent = "http_api" +++ # Dashboard API diff --git a/docs/sources/http_api/dashboard_permissions.md b/docs/sources/http_api/dashboard_permissions.md index bde9011898198..3496b90390d05 100644 --- a/docs/sources/http_api/dashboard_permissions.md +++ b/docs/sources/http_api/dashboard_permissions.md @@ -3,10 +3,6 @@ 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/"] -type = "docs" -[menu.docs] -name = "Dashboard Permissions" -parent = "http_api" +++ # Dashboard Permissions API diff --git a/docs/sources/http_api/dashboard_versions.md b/docs/sources/http_api/dashboard_versions.md index a6c5f9122b7b5..e15bec235ac03 100644 --- a/docs/sources/http_api/dashboard_versions.md +++ b/docs/sources/http_api/dashboard_versions.md @@ -3,10 +3,6 @@ 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/"] -type = "docs" -[menu.docs] -name = "Dashboard Versions" -parent = "http_api" +++ # Dashboard Versions diff --git a/docs/sources/http_api/data_source.md b/docs/sources/http_api/data_source.md index 0cc276d0953e1..b774263e0815f 100644 --- a/docs/sources/http_api/data_source.md +++ b/docs/sources/http_api/data_source.md @@ -3,10 +3,6 @@ title = "Data source HTTP API " description = "Grafana Data source HTTP API" keywords = ["grafana", "http", "documentation", "api", "data source"] aliases = ["/docs/grafana/latest/http_api/datasource/"] -type = "docs" -[menu.docs] -name = "Data source" -parent = "http_api" +++ diff --git a/docs/sources/http_api/datasource_permissions.md b/docs/sources/http_api/datasource_permissions.md index 61c0907660d58..66f6e93ba7cb9 100644 --- a/docs/sources/http_api/datasource_permissions.md +++ b/docs/sources/http_api/datasource_permissions.md @@ -3,10 +3,6 @@ title = "Datasource Permissions HTTP API " description = "Data Source Permissions API" keywords = ["grafana", "http", "documentation", "api", "datasource", "permission", "permissions", "acl", "enterprise"] aliases = ["/docs/grafana/latest/http_api/datasourcepermissions/"] -type = "docs" -[menu.docs] -name = "Datasource Permissions" -parent = "http_api" +++ # Data Source Permissions API diff --git a/docs/sources/http_api/external_group_sync.md b/docs/sources/http_api/external_group_sync.md index f9fe23f27e023..4930de025f59a 100644 --- a/docs/sources/http_api/external_group_sync.md +++ b/docs/sources/http_api/external_group_sync.md @@ -3,10 +3,6 @@ title = "External Group Sync HTTP API " description = "Grafana External Group Sync HTTP API" keywords = ["grafana", "http", "documentation", "api", "team", "teams", "group", "member", "enterprise"] aliases = ["/docs/grafana/latest/http_api/external_group_sync/"] -type = "docs" -[menu.docs] -name = "External Group Sync" -parent = "http_api" +++ # External Group Synchronization API diff --git a/docs/sources/http_api/folder.md b/docs/sources/http_api/folder.md index 6828e8a852b8f..b1d81c6c79999 100644 --- a/docs/sources/http_api/folder.md +++ b/docs/sources/http_api/folder.md @@ -3,10 +3,6 @@ title = "Folder HTTP API " description = "Grafana Folder HTTP API" keywords = ["grafana", "http", "documentation", "api", "folder"] aliases = ["/docs/grafana/latest/http_api/folder/"] -type = "docs" -[menu.docs] -name = "Folder" -parent = "http_api" +++ # Folder API diff --git a/docs/sources/http_api/folder_dashboard_search.md b/docs/sources/http_api/folder_dashboard_search.md index a5c37acdc865a..987665b95454e 100644 --- a/docs/sources/http_api/folder_dashboard_search.md +++ b/docs/sources/http_api/folder_dashboard_search.md @@ -3,10 +3,6 @@ title = "Folder/Dashboard Search HTTP API " description = "Grafana Folder/Dashboard Search HTTP API" keywords = ["grafana", "http", "documentation", "api", "search", "folder", "dashboard"] aliases = ["/docs/grafana/latest/http_api/folder_dashboard_search/"] -type = "docs" -[menu.docs] -name = "Folder/dashboard search" -parent = "http_api" +++ # Folder/Dashboard Search API diff --git a/docs/sources/http_api/folder_permissions.md b/docs/sources/http_api/folder_permissions.md index 2147c4d70518c..5637ac9989f59 100644 --- a/docs/sources/http_api/folder_permissions.md +++ b/docs/sources/http_api/folder_permissions.md @@ -3,10 +3,6 @@ title = "Folder Permissions HTTP API " description = "Grafana Folder Permissions HTTP API" keywords = ["grafana", "http", "documentation", "api", "folder", "permission", "permissions", "acl"] aliases = ["/docs/grafana/latest/http_api/dashboardpermissions/"] -type = "docs" -[menu.docs] -name = "Folder Permissions" -parent = "http_api" +++ # Folder Permissions API diff --git a/docs/sources/http_api/org.md b/docs/sources/http_api/org.md index dbf1c7dfc5d18..95753476ac1ee 100644 --- a/docs/sources/http_api/org.md +++ b/docs/sources/http_api/org.md @@ -3,10 +3,6 @@ title = "Organization HTTP API " description = "Grafana Organization HTTP API" keywords = ["grafana", "http", "documentation", "api", "organization"] aliases = ["/docs/grafana/latest/http_api/organization/"] -type = "docs" -[menu.docs] -name = "Organization" -parent = "http_api" +++ diff --git a/docs/sources/http_api/other.md b/docs/sources/http_api/other.md index 0097e43c40dac..005d8fb34222c 100644 --- a/docs/sources/http_api/other.md +++ b/docs/sources/http_api/other.md @@ -3,10 +3,6 @@ title = "Other HTTP API " description = "Grafana Other HTTP API" keywords = ["grafana", "http", "documentation", "api", "other"] aliases = ["/docs/grafana/latest/http_api/other/"] -type = "docs" -[menu.docs] -name = "Other" -parent = "http_api" +++ diff --git a/docs/sources/http_api/playlist.md b/docs/sources/http_api/playlist.md index bbc243066fb37..5f94c513141a6 100644 --- a/docs/sources/http_api/playlist.md +++ b/docs/sources/http_api/playlist.md @@ -3,11 +3,6 @@ title = "Playlist HTTP API " description = "Playlist Admin HTTP API" keywords = ["grafana", "http", "documentation", "api", "playlist"] aliases = ["/docs/grafana/latest/http_api/playlist/"] -type = "docs" -[menu.docs] -name = "Playlist" -parent = "http_api" -identifier = "http_api_playlist" +++ # Playlist API diff --git a/docs/sources/http_api/preferences.md b/docs/sources/http_api/preferences.md index 192a2fb82e4b9..c624fad8359d2 100644 --- a/docs/sources/http_api/preferences.md +++ b/docs/sources/http_api/preferences.md @@ -3,10 +3,6 @@ title = "HTTP Preferences API " description = "Grafana HTTP API" keywords = ["grafana", "http", "documentation", "api", "preferences"] aliases = ["/docs/grafana/latest/http_api/preferences/"] -type = "docs" -[menu.docs] -name = "Preferences" -parent = "http_api" +++ # User and Org Preferences API diff --git a/docs/sources/http_api/reporting.md b/docs/sources/http_api/reporting.md index 2bc8f35f7b37c..b24bfb3af35c3 100644 --- a/docs/sources/http_api/reporting.md +++ b/docs/sources/http_api/reporting.md @@ -3,10 +3,6 @@ title = "Reporting API" description = "Grafana Enterprise APIs" keywords = ["grafana", "enterprise", "api", "reporting"] aliases = ["/docs/grafana/latest/http_api/reporting/"] -type = "docs" -[menu.docs] -name = "Reporting API" -parent = "http_api" +++ # Reporting API diff --git a/docs/sources/http_api/short_url.md b/docs/sources/http_api/short_url.md index b1b68c51dc1e2..f982ec3f62826 100644 --- a/docs/sources/http_api/short_url.md +++ b/docs/sources/http_api/short_url.md @@ -3,10 +3,6 @@ title = "Short URL HTTP API " description = "Grafana Short URL HTTP API" keywords = ["grafana", "http", "documentation", "api", "shortUrl"] aliases = ["/docs/grafana/latest/http_api/short_url/"] -type = "docs" -[menu.docs] -name = "Short URL" -parent = "http_api" +++ # Short URL API diff --git a/docs/sources/http_api/snapshot.md b/docs/sources/http_api/snapshot.md index c85c171dcb7a5..778087b620e04 100644 --- a/docs/sources/http_api/snapshot.md +++ b/docs/sources/http_api/snapshot.md @@ -3,10 +3,6 @@ title = "HTTP Snapshot API " description = "Grafana HTTP API" keywords = ["grafana", "http", "documentation", "api", "snapshot"] aliases = ["/docs/grafana/latest/http_api/snapshot/"] -type = "docs" -[menu.docs] -name = "Snapshot" -parent = "http_api" +++ # Snapshot API diff --git a/docs/sources/http_api/team.md b/docs/sources/http_api/team.md index e62d4e7546062..508266817e133 100644 --- a/docs/sources/http_api/team.md +++ b/docs/sources/http_api/team.md @@ -3,10 +3,6 @@ title = "Team HTTP API " description = "Grafana Team HTTP API" keywords = ["grafana", "http", "documentation", "api", "team", "teams", "group"] aliases = ["/docs/grafana/latest/http_api/team/"] -type = "docs" -[menu.docs] -name = "Teams" -parent = "http_api" +++ # Team API diff --git a/docs/sources/http_api/user.md b/docs/sources/http_api/user.md index 9d06f95f87dd9..2aea21668347d 100644 --- a/docs/sources/http_api/user.md +++ b/docs/sources/http_api/user.md @@ -3,10 +3,6 @@ title = "User HTTP API " description = "Grafana User HTTP API" keywords = ["grafana", "http", "documentation", "api", "user"] aliases = ["/docs/grafana/latest/http_api/user/"] -type = "docs" -[menu.docs] -name = "Users" -parent = "http_api" +++ # User HTTP resources / actions diff --git a/docs/sources/installation/_index.md b/docs/sources/installation/_index.md index 6412a138a57dc..1a07feb334c2f 100644 --- a/docs/sources/installation/_index.md +++ b/docs/sources/installation/_index.md @@ -2,11 +2,7 @@ title = "Installation" description = "Installation guide for Grafana" keywords = ["grafana", "installation", "documentation"] -type = "docs" aliases = ["/docs/grafana/latest/installation/installation/", "/docs/grafana/v2.1/installation/install/", "/docs/grafana/latest/install"] -[menu.docs] -name = "Installation" -identifier = "installation" weight = 30 +++ diff --git a/docs/sources/installation/debian.md b/docs/sources/installation/debian.md index 8c0d1c1a83d6c..edc53a8125f8a 100644 --- a/docs/sources/installation/debian.md +++ b/docs/sources/installation/debian.md @@ -2,11 +2,7 @@ title = "Install on Debian/Ubuntu" description = "Install guide for Grafana on Debian or Ubuntu" keywords = ["grafana", "installation", "documentation"] -type = "docs" aliases = ["/docs/grafana/latest/installation/installation/debian"] -[menu.docs] -identifier = "debian" -parent = "installation" weight = 200 +++ @@ -22,7 +18,7 @@ You can install Grafana using our official APT repository, by downloading a `.de ### Install from APT repository -If you install from the APT repository, then Grafana is automatically updated every time you run `apt-get update`. +If you install from the APT repository, then Grafana is automatically updated every time you run `apt-get update`. | Grafana Version | Package | Repository | |-----------------|---------|------------| @@ -44,12 +40,12 @@ wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add - Add this repository for stable releases: ```bash -echo "deb https://packages.grafana.com/enterprise/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list +echo "deb https://packages.grafana.com/enterprise/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list ``` Add this repository if you want beta releases: ```bash -echo "deb https://packages.grafana.com/enterprise/deb beta main" | sudo tee -a /etc/apt/sources.list.d/grafana.list +echo "deb https://packages.grafana.com/enterprise/deb beta main" | sudo tee -a /etc/apt/sources.list.d/grafana.list ``` After you add the repository: @@ -70,12 +66,12 @@ wget -q -O - https://packages.grafana.com/gpg.key | sudo apt-key add - Add this repository for stable releases: ```bash -echo "deb https://packages.grafana.com/oss/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list +echo "deb https://packages.grafana.com/oss/deb stable main" | sudo tee -a /etc/apt/sources.list.d/grafana.list ``` Add this repository if you want beta releases: ```bash -echo "deb https://packages.grafana.com/oss/deb beta main" | sudo tee -a /etc/apt/sources.list.d/grafana.list +echo "deb https://packages.grafana.com/oss/deb beta main" | sudo tee -a /etc/apt/sources.list.d/grafana.list ``` After you add the repository: @@ -89,7 +85,7 @@ sudo apt-get install grafana If you install the `.deb` package, then you will need to manually update Grafana for each new version. -1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install. +1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install. * The most recent Grafana version is selected by default. * The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version. 1. Select an **Edition**. @@ -154,7 +150,7 @@ sudo update-rc.d grafana-server defaults The `grafana-server` binary .tar.gz needs the working directory to be the root install directory where the binary and the `public` folder are located. -Start Grafana by running: +Start Grafana by running: ```bash ./bin/grafana-server web ``` diff --git a/docs/sources/installation/docker.md b/docs/sources/installation/docker.md index 5529af140d7e6..aac805c181d7e 100755 --- a/docs/sources/installation/docker.md +++ b/docs/sources/installation/docker.md @@ -2,11 +2,6 @@ title = "Run Grafana Docker image" description = "Guide for running Grafana using Docker" keywords = ["grafana", "configuration", "documentation", "docker"] -type = "docs" -[menu.docs] -name = "Run Grafana Docker image" -identifier = "docker" -parent = "installation" weight = 600 +++ diff --git a/docs/sources/installation/mac.md b/docs/sources/installation/mac.md index 32232c3e0c66d..8451fc3bac7f2 100755 --- a/docs/sources/installation/mac.md +++ b/docs/sources/installation/mac.md @@ -2,9 +2,6 @@ title = "Install on macOS" description = "Installing Grafana on macOS" keywords = ["grafana", "configuration", "documentation", "mac", "homebrew", "osx"] -type = "docs" -[menu.docs] -parent = "installation" weight = 500 +++ @@ -18,7 +15,7 @@ This page explains how to install Grafana and get the service running on your ma Use [Homebrew](http://brew.sh/) to install the most recent released version of Grafana using Homebrew package. -1. On the Homberew homepage, search for Grafana. The last stable and released version is listed. +1. On the Homberew homepage, search for Grafana. The last stable and released version is listed. 1. Open a terminal and enter: ``` brew update diff --git a/docs/sources/installation/requirements.md b/docs/sources/installation/requirements.md index 530ef3efb6c11..62ca8ec9eccf8 100644 --- a/docs/sources/installation/requirements.md +++ b/docs/sources/installation/requirements.md @@ -2,11 +2,6 @@ title = "Requirements" description = "Requirements for Grafana" keywords = ["grafana", "installation", "documentation"] -type = "docs" -[menu.docs] -name = "Requirements" -identifier = "requirements" -parent = "installation" weight = 100 +++ @@ -29,7 +24,7 @@ Installation of Grafana on other operating systems is possible, but it is neithe ## Hardware recommendations -Grafana does not use a lot of resources and is very lightweight in use of memory and CPU. +Grafana does not use a lot of resources and is very lightweight in use of memory and CPU. Minimum recommended memory: 255 MB Minimum recommended CPU: 1 diff --git a/docs/sources/installation/rpm.md b/docs/sources/installation/rpm.md index 17858a8cf8dbe..47f3ed7aa8335 100755 --- a/docs/sources/installation/rpm.md +++ b/docs/sources/installation/rpm.md @@ -3,11 +3,6 @@ title = "Install on RPM-based Linux" description = "Grafana Installation guide for RPM-based Linux, such as Centos, Fedora, OpenSuse, and Red Hat." keywords = ["grafana", "installation", "documentation", "centos", "fedora", "opensuse", "redhat"] aliases = ["/docs/grafana/latest/installation/installation/rpm"] -type = "docs" -[menu.docs] -name = "Install on RPM-based Linux" -identifier = "rpm" -parent = "installation" weight = 300 +++ @@ -84,7 +79,7 @@ sudo yum install grafana-enterprise If you install manually with YUM, then you will need to manually update Grafana for each new version. To enable automatic updates for your Grafana installation please use the instructions below to install via our YUM repository. -1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install. +1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install. - The most recent Grafana version is selected by default. - The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version. 1. Select an **Edition**. @@ -109,7 +104,7 @@ If you install with RPM, then you will need to manually update Grafana for each **Note:** The .rpm files are signed, you can verify the signature with this [public GPG key](https://packages.grafana.com/gpg.key). -1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install. +1. On the [Grafana download page](https://grafana.com/grafana/download), select the Grafana version you want to install. - The most recent Grafana version is selected by default. - The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version. 1. Select an **Edition**. @@ -185,7 +180,7 @@ sudo /sbin/chkconfig --add grafana-server The `grafana-server` binary needs the working directory to be the root install directory where the binary and the `public` folder are located. -Start Grafana by running: +Start Grafana by running: ```bash ./bin/grafana-server web ``` diff --git a/docs/sources/installation/upgrading.md b/docs/sources/installation/upgrading.md index cecb43911756e..f49a11e6aa1af 100755 --- a/docs/sources/installation/upgrading.md +++ b/docs/sources/installation/upgrading.md @@ -2,11 +2,6 @@ title = "Upgrade Grafana" description = "Guide for upgrading Grafana" keywords = ["grafana", "configuration", "documentation", "upgrade"] -type = "docs" -[menu.docs] -name = "Upgrade Grafana" -identifier = "upgrading" -parent = "installation" weight = 700 +++ diff --git a/docs/sources/installation/windows.md b/docs/sources/installation/windows.md index 48c2aa6a774d8..aaa7be44255ed 100644 --- a/docs/sources/installation/windows.md +++ b/docs/sources/installation/windows.md @@ -2,9 +2,6 @@ title = "Install on Windows" description = "Install Grafana on Windows" keywords = ["grafana", "configuration", "documentation", "windows"] -type = "docs" -[menu.docs] -parent = "installation" weight = 400 +++ @@ -16,7 +13,7 @@ Read [Upgrading Grafana]({{< relref "upgrading.md" >}}) for tips and guidance on installation. 1. Navigate to [Download Grafana](https://grafana.com/grafana/download?platform=windows). -1. Select a Grafana version you want to install. +1. Select a Grafana version you want to install. - The most recent Grafana version is selected by default. - The **Version** field displays only finished releases. If you want to install a beta version, click **Nightly Builds** and then select a version. 1. Select an **Edition**. @@ -29,7 +26,7 @@ You can either use the Windows installer or you can install a standalone Windows ## Install with Windows installer (recommended) 1. Click **Download the installer**. -1. Open and run the installer. +1. Open and run the installer. To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../getting-started/getting-started/" >}}). @@ -38,7 +35,7 @@ To run Grafana, open your browser and go to the Grafana port (http://localhost:3 1. Click **Download the zip file**. **Important:** After you've downloaded the zip file and before extracting it, make sure to open the properties for that file (right-click **Properties**) and select the `unblock` check box and then click `Ok`. -1. Extract this folder to anywhere you want Grafana to run from. +1. Extract this folder to anywhere you want Grafana to run from. 1. Start Grafana by executing `grafana-server.exe`, located in the `bin` directory, preferably from the command line. If you want to run Grafana as a Windows service, then download [NSSM](https://nssm.cc/). It is very easy to add Grafana as a Windows service using that tool. diff --git a/docs/sources/jsearch.md b/docs/sources/jsearch.md deleted file mode 100644 index 56e9b7c48f511..0000000000000 --- a/docs/sources/jsearch.md +++ /dev/null @@ -1,15 +0,0 @@ -page_title: Search the Grafana documentation -page_keywords: Grafana, search documentation -no_toc: true -no_version_dropdown: true - -# Search - -
- - -
- -
-Sorry, page not found. -
diff --git a/docs/sources/linking/_index.md b/docs/sources/linking/_index.md index c1d7e807ca93a..63a218c6ef580 100644 --- a/docs/sources/linking/_index.md +++ b/docs/sources/linking/_index.md @@ -1,9 +1,6 @@ +++ title = "Linking" -type = "docs" -[menu.docs] -identifier = "linking" -weight = 100 +weight = 120 +++ # Linking overview diff --git a/docs/sources/linking/dashboard-links.md b/docs/sources/linking/dashboard-links.md index 67eb43c4a0982..2b71bd07aad76 100644 --- a/docs/sources/linking/dashboard-links.md +++ b/docs/sources/linking/dashboard-links.md @@ -2,9 +2,6 @@ title = "Dashboard links" description = "" keywords = ["grafana", "linking", "create links", "link dashboards", "navigate"] -type = "docs" -[menu.docs] -parent = "linking" weight = 200 +++ @@ -14,7 +11,7 @@ When you create a dashboard link, you can include the time range and current tem Dashboard links can also be used as shortcuts to external systems, such as submitting [a GitHub issue with the current dashboard name](https://github.com/grafana/grafana/issues/new?title=Dashboard%3A%20HTTP%20Requests). -To see an example of dashboard links in action, check out: +To see an example of dashboard links in action, check out: - [Dashboard links with variables](https://play.grafana.org/d/rUpVRdamz/dashboard-links-with-variables?orgId=1) - [Prometheus repeat](https://play.grafana.org/d/000000036/prometheus-repeat?orgId=1) diff --git a/docs/sources/linking/data-link-variables.md b/docs/sources/linking/data-link-variables.md index c4ce8f05efe40..e9efdc37e1833 100644 --- a/docs/sources/linking/data-link-variables.md +++ b/docs/sources/linking/data-link-variables.md @@ -2,7 +2,6 @@ title = "URL variables" keywords = ["grafana", "url variables", "documentation", "variables", "data link"] aliases = ["/docs/grafana/latest/variables/url-variables.md","/docs/grafana/latest/variables/variable-types/url-variables.md"] -type = "docs" weight = 400 +++ @@ -50,6 +49,6 @@ Value-specific variables are available under ``__value`` namespace: When linking to another dashboard that uses template variables, select variable values for whoever clicks the link. -``var-myvar=${myvar}`` - where ``myvar`` is a name of the template variable that matches one in the current dashboard that you want to use. +``var-myvar=${myvar}`` - where ``myvar`` is a name of the template variable that matches one in the current dashboard that you want to use. If you want to add all of the current dashboard's variables to the URL, then use ``__all_variables``. diff --git a/docs/sources/linking/data-links.md b/docs/sources/linking/data-links.md index a7158d0508bde..9bdd2ff8a48f9 100644 --- a/docs/sources/linking/data-links.md +++ b/docs/sources/linking/data-links.md @@ -1,7 +1,6 @@ +++ title = "Data links" keywords = ["grafana", "data links", "documentation", "playlist"] -type = "docs" aliases = ["/docs/grafana/latest/reference/datalinks/"] +++ @@ -27,9 +26,9 @@ When creating or updating a data link, press Cmd+Space or Ctrl+Space on your key 1. Expand Data links and then click **Add link**. 1. Enter a **Title**. **Title** is a human-readable label for the link that will be displayed in the UI. 1. Enter the **URL** you want to link to. - + You can even add one of the template variables defined in the dashboard. Click in the **URL** field and then type `$` or press Ctrl+Space or Cmd+Space to see a list of available variables. By adding template variables to your panel link, the link sends the user to the right context, with the relevant variables already set. For more information, refer to [Data link variables]({{< relref "data-link-variables.md" >}}). - + 1. If you want the link to open in a new tab, then select **Open in a new tab**. 1. Click **Save** to save changes and close the window. 1. Click **Save** in the upper right to save your changes to the dashboard. diff --git a/docs/sources/linking/linking-overview.md b/docs/sources/linking/linking-overview.md index 11bb8110fe9a9..6ca6d68158310 100644 --- a/docs/sources/linking/linking-overview.md +++ b/docs/sources/linking/linking-overview.md @@ -1,11 +1,7 @@ +++ title = "Linking overview" -type = "docs" keywords = ["grafana", "linking", "create links", "link panels", "link dashboards", "navigate"] -[menu.docs] aliases = ["/docs/grafana/latest/features/navigation-links/"] -identifier = "linking-overview" -parent = "linking" weight = 100 +++ diff --git a/docs/sources/linking/panel-links.md b/docs/sources/linking/panel-links.md index c4f0a1d0c3cbd..4d050bbb4c224 100644 --- a/docs/sources/linking/panel-links.md +++ b/docs/sources/linking/panel-links.md @@ -2,10 +2,7 @@ title = "Panel links" description = "" keywords = ["grafana", "linking", "create links", "link panels", "link dashboards", "navigate"] -type = "docs" aliases = ["/docs/grafana/latest/features/navigation-links/"] -[menu.docs] -parent = "linking" weight = 300 +++ @@ -34,14 +31,14 @@ Click the icon on the top left corner of a panel to see available panel links. ## Update a panel link -1. On the Panel tab, find the link that you want to make changes to. -1. Click the Edit (pencil) icon to open the Edit link window. +1. On the Panel tab, find the link that you want to make changes to. +1. Click the Edit (pencil) icon to open the Edit link window. 1. Make any necessary changes. 1. Click **Save** to save changes and close the window. 1. Click **Save** in the upper right to save your changes to the dashboard. ## Delete a panel link -1. On the Panel tab, find the link that you want to delete. -1. Click the **X** icon next to the link you want to delete. +1. On the Panel tab, find the link that you want to delete. +1. Click the **X** icon next to the link you want to delete. 1. Click **Save** in the upper right to save your changes to the dashboard. diff --git a/docs/sources/manage-users/_index.md b/docs/sources/manage-users/_index.md index 6e3922d489f21..311d0a54c9074 100644 --- a/docs/sources/manage-users/_index.md +++ b/docs/sources/manage-users/_index.md @@ -1,10 +1,6 @@ +++ title = "Manage users" -type = "docs" -[menu.docs] -name = "Manage users" -identifier = "manage-users" -weight = 40 +weight = 50 +++ # Manage users diff --git a/docs/sources/manage-users/add-or-remove-user-from-team.md b/docs/sources/manage-users/add-or-remove-user-from-team.md index 42d4114fbef97..31989b23c9be2 100644 --- a/docs/sources/manage-users/add-or-remove-user-from-team.md +++ b/docs/sources/manage-users/add-or-remove-user-from-team.md @@ -2,10 +2,6 @@ title = "Add or remove a user from a team" keywords = ["grafana", "configuration", "documentation", "users", "teams"] -type = "docs" -[menu.docs] -identifier = "add-or-remove-user-from-team" -parent = "manage-users" weight = 300 +++ diff --git a/docs/sources/manage-users/add-or-remove-user.md b/docs/sources/manage-users/add-or-remove-user.md index 7c865c4604c0e..728c7d64cb29d 100644 --- a/docs/sources/manage-users/add-or-remove-user.md +++ b/docs/sources/manage-users/add-or-remove-user.md @@ -1,10 +1,6 @@ +++ title = "Add or remove a user" keywords = ["grafana", "configuration", "documentation", "users"] -type = "docs" -[menu.docs] -identifier = "add-or-remove-user" -parent = "manage-users" weight = 100 +++ diff --git a/docs/sources/manage-users/create-or-remove-team.md b/docs/sources/manage-users/create-or-remove-team.md index b5dd8df645654..e541e9279fa6f 100644 --- a/docs/sources/manage-users/create-or-remove-team.md +++ b/docs/sources/manage-users/create-or-remove-team.md @@ -2,10 +2,6 @@ title = "Create or remove a team" keywords = ["grafana", "configuration", "documentation", "users", "teams"] -type = "docs" -[menu.docs] -identifier = "create-or-remove-team" -parent = "manage-users" weight = 400 +++ diff --git a/docs/sources/manage-users/enable-or-disable-user.md b/docs/sources/manage-users/enable-or-disable-user.md index 92c17cc9d7d02..b5e4b1c5c1f92 100644 --- a/docs/sources/manage-users/enable-or-disable-user.md +++ b/docs/sources/manage-users/enable-or-disable-user.md @@ -1,10 +1,6 @@ +++ title = "Enable or disable a user" keywords = ["grafana", "configuration", "documentation", "users"] -type = "docs" -[menu.docs] -identifier = "enable-or-disable-user" -parent = "manage-users" weight = 200 +++ diff --git a/docs/sources/panels/_index.md b/docs/sources/panels/_index.md index 50f6bf1785633..309f22b6409e1 100644 --- a/docs/sources/panels/_index.md +++ b/docs/sources/panels/_index.md @@ -1,9 +1,6 @@ +++ title = "Panels" -type = "docs" -[menu.docs] -identifier = "panels" -weight = 4 +weight = 70 +++ # Panel overview diff --git a/docs/sources/panels/add-a-panel.md b/docs/sources/panels/add-a-panel.md index e94a0dcda4ad6..f77de79665ecd 100644 --- a/docs/sources/panels/add-a-panel.md +++ b/docs/sources/panels/add-a-panel.md @@ -1,11 +1,6 @@ +++ title = "Add a panel" -type = "docs" -[menu.docs] -identifier = "add-a-panel" -parent = "panels" weight = 100 -draft = "true" +++ # Add a panel diff --git a/docs/sources/panels/calculations-list.md b/docs/sources/panels/calculations-list.md index c5f5ff469c33d..9ced8c272d58a 100644 --- a/docs/sources/panels/calculations-list.md +++ b/docs/sources/panels/calculations-list.md @@ -1,9 +1,5 @@ +++ title = "Calculations list" -type = "docs" -[menu.docs] -identifier = "calculations-list" -parent = "panels" weight = 300 +++ diff --git a/docs/sources/panels/field-options/_index.md b/docs/sources/panels/field-options/_index.md index b9d4ecbd235b7..f8f652f196456 100644 --- a/docs/sources/panels/field-options/_index.md +++ b/docs/sources/panels/field-options/_index.md @@ -1,9 +1,7 @@ +++ title = "Field options and overrides" -type = "docs" keywords = ["grafana", "field options", "documentation", "format fields"] aliases = ["/docs/grafana/latest/panels/field-configuration-options/", "/docs/grafana/latest/panels/field-options/"] -[menu.docs] weight = 500 +++ diff --git a/docs/sources/panels/field-options/configure-all-fields.md b/docs/sources/panels/field-options/configure-all-fields.md index f9f70bc9391fb..81603f6240f55 100644 --- a/docs/sources/panels/field-options/configure-all-fields.md +++ b/docs/sources/panels/field-options/configure-all-fields.md @@ -1,7 +1,6 @@ +++ title = "Configure all fields" keywords = ["grafana", "field options", "documentation", "format fields", "change all fields"] -type = "docs" weight = 200 +++ diff --git a/docs/sources/panels/field-options/configure-specific-fields.md b/docs/sources/panels/field-options/configure-specific-fields.md index ba322807d79b8..59ce0802afe21 100644 --- a/docs/sources/panels/field-options/configure-specific-fields.md +++ b/docs/sources/panels/field-options/configure-specific-fields.md @@ -1,7 +1,6 @@ +++ title = "Configure specific fields" keywords = ["grafana", "field options", "documentation", "format fields", "overrides", "override fields"] -type = "docs" weight = 300 +++ diff --git a/docs/sources/panels/field-options/standard-field-options.md b/docs/sources/panels/field-options/standard-field-options.md index 8f81f293ad642..c8c38e5506daa 100644 --- a/docs/sources/panels/field-options/standard-field-options.md +++ b/docs/sources/panels/field-options/standard-field-options.md @@ -1,7 +1,6 @@ +++ title = "Standard field options" keywords = ["grafana", "table options", "documentation", "format tables"] -type = "docs" weight = 400 +++ diff --git a/docs/sources/panels/inspect-panel.md b/docs/sources/panels/inspect-panel.md index e95a1a99510ec..f2e925e9d20f1 100644 --- a/docs/sources/panels/inspect-panel.md +++ b/docs/sources/panels/inspect-panel.md @@ -1,9 +1,5 @@ +++ title = "Inspect a panel" -type = "docs" -[menu.docs] -identifier = "inspect-a-panel" -parent = "panels" weight = 400 +++ @@ -27,7 +23,7 @@ The panel inspector consists of four tabs: > **Note:** Not all panel types include all four tabs. For example, dashboard list panels do not have raw data to inspect, so they do not display the Stats, Data, or Query tabs. ## Panel inspector tasks -Tasks you can perform in the panel inspector are described below. +Tasks you can perform in the panel inspector are described below. ### Open the panel inspector @@ -42,14 +38,14 @@ The panel inspector pane opens on the right side of the screen. ### Inspect raw query results -View raw query results in a table. This is the data returned by the query with transformations applied and before the panel applies field options or field option overrides. +View raw query results in a table. This is the data returned by the query with transformations applied and before the panel applies field options or field option overrides. 1. Open the panel inspector and then click the **Data** tab or in the panel menu click **Inspect > Data**. 1. If your panel contains multiple queries or queries multiple nodes, then you have additional options. - **Select result -** Choose which result set data you want to view. - **Transform data** - **Join by time -** View raw data from all your queries at once, one result set per column. Click a column heading to reorder the data. - + View raw query results in a table with field options and options overrides applied: 1. Open the **Data** tab in panel inspector. 1. Click on **Data display options** above the table. @@ -70,7 +66,7 @@ To download a CSV file specifically formatted for Excel, expand the **Data optio The Stats tab displays statistics that tell you how long your query takes, how many queries you send, and the number of rows returned. This information can help you troubleshoot your queries, especially if any of the numbers are unexpectedly high or low. 1. Open the panel inspector. -1. Navigate to the Stats tab. +1. Navigate to the Stats tab. Statistics are displayed in read-only format. @@ -83,7 +79,7 @@ Explore and export panel, panel data, and data frame JSON models. - **Panel JSON -** Displays a JSON object representing the panel. - **Panel data -** Displays a JSON object representing the data that was passed to the panel. - **DataFrame structure -** Displays the raw result set with transformations, field configuration, and overrides configuration applied. -1. You can expand or collapse portions of the JSON to explore it, or you can click **Copy to clipboard** and paste the JSON in another application. +1. You can expand or collapse portions of the JSON to explore it, or you can click **Copy to clipboard** and paste the JSON in another application. ### View raw request and response to data source diff --git a/docs/sources/panels/panel-editor.md b/docs/sources/panels/panel-editor.md index 49a33530543d9..951efe2004cd3 100644 --- a/docs/sources/panels/panel-editor.md +++ b/docs/sources/panels/panel-editor.md @@ -1,8 +1,5 @@ +++ title = "Panel editor" -type = "docs" -[menu.docs] -identifier = "panel-editor" weight = 200 +++ diff --git a/docs/sources/panels/panels-overview.md b/docs/sources/panels/panels-overview.md index 118a720dd7807..b7b1ab285c572 100644 --- a/docs/sources/panels/panels-overview.md +++ b/docs/sources/panels/panels-overview.md @@ -1,11 +1,7 @@ +++ title = "Panels" -type = "docs" aliases = ["/docs/grafana/latest/features/panels/panels/"] -[menu.docs] -identifier = "panels" weight = 4 -draft = "true" +++ # Panel overview diff --git a/docs/sources/panels/queries.md b/docs/sources/panels/queries.md index 3a97d39d8d473..2a65eba143919 100644 --- a/docs/sources/panels/queries.md +++ b/docs/sources/panels/queries.md @@ -1,9 +1,5 @@ +++ title = "Queries" -type = "docs" -[menu.docs] -identifier = "queries" -parent = "panels" weight = 300 +++ @@ -81,15 +77,15 @@ Grafana sets defaults that are shown in dark gray text. Changes are displayed in Panel data source query options: - **Max data points -** If the data source supports it, sets the maximum numbers of data points for each series returned. If the query returns more data points than the max data points setting, then the data source consolidates them (reduces the number of points returned by aggregating them together by average or max or other function). - + There are two main reasons for limiting the number of points, performance and smoothing the line. The default value is the width (or number of pixels) of the graph as there is no point in having more data points than the graph panel can display. With streaming data, the max data points value is used for the rolling buffer. (Streaming is a continuous flow of data and buffering is a way of dividing the stream into chunks). Loki streams data in the live tailing mode. - **Min interval -** Sets a minimum limit for the automatically calculated interval, typically the minimum scrape interval. If a data point is saved every 15 seconds, then there's no point in having an interval lower than that. Another use case is to set it to a higher minimum than the scrape interval to get more coarse-grained, well-functioning queries. - -- **Interval -** The interval is a time span that you can use when aggregating or grouping data points by time. - + +- **Interval -** The interval is a time span that you can use when aggregating or grouping data points by time. + Grafana automatically calculates an appropriate interval and it can be used as a variable in templated queries. The variable is either in seconds: `$__interval` or in milliseconds: `$__interval_ms`. It is typically used in aggregation functions like sum or average. For example, a Prometheus query using the interval variable: `rate(http_requests_total[$__interval])`. This automatic interval is calculated based on the width of the graph. If the user zooms out a lot then the interval becomes greater, resulting in a more coarse grained aggregation whereas if the user zooms in then the interval decreases resulting in a more fine grained aggregation. @@ -97,16 +93,16 @@ Panel data source query options: For more information, refer to [Global variables]({{< relref "../variables/variable-types/global-variables.md" >}}). - **Relative time -** You can override the relative time range for individual panels, causing them to be different than what is selected in the dashboard time picker in the top right corner of the dashboard. This allows you to show metrics from different time periods or days on the same dashboard. - + - **Time shift -** The time shift function is another way to override the time range for individual panels. It only works with relative time ranges and allows you to adjust the time range. - + For example, you could shift the time range for the panel to be two hours earlier than the dashboard time picker. For more information, refer to [Time range controls]({{< relref "../dashboards/time-range-controls.md" >}}). - **Cache timeout -** (This field is only visible if available in your data source.) If your time series store has a query cache, then this option can override the default cache timeout. Specified as a numeric value in seconds. ### Query inspector button -You can click **Query inspector** to open the Query tab of the panel inspector where you can see the query request sent by the panel and the response. +You can click **Query inspector** to open the Query tab of the panel inspector where you can see the query request sent by the panel and the response. Click **Refresh** to see the full text of the request sent by this panel to the server. @@ -116,7 +112,7 @@ For more information about the panel inspector, refer to [Inspect a panel]({{< r ### Query editor list -In the UI, queries are organized in collapsible query rows. Each query row contains a query editor and is identified with a letter (A, B, C, and so on). +In the UI, queries are organized in collapsible query rows. Each query row contains a query editor and is identified with a letter (A, B, C, and so on). You can: diff --git a/docs/sources/panels/share-query-results.md b/docs/sources/panels/share-query-results.md index 589217c30bd8e..ae4b6ff43fc4e 100644 --- a/docs/sources/panels/share-query-results.md +++ b/docs/sources/panels/share-query-results.md @@ -1,9 +1,5 @@ +++ title = "Share query results" -type = "docs" -[menu.docs] -identifier = "share-query-results" -parent = "panels" weight = 310 +++ diff --git a/docs/sources/panels/thresholds.md b/docs/sources/panels/thresholds.md index beea3bec4e830..1e93fa50668ef 100644 --- a/docs/sources/panels/thresholds.md +++ b/docs/sources/panels/thresholds.md @@ -1,9 +1,5 @@ +++ title = "Thresholds" -type = "docs" -[menu.docs] -identifier = "thresholds" -parent = "panels" weight = 300 +++ @@ -36,11 +32,11 @@ The **Base** value represents minus infinity. It is generally the “good” col You can add as many thresholds to a panel as you want. Grafana automatically sorts thresholds from highest value to lowest. -> **Note:** These instructions apply only to the Stat, Gauge, Bar gauge, and Table visualizations. +> **Note:** These instructions apply only to the Stat, Gauge, Bar gauge, and Table visualizations. 1. Navigate to the panel you want to add a threshold to. 1. Click the **Field** tab. -1. Click **Add threshold**. +1. Click **Add threshold**. 1. Grafana adds a threshold with suggested numerical and color values. 1. Accept the recommendations or edit the new threshold. - **Edit color:** Click the color dot you wish to change and then select a new color. diff --git a/docs/sources/panels/transformations.md b/docs/sources/panels/transformations.md index 493e6adcbf8ed..b8ded8a4f868a 100644 --- a/docs/sources/panels/transformations.md +++ b/docs/sources/panels/transformations.md @@ -1,9 +1,5 @@ +++ title = "Transformations" -type = "docs" -[menu.docs] -identifier = "transformations" -parent = "panels" weight = 300 +++ diff --git a/docs/sources/panels/transformations/_index.md b/docs/sources/panels/transformations/_index.md index 94dda12195940..68c14419abe6f 100644 --- a/docs/sources/panels/transformations/_index.md +++ b/docs/sources/panels/transformations/_index.md @@ -1,9 +1,5 @@ +++ title = "Overview" -type = "docs" -[menu.docs] -identifier = "overview" -parent = "transformations" weight = 300 +++ @@ -28,7 +24,7 @@ The order in which transformations are applied can make a huge difference in how Before you can configure and apply transformations: - You must have entered a query and returned data from a data source. For more information on queries, refer to [Queries]({{< relref "../queries.md" >}}). - + - You must have chosen a visualization that supports your query result and chosen transforms. Different transformations can result in a data structure that only some visualizations can render. For example, Graph visualization cannot show reduced data (that results from the Reduce transform). If your current visualization does not show you what you expect after applying a transform, switch to the Table visualization to check the result. For more information on the different types of visualizations, refer to: - [Bar gauge]({{< relref "../visualizations/bar-gauge-panel.md" >}}) - [Gauge]({{< relref "../visualizations/gauge-panel.md" >}}) diff --git a/docs/sources/panels/transformations/apply-transformations.md b/docs/sources/panels/transformations/apply-transformations.md index 6f6a059c85cda..94c4db423f08c 100644 --- a/docs/sources/panels/transformations/apply-transformations.md +++ b/docs/sources/panels/transformations/apply-transformations.md @@ -1,9 +1,5 @@ +++ title = "Apply a transformation" -type = "docs" -[menu.docs] -identifier = "apply-transformation" -parent = "transformations" weight = 300 +++ diff --git a/docs/sources/panels/transformations/types-options.md b/docs/sources/panels/transformations/types-options.md index fc118ec243e56..a4850410067ca 100644 --- a/docs/sources/panels/transformations/types-options.md +++ b/docs/sources/panels/transformations/types-options.md @@ -1,9 +1,5 @@ +++ title = "Transformation types and options" -type = "docs" -[menu.docs] -identifier = "transformation_types_and_options" -parent = "transformations" weight = 300 +++ diff --git a/docs/sources/panels/visualizations/_index.md b/docs/sources/panels/visualizations/_index.md index a5501941896e2..c5cd9994c1ec6 100644 --- a/docs/sources/panels/visualizations/_index.md +++ b/docs/sources/panels/visualizations/_index.md @@ -1,8 +1,5 @@ +++ title = "Visualizations" -type = "docs" -[menu.docs] -identifier = "visualizations" weight = 600 +++ @@ -10,6 +7,6 @@ weight = 600 Grafana offers a variety of visualizations to suit different use cases. This section of the documentation lists the different visualizations available in Grafana and their unique display settings. -The default options and their unique display options are described in the pages in this section. +The default options and their unique display options are described in the pages in this section. You can add more panel types with [plugins]({{< relref "../../plugins/_index.md" >}}). diff --git a/docs/sources/panels/visualizations/alert-list-panel.md b/docs/sources/panels/visualizations/alert-list-panel.md index 5c7658fac8824..b5d35c065ca7c 100644 --- a/docs/sources/panels/visualizations/alert-list-panel.md +++ b/docs/sources/panels/visualizations/alert-list-panel.md @@ -1,11 +1,7 @@ +++ title = "Alert list panel" keywords = ["grafana", "alert list", "documentation", "panel", "alertlist"] -type = "docs" aliases = ["/docs/grafana/latest/reference/alertlist/", "/docs/grafana/latest/features/panels/alertlist/"] -[menu.docs] -name = "alert-list-panel" -parent = "visualizations" weight = 100 +++ diff --git a/docs/sources/panels/visualizations/bar-gauge-panel.md b/docs/sources/panels/visualizations/bar-gauge-panel.md index 46ac444e35be5..f24d1544fe61b 100644 --- a/docs/sources/panels/visualizations/bar-gauge-panel.md +++ b/docs/sources/panels/visualizations/bar-gauge-panel.md @@ -2,7 +2,6 @@ title = "Bar gauge panel" description = "Bar gauge panel docs" keywords = ["grafana", "bar", "bar gauge"] -type = "docs" aliases =["/docs/grafana/latest/features/panels/bar_gauge/"] weight = 200 +++ diff --git a/docs/sources/panels/visualizations/dashboard-list-panel.md b/docs/sources/panels/visualizations/dashboard-list-panel.md index 19f89d6603dd2..6b25a3ad16453 100644 --- a/docs/sources/panels/visualizations/dashboard-list-panel.md +++ b/docs/sources/panels/visualizations/dashboard-list-panel.md @@ -1,11 +1,7 @@ +++ title = "Dashboard list panel" keywords = ["grafana", "dashboard list", "documentation", "panel", "dashlist"] -type = "docs" aliases = ["/docs/grafana/latest/reference/dashlist/", "/docs/grafana/latest/features/panels/dashlist/"] -[menu.docs] -name = "Dashboard list" -parent = "visualizations" weight = 300 +++ diff --git a/docs/sources/panels/visualizations/gauge-panel.md b/docs/sources/panels/visualizations/gauge-panel.md index b42db9803220c..408260c9356bb 100644 --- a/docs/sources/panels/visualizations/gauge-panel.md +++ b/docs/sources/panels/visualizations/gauge-panel.md @@ -2,7 +2,6 @@ title = "Gauge panel" description = "Gauge panel docs" keywords = ["grafana", "gauge", "gauge panel"] -type = "docs" aliases = ["/docs/grafana/latest/features/panels/gauge/"] weight = 400 +++ diff --git a/docs/sources/panels/visualizations/graph-panel.md b/docs/sources/panels/visualizations/graph-panel.md index 17a9e882e6476..282a334b74824 100644 --- a/docs/sources/panels/visualizations/graph-panel.md +++ b/docs/sources/panels/visualizations/graph-panel.md @@ -1,10 +1,7 @@ +++ title = "Graph panel" keywords = ["grafana", "graph panel", "documentation", "guide", "graph"] -type = "docs" aliases = ["/docs/grafana/latest/reference/graph/", "/docs/grafana/latest/features/panels/graph/"] -[menu.docs] -parent = "visualizations" weight = 500 +++ @@ -68,7 +65,7 @@ You can add multiple series overrides. 1. Click **Add series override**. 1. In **Alias or regex** Type or select a series. Click in the field to see a list of available series. - + **Example:** `/Network.*/` would match two series named `Network out` and `Network in`. 1. Click **+** and then select a style to apply to the series. You can add multiple styles to each entry. @@ -121,13 +118,13 @@ Options are identical for both Y-axes. - **Time -** (default) The X-axis represents time and that the data is grouped by time (for example, by hour, or by minute). - **Series -** The data is grouped by series and not by time. The Y-axis still represents the value. - **Value -** The aggregation type to use for the values. The default is total (summing the values together). - - **Histogram -** Converts the graph into a histogram. A histogram is a kind of bar chart that groups numbers into ranges, often called buckets or bins. Taller bars show that more data falls in that range. - + - **Histogram -** Converts the graph into a histogram. A histogram is a kind of bar chart that groups numbers into ranges, often called buckets or bins. Taller bars show that more data falls in that range. + For more information about histograms, refer to [Introduction to histograms and heatmaps]({{< relref "../../getting-started/intro-histograms.md" >}}). - **Buckets -** The number of buckets to group the values by. If left empty, then Grafana tries to calculate a suitable number of buckets. - **X-Min -** Filters out values from the histogram that are under this minimum limit. - **X-Max -** Filters out values that are greater than this maximum limit. - + ## Legend Use these settings to refine how the legend appears in your visualization. @@ -150,7 +147,7 @@ Additional values can be shown along-side the legend names: - **Total -** Sum of all values returned from the metric query. - **Decimals -** Controls how many decimals are displayed for legend values and graph hover tooltips. -The legend values are calculated on the client side by Grafana and depend on what type of aggregation or point consolidation your metric query is using. All the above legend values cannot be correct at the same time. +The legend values are calculated on the client side by Grafana and depend on what type of aggregation or point consolidation your metric query is using. All the above legend values cannot be correct at the same time. For example, if you plot a rate like requests/second, this is probably using average as an aggregator, then the Total in the legend will not represent the total number of requests. It is just the sum of all data points received by Grafana. @@ -159,7 +156,7 @@ For example, if you plot a rate like requests/second, this is probably using ave Hide series when all values of a series from a metric query are of a specific value. - **With only nulls -** Value=null (default unchecked) -- **With only zeroes -** Value=zero (default unchecked) +- **With only zeroes -** Value=zero (default unchecked) ### Time regions diff --git a/docs/sources/panels/visualizations/heatmap.md b/docs/sources/panels/visualizations/heatmap.md index 5cd19749db01b..f188bca614188 100644 --- a/docs/sources/panels/visualizations/heatmap.md +++ b/docs/sources/panels/visualizations/heatmap.md @@ -2,11 +2,7 @@ title = "Heatmap" description = "Heatmap visualization documentation" keywords = ["grafana", "heatmap", "panel", "documentation"] -type = "docs" aliases =["/docs/grafana/latest/features/panels/heatmap/"] -[menu.docs] -name = "Heatmap" -parent = "visualizations" weight = 600 +++ diff --git a/docs/sources/panels/visualizations/logs-panel.md b/docs/sources/panels/visualizations/logs-panel.md index 15800e21d83ed..c101c863aac8e 100644 --- a/docs/sources/panels/visualizations/logs-panel.md +++ b/docs/sources/panels/visualizations/logs-panel.md @@ -1,11 +1,7 @@ +++ title = "Logs panel" keywords = ["grafana", "dashboard", "documentation", "panels", "logs panel"] -type = "docs" aliases = ["/docs/grafana/latest/reference/logs/", "/docs/grafana/latest/features/panels/logs/",] -[menu.docs] -name = "Logs panel" -parent = "visualizations" weight = 700 +++ diff --git a/docs/sources/panels/visualizations/news-panel.md b/docs/sources/panels/visualizations/news-panel.md index cb90c4f52217a..ee2f7b203b4ad 100644 --- a/docs/sources/panels/visualizations/news-panel.md +++ b/docs/sources/panels/visualizations/news-panel.md @@ -1,10 +1,6 @@ +++ title = "News panel" keywords = ["grafana", "news", "documentation", "panels", "news panel"] -type = "docs" -[menu.docs] -name = "news-panel" -parent = "visualizations" weight = 800 +++ diff --git a/docs/sources/panels/visualizations/stat-panel.md b/docs/sources/panels/visualizations/stat-panel.md index e636af32c7281..18744311b4dd6 100644 --- a/docs/sources/panels/visualizations/stat-panel.md +++ b/docs/sources/panels/visualizations/stat-panel.md @@ -2,7 +2,6 @@ title = "Stat panel" description = "Stat panel documentation" keywords = ["grafana", "docs", "stat panel"] -type = "docs" aliases = ["/docs/grafana/latest/features/panels/stat/", "/docs/grafana/latest/features/panels/singlestat/", "/docs/grafana/latest/reference/singlestat/"] weight = 900 +++ diff --git a/docs/sources/panels/visualizations/table/_index.md b/docs/sources/panels/visualizations/table/_index.md index 42d48e5b054ea..88a4014786ded 100644 --- a/docs/sources/panels/visualizations/table/_index.md +++ b/docs/sources/panels/visualizations/table/_index.md @@ -1,11 +1,7 @@ +++ title = "Table panel" keywords = ["grafana", "dashboard", "documentation", "panels", "table panel"] -type = "docs" aliases = ["/docs/grafana/latest/reference/table/", "/docs/grafana/latest/features/panels/table_panel/"] -[menu.docs] -name = "Table panel" -parent = "visualizations" weight = 1000 +++ @@ -29,9 +25,9 @@ Table visualizations allow you to apply: - **Show header -** Show or hide column names imported from your data source. - **Sort ascending/descending -** Click a column title to change the sort order from default to descending to ascending. Each time you click, the sort order changes to the next option in the cycle. You can only sort by one column at a time. - + ![Sort descending](/img/docs/tables/sort-descending.png "Sort descending") - + - [Table field options]({{< relref "table-field-options.md" >}}) allow you to change [field options]({{< relref "../../field-options/_index.md" >}}) such as column width, alignment, and cell display mode. - [Filter table columns]({{< relref "filter-table-columns.md" >}}) - You can temporarily change how column data is displayed. For example, you can order values from highest to lowest or hide specific values. diff --git a/docs/sources/panels/visualizations/table/filter-table-columns.md b/docs/sources/panels/visualizations/table/filter-table-columns.md index 0051c1b55c99c..c5701e76d270e 100644 --- a/docs/sources/panels/visualizations/table/filter-table-columns.md +++ b/docs/sources/panels/visualizations/table/filter-table-columns.md @@ -1,7 +1,6 @@ +++ title = "Filter table columns" keywords = ["grafana", "table options", "documentation", "format tables", "table filter", "filter columns"] -type = "docs" weight = 600 +++ diff --git a/docs/sources/panels/visualizations/table/table-field-options.md b/docs/sources/panels/visualizations/table/table-field-options.md index 6e6fc82bec460..bbc6b1ac89afb 100644 --- a/docs/sources/panels/visualizations/table/table-field-options.md +++ b/docs/sources/panels/visualizations/table/table-field-options.md @@ -1,7 +1,6 @@ +++ title = "Table field options" keywords = ["grafana", "table options", "documentation", "format tables"] -type = "docs" weight = 500 +++ @@ -77,5 +76,5 @@ If you have a field value that is an image URL or a base64 encoded image you can ## Column filter > **Note:** This feature is available in Grafana 7.2+. -> +> Turn this on to enable table field filters. For more information, refer to [Filter table columns]({{< relref "filter-table-columns.md" >}}). diff --git a/docs/sources/panels/visualizations/text-panel.md b/docs/sources/panels/visualizations/text-panel.md index f4b050260acb3..87f219bad1358 100644 --- a/docs/sources/panels/visualizations/text-panel.md +++ b/docs/sources/panels/visualizations/text-panel.md @@ -1,16 +1,12 @@ +++ title = "Text panel" keywords = ["grafana", "text", "documentation", "panel"] -type = "docs" aliases = ["/docs/grafana/latest/reference/alertlist/", "/docs/grafana/latest/features/panels/text/"] -[menu.docs] -name = "text-panel" -parent = "visualizations" weight = 1100 +++ # Text panel -The text panel lets you make information and description panels for your dashboards. +The text panel lets you make information and description panels for your dashboards. In **Mode**, select whether you want to use markdown or HTML to style your text, then enter content in the box below. Grafana includes a title and paragraph to help you get started, or you can paste content in from another editor. diff --git a/docs/sources/permissions/_index.md b/docs/sources/permissions/_index.md index a39a75eb9ff2e..3784d93923036 100644 --- a/docs/sources/permissions/_index.md +++ b/docs/sources/permissions/_index.md @@ -2,11 +2,7 @@ title = "Permissions" description = "Permissions" keywords = ["grafana", "configuration", "documentation", "admin", "users", "datasources", "permissions"] -type = "docs" aliases = ["/docs/grafana/latest/permissions/overview/"] -[menu.docs] -name = "Permissions" -identifier = "permissions" weight = 50 +++ diff --git a/docs/sources/permissions/dashboard_folder_permissions.md b/docs/sources/permissions/dashboard_folder_permissions.md index 510167a0a135c..8cc3d349fdb77 100644 --- a/docs/sources/permissions/dashboard_folder_permissions.md +++ b/docs/sources/permissions/dashboard_folder_permissions.md @@ -2,11 +2,6 @@ title = "Dashboard and Folder Permissions" description = "Grafana Dashboard and Folder Permissions Guide " keywords = ["grafana", "configuration", "documentation", "dashboard", "folder", "permissions", "teams"] -type = "docs" -[menu.docs] -name = "Dashboard and Folder" -identifier = "dashboard-folder-permissions" -parent = "permissions" weight = 200 +++ diff --git a/docs/sources/permissions/datasource_permissions.md b/docs/sources/permissions/datasource_permissions.md index 2be28cb521886..498d59533d080 100644 --- a/docs/sources/permissions/datasource_permissions.md +++ b/docs/sources/permissions/datasource_permissions.md @@ -2,11 +2,6 @@ title = "Datasource Permissions" description = "Grafana Datasource Permissions Guide " keywords = ["grafana", "configuration", "documentation", "datasource", "permissions", "users", "teams", "enterprise"] -type = "docs" -[menu.docs] -name = "Datasource" -identifier = "datasource-permissions" -parent = "permissions" weight = 900 +++ diff --git a/docs/sources/permissions/organization_roles.md b/docs/sources/permissions/organization_roles.md index 09399978b0d20..3f104585fe419 100644 --- a/docs/sources/permissions/organization_roles.md +++ b/docs/sources/permissions/organization_roles.md @@ -2,11 +2,6 @@ title = "Organization roles" description = "Grafana organization roles guide " keywords = ["grafana", "configuration", "documentation", "organization", "roles", "permissions"] -type = "docs" -[menu.docs] -name = "Organization Roles" -identifier = "organization-roles" -parent = "permissions" weight = 100 +++ diff --git a/docs/sources/plugins/_index.md b/docs/sources/plugins/_index.md index 3ff309908033c..5135d9407701c 100644 --- a/docs/sources/plugins/_index.md +++ b/docs/sources/plugins/_index.md @@ -1,10 +1,6 @@ +++ title = "Plugins" -type = "docs" -[menu.docs] -name = "Plugins" -identifier = "plugins" -weight = 1 +weight = 160 +++ # Plugins diff --git a/docs/sources/plugins/installation.md b/docs/sources/plugins/installation.md index fcd69b81d9c44..475672505e109 100644 --- a/docs/sources/plugins/installation.md +++ b/docs/sources/plugins/installation.md @@ -1,9 +1,6 @@ +++ title = "Install plugins" -type = "docs" aliases = ["/docs/plugins/installation/"] -[menu.docs] -parent = "plugins" weight = 1 +++ diff --git a/docs/sources/search.md b/docs/sources/search.md deleted file mode 100644 index 0e2e13fb08ca4..0000000000000 --- a/docs/sources/search.md +++ /dev/null @@ -1,10 +0,0 @@ -# Search - -*Please activate JavaScript to enable the search functionality.* - -## How To Search - -From here you can search these documents. Enter your search words into -the box below and click "search". Note that the search function will -automatically search for all of the words. Pages containing fewer words -won't appear in the result list. diff --git a/docs/sources/sharing/_index b/docs/sources/sharing/_index.md similarity index 100% rename from docs/sources/sharing/_index rename to docs/sources/sharing/_index.md diff --git a/docs/sources/sharing/playlists.md b/docs/sources/sharing/playlists.md index 5905c09ef6074..e6c85cd0af683 100644 --- a/docs/sources/sharing/playlists.md +++ b/docs/sources/sharing/playlists.md @@ -1,10 +1,6 @@ +++ title = "Playlists" keywords = ["grafana", "dashboard", "documentation", "playlist"] -type = "docs" -[menu.docs] -parent = "dashboard_features" -identifier = "feature_playlist" weight = 4 draft = "true" +++ @@ -23,7 +19,7 @@ You can access the Playlist feature from Grafana's side menu, in the Dashboards ## Create a playlist -You create a playlist to present dashboards in a sequence, with a set order and time interval between dashboards. +You create a playlist to present dashboards in a sequence, with a set order and time interval between dashboards. 1. To access the Playlist feature, hover your cursor over Grafana's side menu. 1. Click **Playlists**. @@ -33,7 +29,7 @@ You create a playlist to present dashboards in a sequence, with a set order and The time interval is the amount of time for Grafana to stay on a particular dashboard before advancing to the next one on the playlist. -1. Next to the dashboard(s) you want to add to your playlist, click **Add to playlist**. +1. Next to the dashboard(s) you want to add to your playlist, click **Add to playlist**. 1. Click **Create**. ## Edit a playlist @@ -47,7 +43,7 @@ You can edit playlists while creating them or after saving them. ### Edit the Name of a playlist 1. Double-click within the **Name** text box. -1. Enter a name. +1. Enter a name. 1. Click **Save** to save your changes. ### Edit the Interval of a playlist @@ -63,9 +59,9 @@ You can edit playlists while creating them or after saving them. ### Search for a dashboard to add -1. Click the **Search dashboards by name** text box. -1. Search for the playlist by name or regular expression. -1. If needed, filter your results by starred status or tags. +1. Click the **Search dashboards by name** text box. +1. Search for the playlist by name or regular expression. +1. If needed, filter your results by starred status or tags. By default, your starred dashboards will appear as options to add to the Playlist. 1. Click **Save** to save your changes. @@ -86,18 +82,18 @@ You can edit playlists while creating them or after saving them. ## Save a playlist -You can save a playlist to add it to your **Playlists** page, where you can start it. Be sure that all the dashboards you want to appear in your playlist are added when creating or editing the playlist before saving it. +You can save a playlist to add it to your **Playlists** page, where you can start it. Be sure that all the dashboards you want to appear in your playlist are added when creating or editing the playlist before saving it. 1. To access the Playlist feature, hover your cursor over Grafana's side menu. 1. Click **Playlists**. 1. Click on the playlist. 1. Edit the playlist. * Ensure that your playlist has a **Name**, **Interval**, and at least one **Dashboard** added to it. -1. Click **Save**. +1. Click **Save**. ## Start a playlist -You can start a playlist in five different view modes, which determine how the menus and navigation bar are displayed on the dashboards. +You can start a playlist in five different view modes, which determine how the menus and navigation bar are displayed on the dashboards. By default, each dashboard is displayed for the amount of time entered in the Interval field, which can be set while creating or editing a playlist. Once a playlist is started, it can be controlled using the navbar at the top of your screen. @@ -105,24 +101,24 @@ By default, each dashboard is displayed for the amount of time entered in the In 1. Next to the playlist you want to start, click **Start playlist**. 1. In the dropdown, select the mode you want the playlist to display in. - **Normal mode:** - - The side menu remains visible. + - The side menu remains visible. - The navbar, row and panel controls appear at the top of the screen. - **TV mode:** - - The side menu is hidden/removed. + - The side menu is hidden/removed. - The navbar, row and panel controls appear at the top of the screen. - Enabled automatically after one minute of user inactivity. - - You can enable it manually using the `d v` sequence shortcut, or by appending the parameter `?inactive` to the dashboard URL. - - You can disable it with any mouse mouse movement or keyboard action. - - **TV mode (with auto fit panels):** - - The side menu is hidden/removed. + - You can enable it manually using the `d v` sequence shortcut, or by appending the parameter `?inactive` to the dashboard URL. + - You can disable it with any mouse mouse movement or keyboard action. + - **TV mode (with auto fit panels):** + - The side menu is hidden/removed. - The navbar, row and panel controls appear at the top of the screen. - Dashboard panels automatically adjust to optimize space on screen. - - **Kiosk mode:** - - The side menu, navbar, row and panel controls are completely hidden/removed from view. + - **Kiosk mode:** + - The side menu, navbar, row and panel controls are completely hidden/removed from view. - You can enable it manually using the `d v` sequence shortcut after the playlist has started. - You can disable it manually with the same shortcut. - - **Kiosk mode (with auto fit panels):** - - The side menu, navbar, row and panel controls are completely hidden/removed from view. + - **Kiosk mode (with auto fit panels):** + - The side menu, navbar, row and panel controls are completely hidden/removed from view. - Dashboard panels automatically adjust to optimize space on screen. ## Control a playlist @@ -142,12 +138,12 @@ You can control a playlist in **Normal** or **TV** mode after it's started, usin ## Share a playlist in a view mode -You can share a playlist by copying the link address on the view mode you prefer, and pasting the URL to your destination. +You can share a playlist by copying the link address on the view mode you prefer, and pasting the URL to your destination. 1. From the Dashboards submenu, click **Playlists**. 1. Next to the playlist you want to share, click **Start playlist**. 1. In the dropdown, right click the view mode you prefer. -1. Click **Copy Link Address** to copy the URL to your clipboard. +1. Click **Copy Link Address** to copy the URL to your clipboard. Example: The URL for the first playlist on the Grafana Play site in Kiosk mode will look like this: [https://play.grafana.org/playlists/play/1?kiosk](https://play.grafana.org/playlists/play/1?kiosk). diff --git a/docs/sources/sharing/share-dashboard.md b/docs/sources/sharing/share-dashboard.md index 608a45d5e6b46..46f2542bd685c 100644 --- a/docs/sources/sharing/share-dashboard.md +++ b/docs/sources/sharing/share-dashboard.md @@ -1,9 +1,6 @@ +++ title = "Share a Dashboard" keywords = ["grafana", "dashboard", "documentation", "sharing"] -type = "docs" -[menu.docs] -parent = "dashboard_features" weight = 6 draft = "true" +++ diff --git a/docs/sources/sharing/share-panel.md b/docs/sources/sharing/share-panel.md index 3cd19cf39ad0c..e5fbd1138722c 100644 --- a/docs/sources/sharing/share-panel.md +++ b/docs/sources/sharing/share-panel.md @@ -1,9 +1,6 @@ +++ title = "Share a Panel" keywords = ["grafana", "dashboard", "documentation", "sharing"] -type = "docs" -[menu.docs] -parent = "dashboard_features" weight = 6 draft = "true" +++ diff --git a/docs/sources/test.md b/docs/sources/test.md deleted file mode 100644 index 8202105a8ebab..0000000000000 --- a/docs/sources/test.md +++ /dev/null @@ -1,4 +0,0 @@ - -# Test - -## Google diff --git a/docs/sources/troubleshooting/_index.md b/docs/sources/troubleshooting/_index.md index bb4079e0d2939..b6a913f4b662e 100644 --- a/docs/sources/troubleshooting/_index.md +++ b/docs/sources/troubleshooting/_index.md @@ -2,9 +2,7 @@ title = "Troubleshooting" description = "Guide to troubleshooting Grafana problems" keywords = ["grafana", "troubleshooting", "documentation", "guide"] -type = "docs" -[menu.docs] -weight = 100 +weight = 180 +++ # Troubleshooting diff --git a/docs/sources/troubleshooting/diagnostics.md b/docs/sources/troubleshooting/diagnostics.md index 3a28f5209e2b1..01363f85a7c58 100644 --- a/docs/sources/troubleshooting/diagnostics.md +++ b/docs/sources/troubleshooting/diagnostics.md @@ -1,7 +1,5 @@ +++ title = "Enable diagnostics" -type = "docs" -[menu.docs] weight = 200 +++ diff --git a/docs/sources/troubleshooting/troubleshoot-dashboards.md b/docs/sources/troubleshooting/troubleshoot-dashboards.md index 3c911a262859a..41c8f1d5eef1d 100644 --- a/docs/sources/troubleshooting/troubleshoot-dashboards.md +++ b/docs/sources/troubleshooting/troubleshoot-dashboards.md @@ -2,8 +2,6 @@ title = "Troubleshoot dashboards" description = "Guide to troubleshooting Grafana dashboards" keywords = ["grafana", "troubleshooting", "documentation", "dashboards"] -type = "docs" -[menu.docs] weight = 100 +++ diff --git a/docs/sources/troubleshooting/troubleshoot-queries.md b/docs/sources/troubleshooting/troubleshoot-queries.md index 770a726468d53..aa02b411193d7 100644 --- a/docs/sources/troubleshooting/troubleshoot-queries.md +++ b/docs/sources/troubleshooting/troubleshoot-queries.md @@ -2,8 +2,6 @@ title = "Troubleshoot queries" description = "Guide to troubleshooting Grafana queries" keywords = ["grafana", "troubleshooting", "documentation", "guide", "queries"] -type = "docs" -[menu.docs] weight = 400 +++ diff --git a/docs/sources/variables/_index.md b/docs/sources/variables/_index.md index 0ebd4c247bd3c..39c5ca2a98852 100644 --- a/docs/sources/variables/_index.md +++ b/docs/sources/variables/_index.md @@ -1,8 +1,5 @@ +++ title = "Templates and variables" -type = "docs" -[menu.docs] -identifier = "variables" weight = 130 +++ @@ -36,7 +33,7 @@ Variable values are always synced to the URL using the syntax `var-=val To see variable and template examples, go to any of the dashboards listed in [Variable examples]({{< relref "variable-examples.md" >}}). -Variables are listed in drop-down lists across the top of the screen. Select different variables to see how the visualizations change. +Variables are listed in drop-down lists across the top of the screen. Select different variables to see how the visualizations change. To see variable settings, navigate to **Dashboard Settings > Variables**. Click a variable in the list to see its settings. diff --git a/docs/sources/variables/advanced-variable-format-options.md b/docs/sources/variables/advanced-variable-format-options.md index 218121cd58a28..9bcd4f9e33036 100644 --- a/docs/sources/variables/advanced-variable-format-options.md +++ b/docs/sources/variables/advanced-variable-format-options.md @@ -1,16 +1,12 @@ +++ title = "Advanced variable format options" keywords = ["grafana", "templating", "documentation", "guide", "template", "variable"] -type = "docs" -[menu.docs] -identifier = "advanced-variables-formats" -parent = "variables" weight = 600 +++ # Advanced variable format options -The formatting of the variable interpolation depends on the data source, but there are some situations where you might want to change the default formatting. +The formatting of the variable interpolation depends on the data source, but there are some situations where you might want to change the default formatting. For example, the default for the MySql data source is to join multiple values as comma-separated with quotes: `'server01','server02'`. In some cases, you might want to have a comma-separated string without quotes: `server01,server02`. You can make that happen with advanced variable formatting options listed below. diff --git a/docs/sources/variables/filter-variables-with-regex.md b/docs/sources/variables/filter-variables-with-regex.md index 2f6c1c63fe710..e4e2cd03c4329 100644 --- a/docs/sources/variables/filter-variables-with-regex.md +++ b/docs/sources/variables/filter-variables-with-regex.md @@ -1,10 +1,6 @@ +++ title = "Filter variables with regex" keywords = ["grafana", "templating", "documentation", "guide", "template", "variable"] -type = "docs" -[menu.docs] -identifier = "filter-variables-regex" -parent = "variables" weight = 700 +++ diff --git a/docs/sources/variables/formatting-multi-value-variables.md b/docs/sources/variables/formatting-multi-value-variables.md index c1cce99948d3e..434d2637eddcf 100644 --- a/docs/sources/variables/formatting-multi-value-variables.md +++ b/docs/sources/variables/formatting-multi-value-variables.md @@ -1,9 +1,5 @@ +++ title = "Formatting multi-value variables" -type = "docs" -[menu.docs] -identifier = "format-multi-value-variables" -parent = "variables" weight = 600 +++ diff --git a/docs/sources/variables/repeat-panels-or-rows.md b/docs/sources/variables/repeat-panels-or-rows.md index a222dbe1f0e7e..b8468ea6403aa 100644 --- a/docs/sources/variables/repeat-panels-or-rows.md +++ b/docs/sources/variables/repeat-panels-or-rows.md @@ -1,10 +1,6 @@ +++ title = "Variables" keywords = ["grafana", "templating", "documentation", "guide", "template", "variable", "repeat"] -type = "docs" -[menu.docs] -identifier = "repeat-panel-rows" -parent = "variables" weight = 800 +++ diff --git a/docs/sources/variables/syntax.md b/docs/sources/variables/syntax.md index 96ea16d54b5ae..8bb408ca2732b 100644 --- a/docs/sources/variables/syntax.md +++ b/docs/sources/variables/syntax.md @@ -1,11 +1,7 @@ +++ title = "Variables syntax and types" keywords = ["grafana", "templating", "documentation", "guide", "template", "variable"] -type = "docs" aliases = ["/docs/grafana/latest/reference/templating"] -[menu.docs] -identifier = "variables-syntax-types" -parent = "variables" weight = 100 +++ @@ -16,9 +12,9 @@ Panel titles and metric queries can refer to variables using two different synta - `$varname` This syntax is easy to read, but it does not allow you to use a variable in the middle of a word. **Example:** apps.frontend.$server.requests.count -- `${var_name}` Use this syntax when you want to interpolate a variable in the middle of an expression. +- `${var_name}` Use this syntax when you want to interpolate a variable in the middle of an expression. - `${var_name:}` This format gives you more control over how Grafana interpolates values. Refer to [Advanced variable format options]({{< relref "advanced-variable-format-options.md" >}}) for more detail on all the formatting types. -- `[[varname]]` Do not use. Deprecated old syntax, will be removed in a future release. +- `[[varname]]` Do not use. Deprecated old syntax, will be removed in a future release. Before queries are sent to your data source the query is _interpolated_, meaning the variable is replaced with its current value. During interpolation, the variable value might be _escaped_ in order to conform to the syntax of the query language and where it is used. diff --git a/docs/sources/variables/variable-examples.md b/docs/sources/variables/variable-examples.md index 95a3cb0e4e79b..2ef616653c0d0 100644 --- a/docs/sources/variables/variable-examples.md +++ b/docs/sources/variables/variable-examples.md @@ -1,10 +1,6 @@ +++ title = "Variable examples" keywords = ["grafana", "templating", "documentation", "guide", "template", "variable"] -type = "docs" -[menu.docs] -identifier = "variables-examples" -parent = "variables" weight = 200 +++ diff --git a/docs/sources/variables/variable-selection-options.md b/docs/sources/variables/variable-selection-options.md index a90a108251be0..8e850e716c7e7 100644 --- a/docs/sources/variables/variable-selection-options.md +++ b/docs/sources/variables/variable-selection-options.md @@ -1,9 +1,5 @@ +++ title = "Enter variable Selection Options" -type = "docs" -[menu.docs] -identifier = "variables-selection-options" -parent = "variables" weight = 400 +++ @@ -25,6 +21,6 @@ This option is only visible if the **Include All option** is selected. Enter regex, globs, or lucene syntax in the **Custom all value** field to define the value of the `All` option. -By default the `All` value includes all options in combined expression. This can become very long and can have performance problems. Sometimes it can be better to specify a custom all value, like a wildcard regex. +By default the `All` value includes all options in combined expression. This can become very long and can have performance problems. Sometimes it can be better to specify a custom all value, like a wildcard regex. In order to have custom regex, globs, or lucene syntax in the **Custom all value** option, it is never escaped so you will have to think about what is a valid value for your data source. diff --git a/docs/sources/variables/variable-types/_index.md b/docs/sources/variables/variable-types/_index.md index ba250a378ceb8..e2cfd13e29af1 100644 --- a/docs/sources/variables/variable-types/_index.md +++ b/docs/sources/variables/variable-types/_index.md @@ -1,8 +1,5 @@ +++ title = "Variables types" -type = "docs" -[menu.docs] -identifier = "variable-types" weight = 140 +++ diff --git a/docs/sources/variables/variable-types/add-ad-hoc-filters.md b/docs/sources/variables/variable-types/add-ad-hoc-filters.md index 6b4a7ba017241..074c494c044a3 100644 --- a/docs/sources/variables/variable-types/add-ad-hoc-filters.md +++ b/docs/sources/variables/variable-types/add-ad-hoc-filters.md @@ -1,10 +1,6 @@ +++ title = "Add ad hoc filters" -type = "docs" aliases = ["/docs/grafana/latest/variables/add-ad-hoc-filters.md"] -[menu.docs] -identifier = "add-adhoc-filters" -parent = "variable-types" weight = 700 +++ diff --git a/docs/sources/variables/variable-types/add-constant-variable.md b/docs/sources/variables/variable-types/add-constant-variable.md index cc0555fde9bd8..68c6815789f9d 100644 --- a/docs/sources/variables/variable-types/add-constant-variable.md +++ b/docs/sources/variables/variable-types/add-constant-variable.md @@ -1,10 +1,6 @@ +++ title = "Add a constant variable" -type = "docs" aliases = ["/docs/grafana/latest/variables/add-constant-variable.md"] -[menu.docs] -identifier = "add-constant-variable" -parent = "variable-types" weight = 400 +++ @@ -12,7 +8,7 @@ weight = 400 _Constant_ variables allow you to define a hidden constant. This is useful for metric path prefixes for dashboards you want to share. When you export a dashboard, constant variables are converted to import options. -Constant variables are _not_ flexible. Each constant variable only holds one value, and it cannot be updated unless you update the variable settings. +Constant variables are _not_ flexible. Each constant variable only holds one value, and it cannot be updated unless you update the variable settings. Constant variables are useful when you have complex values that you need to include in queries but don't want to retype in every single query. For example, if you had a server path called `i-0b6a61efe2ab843gg`, then you could replace it with a variable called `$path_gg`. @@ -24,10 +20,10 @@ Constant variables are useful when you have complex values that you need to incl 1. In the **Type** list, select **Constant**. 1. (optional) In **Label**, enter the display name of the variable dropdown. If you don't enter a display name, then the dropdown label will be the variable name. 1. Choose a **Hide** option: - - **Variable -** No variable dropdown is displayed on the dashboard. This is the default. + - **Variable -** No variable dropdown is displayed on the dashboard. This is the default. - **No selection (blank) -** The variable dropdown displays the variable **Name** or **Label** value. - **Label -** The variable dropdown only displays the selected variable value and a down arrow. - + ## Enter Constant options 1. In the **Value** field, enter the variable value. You can enter letters, numbers, and symbols. You can even use wildcards if you use [raw format]({{< relref "../advanced-variable-format-options.md#raw" >}}). diff --git a/docs/sources/variables/variable-types/add-custom-variable.md b/docs/sources/variables/variable-types/add-custom-variable.md index cd9d17e695a5f..df37e4249e23d 100644 --- a/docs/sources/variables/variable-types/add-custom-variable.md +++ b/docs/sources/variables/variable-types/add-custom-variable.md @@ -1,10 +1,6 @@ +++ title = "Add a custom variable" -type = "docs" aliases = ["/docs/grafana/latest/variables/add-custom-variable.md"] -[menu.docs] -identifier = "add-custom-variable" -parent = "variable-types" weight = 200 +++ @@ -12,7 +8,7 @@ weight = 200 Use a _custom_ variable for values that do not change. This might be numbers, strings, or even other variables. -For example, if you have server names or region names that never change, then you might want to create them as custom variables rather than query variables. Because they do not change, you might use them in [chained variables]({{< relref "chained-variables.md" >}}) rather than other query variables. That would reduce the number of queries Grafana must send when chained variables are updated. +For example, if you have server names or region names that never change, then you might want to create them as custom variables rather than query variables. Because they do not change, you might use them in [chained variables]({{< relref "chained-variables.md" >}}) rather than other query variables. That would reduce the number of queries Grafana must send when chained variables are updated. ## Enter General options diff --git a/docs/sources/variables/variable-types/add-data-source-variable.md b/docs/sources/variables/variable-types/add-data-source-variable.md index 9e996ded79147..941999ea5132f 100644 --- a/docs/sources/variables/variable-types/add-data-source-variable.md +++ b/docs/sources/variables/variable-types/add-data-source-variable.md @@ -1,10 +1,6 @@ +++ title = "Add a data source variable" -type = "docs" aliases = ["/docs/grafana/latest/variables/add-data-source-variable.md"] -[menu.docs] -identifier = "add-datasource-variable" -parent = "variable-types" weight = 500 +++ diff --git a/docs/sources/variables/variable-types/add-interval-variable.md b/docs/sources/variables/variable-types/add-interval-variable.md index 5d12f66657bda..ca7b7f30e41a3 100644 --- a/docs/sources/variables/variable-types/add-interval-variable.md +++ b/docs/sources/variables/variable-types/add-interval-variable.md @@ -1,10 +1,6 @@ +++ title = "Add an interval variable" -type = "docs" aliases = ["/docs/grafana/latest/variables/add-interval-variable.md"] -[menu.docs] -identifier = "add-interval-variable" -parent = "variable-types" weight = 600 +++ diff --git a/docs/sources/variables/variable-types/add-query-variable.md b/docs/sources/variables/variable-types/add-query-variable.md index a5ee05bb53315..0bc6ac2048a2b 100644 --- a/docs/sources/variables/variable-types/add-query-variable.md +++ b/docs/sources/variables/variable-types/add-query-variable.md @@ -1,10 +1,6 @@ +++ title = "Add a query variable" -type = "docs" aliases = ["/docs/grafana/latest/variables/add-query-variable.md"] -[menu.docs] -identifier = "add-query-variable" -parent = "variable-types" weight = 100 +++ @@ -35,9 +31,9 @@ Query expressions are different for each data source. For more information, refe 1. In the **Data source** list, select the target data source for the query. For more information about data sources, refer to [Add a data source]({{< relref "../../datasources/add-a-data-source.md" >}}). 1. In the **Refresh** list, select when the variable should update options. - **Never -** Variables queries are cached and values are not updated. This is fine if the values never change, but problematic if they are dynamic and change a lot. - - **On Dashboard Load -** Queries the data source every time the dashboard loads. This slows down dashboard loading, because the variable query needs to be completed before dashboard can be initialized. + - **On Dashboard Load -** Queries the data source every time the dashboard loads. This slows down dashboard loading, because the variable query needs to be completed before dashboard can be initialized. - **On Time Range Change -** Queries the data source when the dashboard time range changes. Only use this option if your variable options query contains a time range filter or is dependent on the dashboard time range. -1. In the **Query** field, enter a query. +1. In the **Query** field, enter a query. - The query field varies according to your data source. Some data sources have custom query editors. - If you need more room in a single input field query editor, then hover your cursor over the lines in the lower right corner of the field and drag downward to expand. 1. (optional) In the **Regex** field, type a regex expression to filter or capture specific parts of the names returned by your data source query. To see examples, refer to [Filter variables with regex]({{< relref "../filter-variables-with-regex.md" >}}). diff --git a/docs/sources/variables/variable-types/add-text-box-variable.md b/docs/sources/variables/variable-types/add-text-box-variable.md index daaa7c176a073..ad35046d4f92c 100644 --- a/docs/sources/variables/variable-types/add-text-box-variable.md +++ b/docs/sources/variables/variable-types/add-text-box-variable.md @@ -1,10 +1,6 @@ +++ title = "Add a text box variable" -type = "docs" aliases = ["/docs/grafana/latest/variables/add-text-box-variable.md"] -[menu.docs] -identifier = "add-text-box-variable" -parent = "variable-types" weight = 300 +++ @@ -26,6 +22,6 @@ _Text box_ variables display a free text input field with an optional default va ## Enter Text options -1. (optional) In the **Default value** field, select the default value for the variable. If you do not enter anything in this field, then Grafana displays an empty text box for users to type text into. +1. (optional) In the **Default value** field, select the default value for the variable. If you do not enter anything in this field, then Grafana displays an empty text box for users to type text into. 1. In **Preview of values**, Grafana displays a list of the current variable values. Review them to ensure they match what you expect. 1. Click **Add** to add the variable to the dashboard. diff --git a/docs/sources/variables/variable-types/chained-variables.md b/docs/sources/variables/variable-types/chained-variables.md index 19b6dea042a86..e94091d689127 100644 --- a/docs/sources/variables/variable-types/chained-variables.md +++ b/docs/sources/variables/variable-types/chained-variables.md @@ -1,11 +1,7 @@ +++ title = "Chained variables" keywords = ["grafana", "templating", "variable", "nested", "chained", "linked"] -type = "docs" aliases = ["/docs/grafana/latest/variables/chained-variables.md"] -[menu.docs] -identifier = "chained-variable" -parent = "variable-types" weight = 800 +++ @@ -50,7 +46,7 @@ The values returned are `backend`, `country`, `fakesite`, and `All`. #### server variable -The query for this variable basically says, "Give me all servers for the currently chosen application." +The query for this variable basically says, "Give me all servers for the currently chosen application." ``` apps.$app.* @@ -103,14 +99,14 @@ In this example, when the user changes the value of the `datacenter` variable, i The query for this variable basically says, "Give me all the data centers that exist." ``` -SHOW TAG VALUES WITH KEY = "datacenter" +SHOW TAG VALUES WITH KEY = "datacenter" ``` The values returned are `America`, `Africa`, `Asia`, and `Europe`. #### host variable -The query for this variable basically says, "Give me all hosts for the currently chosen data center." +The query for this variable basically says, "Give me all hosts for the currently chosen data center." ``` SHOW TAG VALUES WITH KEY = "hostname" WHERE "datacenter" =~ /^$datacenter$/ diff --git a/docs/sources/variables/variable-types/global-variables.md b/docs/sources/variables/variable-types/global-variables.md index 4a43b97483734..fce23365490d7 100644 --- a/docs/sources/variables/variable-types/global-variables.md +++ b/docs/sources/variables/variable-types/global-variables.md @@ -1,11 +1,7 @@ +++ title = "Global variables" keywords = ["grafana", "templating", "documentation", "guide", "template", "variable", "global", "standard"] -type = "docs" aliases = ["/docs/grafana/latest/variables/global-variables.md"] -[menu.docs] -identifier = "global-variable" -parent = "variable-types" weight = 900 +++ @@ -28,7 +24,7 @@ Grafana has two built in time range variables: `$__from` and `$__to`. They are c | Syntax | Example result | Description | | ------------------------ | ------------------------ | ----------- | | `${__from}` | 1594671549254 | Unix millisecond epoch | -| `${__from:date}` | 2020-07-13T20:19:09.254Z | No args, defaults to ISO 8601/RFC 3339 | +| `${__from:date}` | 2020-07-13T20:19:09.254Z | No args, defaults to ISO 8601/RFC 3339 | | `${__from:date:iso}` | 2020-07-13T20:19:09.254Z | ISO 8601/RFC 3339 | | `${__from:date:seconds}` | 1594671549 | Unix seconds epoch | | `${__from:date:YYYY-MM}` | 2020-07 | Any custom [date format](https://momentjs.com/docs/#/displaying/) | diff --git a/docs/sources/variables/variable-value-tags.md b/docs/sources/variables/variable-value-tags.md index a564d5565bdc0..d6a3d8e2f55e5 100644 --- a/docs/sources/variables/variable-value-tags.md +++ b/docs/sources/variables/variable-value-tags.md @@ -1,9 +1,5 @@ +++ title = "Enter Value tags" -type = "docs" -[menu.docs] -identifier = "variables-value-groups" -parent = "variables" weight = 500 +++ @@ -19,18 +15,18 @@ To see an example, check out [Templating value groups](https://play.grafana.org/ ## Tags query -Enter a data source query that should return a list of tags. The tags query returns a list of tags that each represents a group, and the tag values query returns a list of group members. +Enter a data source query that should return a list of tags. The tags query returns a list of tags that each represents a group, and the tag values query returns a list of group members. For example, the tags query could be a list of regions (Europe, Asia, Americas), and then if the user selects the Europe tag, then the tag values query would return a list of countries -- Sweden, Germany, France, and so on. If you have a variable with a lot of values (say all the countries in the world), then this allows you to easily select a group of them. If the user selects the tag Europe, all the countries in Europe would be selected. -In this [example dashboard](https://play.grafana.org/d/ZUPhFVGGk/graphite-with-experimental-tags?orgId=1), the server variable has tags enabled. +In this [example dashboard](https://play.grafana.org/d/ZUPhFVGGk/graphite-with-experimental-tags?orgId=1), the server variable has tags enabled. ## Tag values query Enter a data source query that should return a list of values for a specified tag key. Use `$tag` in the query to refer to the currently selected tag. -The `$tag` variable will have the value of the tag that the user chooses. +The `$tag` variable will have the value of the tag that the user chooses. For example, if you have a Graphite query for tags, `regions.*`, that returns a list of regions. The values query could be `regions.$tag.*`, which if the user chooses Europe would be interpolated to `regions.Europe.*`. diff --git a/docs/sources/versions.html_fragment b/docs/sources/versions.html_fragment deleted file mode 100644 index df6dbd4db7fb3..0000000000000 --- a/docs/sources/versions.html_fragment +++ /dev/null @@ -1,7 +0,0 @@ -
  • Version v3.1
    • -
  • Version v3.0
    • -
  • Version v2.6
    • -
  • Version v2.5
    • -
  • Version v2.1
    • -
  • Version v2.0
    • -
  • Version v1.9
    • diff --git a/docs/sources/whatsnew/_index.md b/docs/sources/whatsnew/_index.md index 2f49f4640f5db..bc9442f9d9c5d 100644 --- a/docs/sources/whatsnew/_index.md +++ b/docs/sources/whatsnew/_index.md @@ -1,10 +1,6 @@ +++ title = "What's new in Grafana" aliases = ["/docs/grafana/latest/guides/"] -[menu.docs] -name = "What's New In Grafana" -identifier = "whatsnew" -weight = 140 +++ # What's new diff --git a/docs/sources/whatsnew/whats-new-in-v2.md b/docs/sources/whatsnew/whats-new-in-v2-0.md similarity index 99% rename from docs/sources/whatsnew/whats-new-in-v2.md rename to docs/sources/whatsnew/whats-new-in-v2-0.md index cf87eaf2e016b..6081bbff51e87 100644 --- a/docs/sources/whatsnew/whats-new-in-v2.md +++ b/docs/sources/whatsnew/whats-new-in-v2-0.md @@ -2,8 +2,8 @@ title = "What's new in Grafana v2.0" description = "Feature and improvement highlights for Grafana v2.0" keywords = ["grafana", "new", "documentation", "2.0", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v2/"] +weight = -1 +++ # What's new in Grafana v2.0 diff --git a/docs/sources/whatsnew/whats-new-in-v2-1.md b/docs/sources/whatsnew/whats-new-in-v2-1.md index 223f4f7c3b89e..89da979901af8 100644 --- a/docs/sources/whatsnew/whats-new-in-v2-1.md +++ b/docs/sources/whatsnew/whats-new-in-v2-1.md @@ -2,8 +2,8 @@ title = "What's new in Grafana v2.1" description = "Feature and improvement highlights for Grafana v2.1" keywords = ["grafana", "new", "documentation", "2.1", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v2-1/"] +weight = -2 +++ # What's new in Grafana v2.1 diff --git a/docs/sources/whatsnew/whats-new-in-v2-5.md b/docs/sources/whatsnew/whats-new-in-v2-5.md index 91c9b63846a72..eb5f3d83296b3 100644 --- a/docs/sources/whatsnew/whats-new-in-v2-5.md +++ b/docs/sources/whatsnew/whats-new-in-v2-5.md @@ -2,8 +2,8 @@ title = "What's new in Grafana v2.5" description = "Feature and improvement highlights for Grafana v2.5" keywords = ["grafana", "new", "documentation", "2.5", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v2-5/"] +weight = -3 +++ # What's new in Grafana v2.5 diff --git a/docs/sources/whatsnew/whats-new-in-v2-6.md b/docs/sources/whatsnew/whats-new-in-v2-6.md index 2aa16b512cbb8..fb7c4e070c65c 100644 --- a/docs/sources/whatsnew/whats-new-in-v2-6.md +++ b/docs/sources/whatsnew/whats-new-in-v2-6.md @@ -2,8 +2,8 @@ title = "What's new in Grafana v2.6" description = "Feature and improvement highlights for Grafana v2.6" keywords = ["grafana", "new", "documentation", "2.6", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v2-6/"] +weight = -4 +++ # What's new in Grafana v2.6 diff --git a/docs/sources/whatsnew/whats-new-in-v3.md b/docs/sources/whatsnew/whats-new-in-v3-0.md similarity index 98% rename from docs/sources/whatsnew/whats-new-in-v3.md rename to docs/sources/whatsnew/whats-new-in-v3-0.md index 57ef7a8fca2ec..2398f1b39332c 100644 --- a/docs/sources/whatsnew/whats-new-in-v3.md +++ b/docs/sources/whatsnew/whats-new-in-v3-0.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v3.0" description = "Feature and improvement highlights for Grafana v3.0" keywords = ["grafana", "new", "documentation", "3.0", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v3/"] -[menu.docs] -name = "Version 3.0" -identifier = "v3.0" -parent = "whatsnew" -weight = 6 +weight = -5 +++ # What's new in Grafana v3.0 diff --git a/docs/sources/whatsnew/whats-new-in-v3-1.md b/docs/sources/whatsnew/whats-new-in-v3-1.md index f4443a131bfff..627201af3cd57 100644 --- a/docs/sources/whatsnew/whats-new-in-v3-1.md +++ b/docs/sources/whatsnew/whats-new-in-v3-1.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v3.1" description = "Feature and improvement highlights for Grafana v3.1" keywords = ["grafana", "new", "documentation", "3.1", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v3-1/"] -[menu.docs] -name = "Version 3.1" -identifier = "v3.1" -parent = "whatsnew" -weight = 5 +weight = -6 +++ # What's new in Grafana v3.1 diff --git a/docs/sources/whatsnew/whats-new-in-v4.md b/docs/sources/whatsnew/whats-new-in-v4-0.md similarity index 98% rename from docs/sources/whatsnew/whats-new-in-v4.md rename to docs/sources/whatsnew/whats-new-in-v4-0.md index ca694c4a5c551..de9a4795550ed 100644 --- a/docs/sources/whatsnew/whats-new-in-v4.md +++ b/docs/sources/whatsnew/whats-new-in-v4-0.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v4.0" description = "Feature and improvement highlights for Grafana v4.0" keywords = ["grafana", "new", "documentation", "4.0", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v4/"] -[menu.docs] -name = "Version 4.0" -identifier = "v4.0" -parent = "whatsnew" -weight = 4 +weight = -7 +++ # What's new in Grafana v4.0 diff --git a/docs/sources/whatsnew/whats-new-in-v4-1.md b/docs/sources/whatsnew/whats-new-in-v4-1.md index 790aee8a3b631..df1862411f99b 100644 --- a/docs/sources/whatsnew/whats-new-in-v4-1.md +++ b/docs/sources/whatsnew/whats-new-in-v4-1.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v4.1" description = "Feature and improvement highlights for Grafana v4.1" keywords = ["grafana", "new", "documentation", "4.1.0", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v4-1/"] -[menu.docs] -name = "Version 4.1" -identifier = "v4.1" -parent = "whatsnew" -weight = 3 +weight = -8 +++ ## What's new in Grafana v4.1 diff --git a/docs/sources/whatsnew/whats-new-in-v4-2.md b/docs/sources/whatsnew/whats-new-in-v4-2.md index 360063db0d6cf..db38caf749b5b 100644 --- a/docs/sources/whatsnew/whats-new-in-v4-2.md +++ b/docs/sources/whatsnew/whats-new-in-v4-2.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v4.2" description = "Feature and improvement highlights for Grafana v4.2" keywords = ["grafana", "new", "documentation", "4.2.0", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v4-2/"] -[menu.docs] -name = "Version 4.2" -identifier = "v4.2" -parent = "whatsnew" -weight = -1 +weight = -9 +++ ## What's new in Grafana v4.2 diff --git a/docs/sources/whatsnew/whats-new-in-v4-3.md b/docs/sources/whatsnew/whats-new-in-v4-3.md index ef00ebae10a40..0f9b4d1bd48d2 100644 --- a/docs/sources/whatsnew/whats-new-in-v4-3.md +++ b/docs/sources/whatsnew/whats-new-in-v4-3.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v4.3" description = "Feature and improvement highlights for Grafana v4.3" keywords = ["grafana", "new", "documentation", "4.3.0", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v4-3/"] -[menu.docs] -name = "Version 4.3" -identifier = "v4.3" -parent = "whatsnew" -weight = -2 +weight = -10 +++ ## What's new in Grafana v4.3 diff --git a/docs/sources/whatsnew/whats-new-in-v4-4.md b/docs/sources/whatsnew/whats-new-in-v4-4.md index f06a20c7d8674..be4f44e3ab496 100644 --- a/docs/sources/whatsnew/whats-new-in-v4-4.md +++ b/docs/sources/whatsnew/whats-new-in-v4-4.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v4.4" description = "Feature and improvement highlights for Grafana v4.4" keywords = ["grafana", "new", "documentation", "4.4.0", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v4-4/"] -[menu.docs] -name = "Version 4.4" -identifier = "v4.4" -parent = "whatsnew" -weight = -3 +weight = -11 +++ ## What's new in Grafana v4.4 diff --git a/docs/sources/whatsnew/whats-new-in-v4-5.md b/docs/sources/whatsnew/whats-new-in-v4-5.md index 0084e6dcf99ef..934708d6c7a40 100644 --- a/docs/sources/whatsnew/whats-new-in-v4-5.md +++ b/docs/sources/whatsnew/whats-new-in-v4-5.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v4.5" description = "Feature and improvement highlights for Grafana v4.5" keywords = ["grafana", "new", "documentation", "4.5", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v4-5/"] -[menu.docs] -name = "Version 4.5" -identifier = "v4.5" -parent = "whatsnew" -weight = -4 +weight = -12 +++ # What's new in Grafana v4.5 diff --git a/docs/sources/whatsnew/whats-new-in-v4-6.md b/docs/sources/whatsnew/whats-new-in-v4-6.md index b808b3d5ac65c..ba2c8c8b188d9 100644 --- a/docs/sources/whatsnew/whats-new-in-v4-6.md +++ b/docs/sources/whatsnew/whats-new-in-v4-6.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v4.6" description = "Feature and improvement highlights for Grafana v4.6" keywords = ["grafana", "new", "documentation", "4.6", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v4-6/"] -[menu.docs] -name = "Version 4.6" -identifier = "v4.6" -parent = "whatsnew" -weight = -5 +weight = -13 +++ # What's new in Grafana v4.6 diff --git a/docs/sources/whatsnew/whats-new-in-v5.md b/docs/sources/whatsnew/whats-new-in-v5-0.md similarity index 98% rename from docs/sources/whatsnew/whats-new-in-v5.md rename to docs/sources/whatsnew/whats-new-in-v5-0.md index 7c4e42d6543b7..242ae04571bee 100644 --- a/docs/sources/whatsnew/whats-new-in-v5.md +++ b/docs/sources/whatsnew/whats-new-in-v5-0.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v5.0" description = "Feature and improvement highlights for Grafana v5.0" keywords = ["grafana", "new", "documentation", "5.0", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v5/"] -[menu.docs] -name = "Version 5.0" -identifier = "v5.0" -parent = "whatsnew" -weight = -6 +weight = -14 +++ # What's new in Grafana v5.0 diff --git a/docs/sources/whatsnew/whats-new-in-v5-1.md b/docs/sources/whatsnew/whats-new-in-v5-1.md index f3118c642fd84..084ddf9685056 100644 --- a/docs/sources/whatsnew/whats-new-in-v5-1.md +++ b/docs/sources/whatsnew/whats-new-in-v5-1.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v5.1" description = "Feature and improvement highlights for Grafana v5.1" keywords = ["grafana", "new", "documentation", "5.1", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v5-1/"] -[menu.docs] -name = "Version 5.1" -identifier = "v5.1" -parent = "whatsnew" -weight = -7 +weight = -15 +++ # What's new in Grafana v5.1 diff --git a/docs/sources/whatsnew/whats-new-in-v5-2.md b/docs/sources/whatsnew/whats-new-in-v5-2.md index 4e71c340e6e12..c1e11c09f2131 100644 --- a/docs/sources/whatsnew/whats-new-in-v5-2.md +++ b/docs/sources/whatsnew/whats-new-in-v5-2.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v5.2" description = "Feature and improvement highlights for Grafana v5.2" keywords = ["grafana", "new", "documentation", "5.2", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v5-2/"] -[menu.docs] -name = "Version 5.2" -identifier = "v5.2" -parent = "whatsnew" -weight = -8 +weight = -16 +++ # What's new in Grafana v5.2 diff --git a/docs/sources/whatsnew/whats-new-in-v5-3.md b/docs/sources/whatsnew/whats-new-in-v5-3.md index feae52d43db23..e0e2e6c58d12f 100644 --- a/docs/sources/whatsnew/whats-new-in-v5-3.md +++ b/docs/sources/whatsnew/whats-new-in-v5-3.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v5.3" description = "Feature and improvement highlights for Grafana v5.3" keywords = ["grafana", "new", "documentation", "5.3", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v5-3/"] -[menu.docs] -name = "Version 5.3" -identifier = "v5.3" -parent = "whatsnew" -weight = -9 +weight = -17 +++ # What's new in Grafana v5.3 diff --git a/docs/sources/whatsnew/whats-new-in-v5-4.md b/docs/sources/whatsnew/whats-new-in-v5-4.md index 53ad67b5be40c..93d286962eb38 100644 --- a/docs/sources/whatsnew/whats-new-in-v5-4.md +++ b/docs/sources/whatsnew/whats-new-in-v5-4.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v5.4" description = "Feature and improvement highlights for Grafana v5.4" keywords = ["grafana", "new", "documentation", "5.4", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v5-4/"] -[menu.docs] -name = "Version 5.4" -identifier = "v5.4" -parent = "whatsnew" -weight = -10 +weight = -18 +++ # What's new in Grafana v5.4 diff --git a/docs/sources/whatsnew/whats-new-in-v6-0.md b/docs/sources/whatsnew/whats-new-in-v6-0.md index 9949ea3e9d874..8937004a168e8 100644 --- a/docs/sources/whatsnew/whats-new-in-v6-0.md +++ b/docs/sources/whatsnew/whats-new-in-v6-0.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v6.0" description = "Feature and improvement highlights for Grafana v6.0" keywords = ["grafana", "new", "documentation", "6.0", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v6-0/"] -[menu.docs] -name = "Version 6.0" -identifier = "v6.0" -parent = "whatsnew" -weight = -11 +weight = -19 +++ # What's new in Grafana v6.0 diff --git a/docs/sources/whatsnew/whats-new-in-v6-1.md b/docs/sources/whatsnew/whats-new-in-v6-1.md index 4934cc2b1bd31..f6b5cdfae230d 100644 --- a/docs/sources/whatsnew/whats-new-in-v6-1.md +++ b/docs/sources/whatsnew/whats-new-in-v6-1.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v6.1" description = "Feature and improvement highlights for Grafana v6.1" keywords = ["grafana", "new", "documentation", "6.1", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v6-1/"] -[menu.docs] -name = "Version 6.1" -identifier = "v6.1" -parent = "whatsnew" -weight = -12 +weight = -20 +++ # What's new in Grafana v6.1 diff --git a/docs/sources/whatsnew/whats-new-in-v6-2.md b/docs/sources/whatsnew/whats-new-in-v6-2.md index 55a51e5dc3c74..89c3ee4851520 100644 --- a/docs/sources/whatsnew/whats-new-in-v6-2.md +++ b/docs/sources/whatsnew/whats-new-in-v6-2.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v6.2" description = "Feature and improvement highlights for Grafana v6.2" keywords = ["grafana", "new", "documentation", "6.2", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v6-2/"] -[menu.docs] -name = "Version 6.2" -identifier = "v6.2" -parent = "whatsnew" -weight = -13 +weight = -21 +++ # What's new in Grafana v6.2 diff --git a/docs/sources/whatsnew/whats-new-in-v6-3.md b/docs/sources/whatsnew/whats-new-in-v6-3.md index 1cc24c638a405..5a76eceabd11f 100644 --- a/docs/sources/whatsnew/whats-new-in-v6-3.md +++ b/docs/sources/whatsnew/whats-new-in-v6-3.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v6.3" description = "Feature and improvement highlights for Grafana v6.3" keywords = ["grafana", "new", "documentation", "6.3", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v6-3/"] -[menu.docs] -name = "Version 6.3" -identifier = "v6.3" -parent = "whatsnew" -weight = -14 +weight = -22 +++ # What's new in Grafana v6.3 diff --git a/docs/sources/whatsnew/whats-new-in-v6-4.md b/docs/sources/whatsnew/whats-new-in-v6-4.md index d35835c3137be..3d24087cf38a8 100644 --- a/docs/sources/whatsnew/whats-new-in-v6-4.md +++ b/docs/sources/whatsnew/whats-new-in-v6-4.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v6.4" description = "Feature and improvement highlights for Grafana v6.4" keywords = ["grafana", "new", "documentation", "6.4", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v6-4/"] -[menu.docs] -name = "Version 6.4" -identifier = "v6.4" -parent = "whatsnew" -weight = -15 +weight = -23 +++ # What's new in Grafana v6.4 diff --git a/docs/sources/whatsnew/whats-new-in-v6-5.md b/docs/sources/whatsnew/whats-new-in-v6-5.md index 3f5593d131385..621f7bacfe5cd 100644 --- a/docs/sources/whatsnew/whats-new-in-v6-5.md +++ b/docs/sources/whatsnew/whats-new-in-v6-5.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v6.5" description = "Feature and improvement highlights for Grafana v6.5" keywords = ["grafana", "new", "documentation", "6.5", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v6-5/"] -[menu.docs] -name = "Version 6.5" -identifier = "v6.5" -parent = "whatsnew" -weight = -16 +weight = -24 +++ # What's new in Grafana v6.5 diff --git a/docs/sources/whatsnew/whats-new-in-v6-6.md b/docs/sources/whatsnew/whats-new-in-v6-6.md index a55ae6ea6716f..1cc00433d2da1 100644 --- a/docs/sources/whatsnew/whats-new-in-v6-6.md +++ b/docs/sources/whatsnew/whats-new-in-v6-6.md @@ -2,13 +2,8 @@ title = "What's new in Grafana v6.6" description = "Feature and improvement highlights for Grafana v6.6" keywords = ["grafana", "new", "documentation", "6.6", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v6-6/"] -[menu.docs] -name = "Version 6.6" -identifier = "v6.6" -parent = "whatsnew" -weight = -16 +weight = -25 +++ # What's new in Grafana v6.6 @@ -209,9 +204,9 @@ In our mission to migrate away from AngularJS to React we have removed all Angul Removing the AngularJS dependencies in `backendSrv` has the unfortunate side effect of AngularJS digest no longer being triggered for any request made with `backendSrv`. Because of this, external plugins using `backendSrv` directly may suffer from strange behaviour in the UI. -To remedy this issue as a plugin author you need to trigger the digest after a direct call to `backendSrv`. +To remedy this issue as a plugin author you need to trigger the digest after a direct call to `backendSrv`. -Example: +Example: ```js backendSrv.get(‘http://your.url/api’).then(result => { diff --git a/docs/sources/whatsnew/whats-new-in-v6-7.md b/docs/sources/whatsnew/whats-new-in-v6-7.md index b987d0a2e107c..f5b86021d4199 100644 --- a/docs/sources/whatsnew/whats-new-in-v6-7.md +++ b/docs/sources/whatsnew/whats-new-in-v6-7.md @@ -2,13 +2,8 @@ title = "What's New in Grafana v6.7" description = "Feature and improvement highlights for Grafana v6.7" keywords = ["grafana", "new", "documentation", "6.7", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v6-7/"] -[menu.docs] -name = "Version 6.7" -identifier = "v6.7" -parent = "whatsnew" -weight = -16 +weight = -26 +++ # What's new in Grafana v6.7 @@ -18,7 +13,7 @@ This topic includes the release notes for the Grafana v6.7. For all details, rea Grafana 6.7 comes with a lot of new features and enhancements: - [**Dashboard:** Enforce minimum refresh interval]({{< relref "#enforce-minimum-dashboard-refresh-interval" >}}) -- **Data source:** Google Sheets data source +- **Data source:** Google Sheets data source - [**Explore:** Query history]({{< relref "#query-history" >}}) - [**Authorization:** Azure OAuth]({{< relref "#azure-oauth" >}}) - [**Stackdriver:** Project Selector]({{< relref "#stackdriver-project-selector" >}}) @@ -52,9 +47,9 @@ Refer to min_refresh_interval in [Configuration]({{< relref "../administration/c ### Stackdriver project selector -A Stackdriver data source in Grafana is configured for one service account only. That service account is always associated with a default project in Google Cloud Platform (GCP). Depending on your setup in GCP, the service account might be granted access to more projects than just the default project. +A Stackdriver data source in Grafana is configured for one service account only. That service account is always associated with a default project in Google Cloud Platform (GCP). Depending on your setup in GCP, the service account might be granted access to more projects than just the default project. -In Grafana 6.7, the query editor has been enhanced with a project selector that makes it possible to query different projects without changing datasource. Many thanks [Eraac](https://github.com/Eraac), [eliaslaouiti](https://github.com/eliaslaouiti), and [NaurisSadovskis](https://github.com/NaurisSadovskis) for making this happen! +In Grafana 6.7, the query editor has been enhanced with a project selector that makes it possible to query different projects without changing datasource. Many thanks [Eraac](https://github.com/Eraac), [eliaslaouiti](https://github.com/eliaslaouiti), and [NaurisSadovskis](https://github.com/NaurisSadovskis) for making this happen! ## Grafana Enterprise features diff --git a/docs/sources/whatsnew/whats-new-in-v7-0.md b/docs/sources/whatsnew/whats-new-in-v7-0.md index fce5204040010..19be8b66d6d38 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-0.md +++ b/docs/sources/whatsnew/whats-new-in-v7-0.md @@ -1,14 +1,9 @@ +++ -title = "What's New in Grafana v7" +title = "What's New in Grafana v7.0" description = "Feature and improvement highlights for Grafana v7" keywords = ["grafana", "new", "documentation", "7.0", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v7-0/"] -[menu.docs] -name = "Version 7.0" -identifier = "v7.0" -parent = "whatsnew" -weight = -17 +weight = -27 +++ # What's new in Grafana v7.0 diff --git a/docs/sources/whatsnew/whats-new-in-v7-1.md b/docs/sources/whatsnew/whats-new-in-v7-1.md index 932412bab85e8..9a5b80712e9a0 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-1.md +++ b/docs/sources/whatsnew/whats-new-in-v7-1.md @@ -2,13 +2,8 @@ title = "What's New in Grafana v7.1" description = "Feature and improvement highlights for Grafana v7.1" keywords = ["grafana", "new", "documentation", "7.1", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v7-1/"] -[menu.docs] -name = "Version 7.1" -identifier = "v7.1" -parent = "whatsnew" -weight = -16 +weight = -28 +++ # What's new in Grafana v7.1 diff --git a/docs/sources/whatsnew/whats-new-in-v7-2.md b/docs/sources/whatsnew/whats-new-in-v7-2.md index 134bb55dc4b8b..c1630134a26e7 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-2.md +++ b/docs/sources/whatsnew/whats-new-in-v7-2.md @@ -2,13 +2,8 @@ title = "What's New in Grafana v7.2" description = "Feature and improvement highlights for Grafana v7.2" keywords = ["grafana", "new", "documentation", "7.2", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v7-2/"] -[menu.docs] -name = "Version 7.2" -identifier = "v7.2" -parent = "whatsnew" -weight = -15 +weight = -29 +++ # What's new in Grafana v7.2 diff --git a/docs/sources/whatsnew/whats-new-in-v7-3.md b/docs/sources/whatsnew/whats-new-in-v7-3.md index 5bc0ab4ae9680..8614c9eabfef1 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-3.md +++ b/docs/sources/whatsnew/whats-new-in-v7-3.md @@ -2,13 +2,8 @@ title = "What's New in Grafana v7.3" description = "Feature and improvement highlights for Grafana v7.3" keywords = ["grafana", "new", "documentation", "7.3", "release notes"] -type = "docs" aliases = ["/docs/grafana/latest/guides/whats-new-in-v7-3/"] -[menu.docs] -name = "Version 7.3" -identifier = "v7.3" -parent = "whatsnew" -weight = -17 +weight = -30 +++ # What's new in Grafana v7.3 @@ -37,26 +32,26 @@ Another new feature that can be seen in the image above is the new image cell di {{< figure src="/img/docs/v73/color_scheme_dropdown.png" max-width="450px" caption="Color scheme" class="pull-right" >}} -A new standard field [color scheme]({{< relref "../panels/field-options/standard-field-options.md#color-scheme" >}}) option has been added. This new option will provide a unified way for all new panels to specify how colors should be assigned. +A new standard field [color scheme]({{< relref "../panels/field-options/standard-field-options.md#color-scheme" >}}) option has been added. This new option will provide a unified way for all new panels to specify how colors should be assigned. -* **Single color**: Specify a single color, useful in an override rule. -* **From thresholds**: Informs Grafana to take the color from the matching threshold. -* **Classic palette**: Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations. -* **Green-Yellow-Red (by value)**: This is a continuous color scheme where Grafana will interpolate a color based on the value being displayed and the field min & max values. +* **Single color**: Specify a single color, useful in an override rule. +* **From thresholds**: Informs Grafana to take the color from the matching threshold. +* **Classic palette**: Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations. +* **Green-Yellow-Red (by value)**: This is a continuous color scheme where Grafana will interpolate a color based on the value being displayed and the field min & max values. * **Blue-Yellow-Red (by value)**: Same as above but different colors. -* **Blues (by value)**: Same as above but color scheme go from panel background to blue. +* **Blues (by value)**: Same as above but color scheme go from panel background to blue.
    -As you can see this adds new continuous color schemes where Grafana will interpolate colors. A great use of these new color schemes is the table panel where you can color the background and get a heatmap like effect. +As you can see this adds new continuous color schemes where Grafana will interpolate colors. A great use of these new color schemes is the table panel where you can color the background and get a heatmap like effect. {{< figure src="/img/docs/v73/table_color_scheme.png" max-width="900px" caption="table color scheme" >}} -Another thing to highlight is that all these new color schemes are theme aware and adapt to the current theme. For example here is how the new monochrome color scheme look like in the light theme: +Another thing to highlight is that all these new color schemes are theme aware and adapt to the current theme. For example here is how the new monochrome color scheme look like in the light theme: {{< figure src="/img/docs/v73/table_color_scheme_mono_light.png" max-width="900px" caption="table color monochrome scheme" >}} -As this new option is a standard field option it works in every panel. Here is another example from the [Bar Gauge]({{< relref "../panels/visualizations/bar-gauge-panel.md" >}}) panel. +As this new option is a standard field option it works in every panel. Here is another example from the [Bar Gauge]({{< relref "../panels/visualizations/bar-gauge-panel.md" >}}) panel. {{< figure src="/img/docs/v73/bar_gauge_gradient_color_scheme.png" max-width="900px" caption="bar gauge color scheme" >}} @@ -122,7 +117,7 @@ Example of a login event: "userAgent": "Chrome/86.0.4240.111", "grafanaVersion": "7.3.0" } -``` +``` For more details, see the [Auditing docs]({{}}). @@ -138,11 +133,11 @@ Insights: ### SAML single logout -SAML’s single logout (SLO) capability allows users to log out from all applications associated with the current identity provider (IdP) session established via SAML SSO. For more information, refer to the [docs]({{}}). +SAML’s single logout (SLO) capability allows users to log out from all applications associated with the current identity provider (IdP) session established via SAML SSO. For more information, refer to the [docs]({{}}). ### SAML IdP-initiated single sign on -IdP-initiated single sign on (SSO) allows the user to log in directly from the SAML identity provider (IdP). It is disabled by default for security reasons. For more information, refer to the [docs]({{}}). +IdP-initiated single sign on (SSO) allows the user to log in directly from the SAML identity provider (IdP). It is disabled by default for security reasons. For more information, refer to the [docs]({{}}). ## Upgrading diff --git a/docs/versions.json b/docs/versions.json deleted file mode 100644 index 8bfe5daac4c5c..0000000000000 --- a/docs/versions.json +++ /dev/null @@ -1,19 +0,0 @@ -[ - { "version": "v6.5", "path": "/", "archived": false, "current": true }, - { "version": "v6.4", "path": "/v6.4", "archived": true }, - { "version": "v6.3", "path": "/v6.3", "archived": true }, - { "version": "v6.2", "path": "/v6.2", "archived": true }, - { "version": "v6.1", "path": "/v6.1", "archived": true }, - { "version": "v6.0", "path": "/v6.0", "archived": true }, - { "version": "v5.4", "path": "/v5.4", "archived": true }, - { "version": "v5.3", "path": "/v5.3", "archived": true }, - { "version": "v5.2", "path": "/v5.2", "archived": true }, - { "version": "v5.1", "path": "/v5.1", "archived": true }, - { "version": "v5.0", "path": "/v5.0", "archived": true }, - { "version": "v4.6", "path": "/v4.6", "archived": true }, - { "version": "v4.5", "path": "/v4.5", "archived": true }, - { "version": "v4.4", "path": "/v4.4", "archived": true }, - { "version": "v4.3", "path": "/v4.3", "archived": true }, - { "version": "v4.1", "path": "/v4.1", "archived": true }, - { "version": "v3.1", "path": "/v3.1", "archived": true } -]