diff --git a/.circleci/config.yml b/.circleci/config.yml index ada22cf0d8c..2d5fd2dfdf9 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1147,10 +1147,6 @@ workflows: requires: - grafana-docker-master filters: *filter-only-master - - trigger-docs-update: - requires: - - end-to-end-test - filters: *filter-only-master - release-next-packages: requires: - build-all diff --git a/docs/sources/_index.md b/docs/sources/_index.md old mode 100644 new mode 100755 diff --git a/docs/sources/administration/image_rendering.md b/docs/sources/administration/image_rendering.md old mode 100644 new mode 100755 diff --git a/docs/sources/administration/provisioning.md b/docs/sources/administration/provisioning.md old mode 100644 new mode 100755 index 13d765159ea..d70ed8eb1d0 --- a/docs/sources/administration/provisioning.md +++ b/docs/sources/administration/provisioning.md @@ -15,7 +15,7 @@ In previous versions of Grafana, you could only use the API for provisioning dat ## Config File -Checkout the [configuration](/installation/configuration) page for more information on what you can configure in `grafana.ini` +Checkout the [configuration]({{< relref "../installation/configuration" >}}) page for more information on what you can configure in `grafana.ini` ### Config File Locations @@ -171,7 +171,7 @@ Since not all datasources have the same configuration settings we only have the `{"authType":"keys","defaultRegion":"us-west-2","timeField":"@timestamp"}` -Secure json data is a map of settings that will be encrypted with [secret key](/installation/configuration/#secret-key) from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional. +Secure json data is a map of settings that will be encrypted with [secret key]({{< relref "../installation/configuration/#secret-key" >}}) from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional. | Name | Type | Datasource | Description | | ----| ---- | ---- | --- | diff --git a/docs/sources/alerting/rules.md b/docs/sources/alerting/rules.md old mode 100644 new mode 100755 index 8b203d78776..8006b8f3c49 --- a/docs/sources/alerting/rules.md +++ b/docs/sources/alerting/rules.md @@ -107,7 +107,7 @@ we plan to track state **per series** in a future release. > Starting with Grafana v5.3 you can configure reminders to be sent for triggered alerts. This will send additional notifications > when an alert continues to fire. If other series (like server2 in the example above) also cause the alert rule to fire they will > be included in the reminder notification. Depending on what notification channel you're using you may be able to take advantage -> of this feature for identifying new/existing series causing alert to fire. [Read more about notification reminders here](/alerting/notifications/#send-reminders). +> of this feature for identifying new/existing series causing alert to fire. [Read more about notification reminders here]({{< relref "notifications/#send-reminders" >}}). ### No Data / Null values diff --git a/docs/sources/archive.md b/docs/sources/archive.md index aa36e1ee620..62d420c2598 100644 --- a/docs/sources/archive.md +++ b/docs/sources/archive.md @@ -12,12 +12,10 @@ weight = 200 Here you can find links to older versions of the documentation that might be better suited for your version of Grafana. -- [Latest](http://docs.grafana.org) -- [Version 4.5](http://docs.grafana.org/v4.5) -- [Version 4.4](http://docs.grafana.org/v4.4) -- [Version 4.3](http://docs.grafana.org/v4.3) -- [Version 4.2](http://docs.grafana.org/v4.2) -- [Version 4.1](http://docs.grafana.org/v4.1) -- [Version 4.0](http://docs.grafana.org/v4.0) -- [Version 3.1](http://docs.grafana.org/v3.1) -- [Version 3.0](http://docs.grafana.org/v3.0) +- [Latest](/docs/grafana/latest/) +- [Version 4.5](/docs/grafana/v4.5) +- [Version 4.4](/docs/grafana/v4.4) +- [Version 4.3](/docs/grafana/v4.3) +- [Version 4.2](/docs/grafana/v4.2) +- [Version 4.1](/docs/grafana/v4.1) +- [Version 3.1](/docs/grafana/v3.1) diff --git a/docs/sources/auth/auth-proxy.md b/docs/sources/auth/auth-proxy.md old mode 100644 new mode 100755 index cdeb6632fb4..c0ee6ec8930 --- a/docs/sources/auth/auth-proxy.md +++ b/docs/sources/auth/auth-proxy.md @@ -238,7 +238,7 @@ headers = "Groups:X-WEBAUTH-GROUPS" You use the `X-WEBAUTH-GROUPS` header to send the team information for each user. Specifically, the set of Grafana's group IDs that the user belongs to. -First, we need to set up the mapping between your authentication provider and Grafana. Follow [these instructions]({{< relref "auth/team-sync.md#enable-synchronization-for-a-team" >}}) to add groups to a team within Grafana. +First, we need to set up the mapping between your authentication provider and Grafana. Follow [these instructions]({{< relref "team-sync.md#enable-synchronization-for-a-team" >}}) to add groups to a team within Grafana. Once that's done. You can verify your mappings by querying the API. @@ -296,7 +296,7 @@ curl -H "X-WEBAUTH-USER: leonard" -H "X-WEBAUTH-GROUPS: lokiteamOnExternalSystem With this, the user `leonard` will be automatically placed into the Loki team as part of Grafana authentication. -[Learn more about Team Sync]({{< relref "auth/team-sync.md" >}}) +[Learn more about Team Sync]({{< relref "team-sync.md" >}}) ## Login token and session cookie @@ -306,4 +306,4 @@ a login token and cookie. You only have to configure your auth proxy to provide Requests via other routes will be authenticated using the cookie. Use settings `login_maximum_inactive_lifetime_days` and `login_maximum_lifetime_days` under `[auth]` to control session -lifetime. [Read more about login tokens](/auth/overview/#login-and-short-lived-tokens) +lifetime. [Read more about login tokens]({{< relref "overview/#login-and-short-lived-tokens" >}}) diff --git a/docs/sources/auth/enhanced_ldap.md b/docs/sources/auth/enhanced_ldap.md old mode 100644 new mode 100755 index c9edbd8b561..fcdcfb0b769 --- a/docs/sources/auth/enhanced_ldap.md +++ b/docs/sources/auth/enhanced_ldap.md @@ -12,9 +12,9 @@ weight = 3 # Enhanced LDAP Integration -> Enhanced LDAP Integration is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}). +> Enhanced LDAP Integration is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}). -The enhanced LDAP integration adds additional functionality on top of the [existing LDAP integration]({{< relref "auth/ldap.md" >}}). +The enhanced LDAP integration adds additional functionality on top of the [existing LDAP integration]({{< relref "ldap.md" >}}). ## LDAP Group Synchronization for Teams @@ -28,7 +28,7 @@ Grafana keeps track of all synchronized users in teams and you can see which use This mechanism allows Grafana to remove an existing synchronized user from a team when its LDAP group membership changes. This mechanism also enables you to manually add a user as member of a team and it will not be removed when the user signs in. This gives you flexibility to combine LDAP group memberships and Grafana team memberships. -[Learn more about Team Sync]({{< relref "auth/team-sync.md">}}) +[Learn more about Team Sync]({{< relref "team-sync.md">}})
diff --git a/docs/sources/auth/generic-oauth.md b/docs/sources/auth/generic-oauth.md old mode 100644 new mode 100755 index 58bf4188ac8..3f5a3f8758f --- a/docs/sources/auth/generic-oauth.md +++ b/docs/sources/auth/generic-oauth.md @@ -188,7 +188,7 @@ allowed_organizations = allowed_organizations = ``` -> Note: It's important to ensure that the [root_url](/installation/configuration/#root-url) in Grafana is set in your Azure Application Reply URLs (App -> Settings -> Reply URLs) +> Note: It's important to ensure that the [root_url]({{< relref "../installation/configuration/#root-url" >}}) in Grafana is set in your Azure Application Reply URLs (App -> Settings -> Reply URLs) ## Set up OAuth2 with Centrify diff --git a/docs/sources/auth/github.md b/docs/sources/auth/github.md index 36f7466f0b4..48520ad3e85 100644 --- a/docs/sources/auth/github.md +++ b/docs/sources/auth/github.md @@ -113,4 +113,4 @@ Your GitHub teams can be referenced in two ways: Example: `@grafana/developers` -[Learn more about Team Sync]({{< relref "auth/team-sync.md" >}}) +[Learn more about Team Sync]({{< relref "team-sync.md" >}}) diff --git a/docs/sources/auth/gitlab.md b/docs/sources/auth/gitlab.md index aab05ee86dd..5c4119740e4 100644 --- a/docs/sources/auth/gitlab.md +++ b/docs/sources/auth/gitlab.md @@ -125,5 +125,5 @@ the correct teams. Your GitLab groups can be referenced in the same way as `allowed_groups`, like `example` or `foo/bar`. -[Learn more about Team Sync]({{< relref "auth/enhanced_ldap.md" >}}) +[Learn more about Team Sync]({{< relref "enhanced_ldap.md" >}}) diff --git a/docs/sources/auth/google.md b/docs/sources/auth/google.md index f7faf1a1097..d929dfb0d64 100644 --- a/docs/sources/auth/google.md +++ b/docs/sources/auth/google.md @@ -31,7 +31,7 @@ First, you need to create a Google OAuth Client: ## Enable Google OAuth in Grafana -Specify the Client ID and Secret in the [Grafana configuration file]({{< relref "installation/configuration.md#config-file-locations" >}}). For example: +Specify the Client ID and Secret in the [Grafana configuration file]({{< relref "../installation/configuration.md#config-file-locations" >}}). For example: ```bash [auth.google] diff --git a/docs/sources/auth/ldap.md b/docs/sources/auth/ldap.md index 456b96fb829..fafc280b782 100644 --- a/docs/sources/auth/ldap.md +++ b/docs/sources/auth/ldap.md @@ -24,7 +24,7 @@ This means that you should be able to configure LDAP integration using any compl ## Enable LDAP -In order to use LDAP integration you'll first need to enable LDAP in the [main config file]({{< relref "installation/configuration.md" >}}) as well as specify the path to the LDAP +In order to use LDAP integration you'll first need to enable LDAP in the [main config file]({{< relref "../installation/configuration.md" >}}) as well as specify the path to the LDAP specific configuration file (default: `/etc/grafana/ldap.toml`). ```bash @@ -334,7 +334,7 @@ Please inspect your Active Directory configuration and documentation to find the ## Troubleshooting -To troubleshoot and get more log info enable ldap debug logging in the [main config file]({{< relref "installation/configuration.md" >}}). +To troubleshoot and get more log info enable ldap debug logging in the [main config file]({{< relref "../installation/configuration.md" >}}). ```bash [log] diff --git a/docs/sources/auth/overview.md b/docs/sources/auth/overview.md index b3b9c366ad2..d18d26dfdbb 100644 --- a/docs/sources/auth/overview.md +++ b/docs/sources/auth/overview.md @@ -16,18 +16,18 @@ permissions and org memberships. ## OAuth Integrations -- [Google OAuth]({{< relref "auth/google.md" >}}) -- [GitHub OAuth]({{< relref "auth/github.md" >}}) -- [Gitlab OAuth]({{< relref "auth/gitlab.md" >}}) -- [Generic OAuth]({{< relref "auth/generic-oauth.md" >}}) (Okta2, BitBucket, Azure, OneLogin, Auth0) +- [Google OAuth]({{< relref "google.md" >}}) +- [GitHub OAuth]({{< relref "github.md" >}}) +- [Gitlab OAuth]({{< relref "gitlab.md" >}}) +- [Generic OAuth]({{< relref "generic-oauth.md" >}}) (Okta2, BitBucket, Azure, OneLogin, Auth0) ## LDAP integrations -- [LDAP Authentication]({{< relref "auth/ldap.md" >}}) (OpenLDAP, ActiveDirectory, etc) +- [LDAP Authentication]({{< relref "ldap.md" >}}) (OpenLDAP, ActiveDirectory, etc) ## Auth proxy -- [Auth Proxy]({{< relref "auth/auth-proxy.md" >}}) If you want to handle authentication outside Grafana using a reverse +- [Auth Proxy]({{< relref "auth-proxy.md" >}}) If you want to handle authentication outside Grafana using a reverse proxy. ## Grafana Auth diff --git a/docs/sources/auth/saml.md b/docs/sources/auth/saml.md index d5365c8c31c..b9de2cff364 100644 --- a/docs/sources/auth/saml.md +++ b/docs/sources/auth/saml.md @@ -12,7 +12,7 @@ weight = 5 # SAML Authentication -> SAML Authentication integration is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}). +> SAML Authentication integration is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}). > Only available in Grafana v6.3+ @@ -44,7 +44,7 @@ At the moment of writing, Grafana supports: ## Set up SAML Authentication -To use the SAML integration, you need to enable SAML in the [main config file]({{< relref "installation/configuration.md" >}}). +To use the SAML integration, you need to enable SAML in the [main config file]({{< relref "../installation/configuration.md" >}}). ```bash [auth.saml] @@ -90,7 +90,7 @@ assertion_attribute_email = mail Important to note: -- like any other Grafana configuration, use of [environment variables for these options is supported]({{< relref "installation/configuration.md#using-environment-variables" >}}) +- like any other Grafana configuration, use of [environment variables for these options is supported]({{< relref "../installation/configuration.md#using-environment-variables" >}}) - only one form of configuration option is required. Using multiple forms, e.g. both `certificate` and `certificate_path` will result in an error ## Grafana Configuration @@ -170,7 +170,7 @@ An example is `assertion_attribute_name = "givenName"` where Grafana looks withi ## Troubleshooting -To troubleshoot and get more log info enable saml debug logging in the [main config file]({{< relref "installation/configuration.md" >}}). +To troubleshoot and get more log info enable saml debug logging in the [main config file]({{< relref "../installation/configuration.md" >}}). ```bash [log] diff --git a/docs/sources/auth/team-sync.md b/docs/sources/auth/team-sync.md index 176e042db9d..1d0d1f78843 100644 --- a/docs/sources/auth/team-sync.md +++ b/docs/sources/auth/team-sync.md @@ -12,7 +12,7 @@ weight = 5 # Team Sync -> Team Sync is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}). +> Team Sync is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}). {{< docs-imagebox img="/img/docs/enterprise/team_members_ldap.png" class="docs-image--no-shadow docs-image--right" max-width= "600px" >}} @@ -42,6 +42,6 @@ a user as member of a team and it will not be removed when the user signs in. Th ### Supported Providers -* [LDAP]({{< relref "auth/enhanced_ldap.md#ldap-group-synchronization-for-teams" >}}) -* [GitHub OAuth]({{< relref "auth/github.md#team-sync-enterprise-only" >}}) -* [Auth Proxy]({{< relref "auth/auth-proxy.md#team-sync-enterprise-only">}}) +* [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}}) +* [GitHub OAuth]({{< relref "github.md#team-sync-enterprise-only" >}}) +* [Auth Proxy]({{< relref "auth-proxy.md#team-sync-enterprise-only">}}) diff --git a/docs/sources/enterprise/_index.md b/docs/sources/enterprise/_index.md old mode 100644 new mode 100755 index 4159feddeeb..d7a00c2e6a7 --- a/docs/sources/enterprise/_index.md +++ b/docs/sources/enterprise/_index.md @@ -23,29 +23,29 @@ ___ ### Enhanced LDAP Integration -With Grafana Enterprise you can set up synchronization between LDAP Groups and Teams. [Learn More]({{< relref "auth/enhanced_ldap.md" >}}). +With Grafana Enterprise you can set up synchronization between LDAP Groups and Teams. [Learn More]({{< relref "../auth/enhanced_ldap.md" >}}). ### SAML Authentication -Enables your Grafana Enterprise users to authenticate with SAML. [Learn More]({{< relref "auth/saml.md" >}}). +Enables your Grafana Enterprise users to authenticate with SAML. [Learn More]({{< relref "../auth/saml.md" >}}). ### Team Sync -Team Sync allows you to setup synchronization between teams in Grafana and teams in your auth provider so that your users automatically end up in the right team. [Learn More]({{< relref "auth/team-sync.md" >}}). +Team Sync allows you to setup synchronization between teams in Grafana and teams in your auth provider so that your users automatically end up in the right team. [Learn More]({{< relref "../auth/team-sync.md" >}}). Supported auth providers: -* [LDAP]({{< relref "auth/enhanced_ldap.md#ldap-group-synchronization-for-teams" >}}) -* [GitHub OAuth]({{< relref "auth/github.md#team-sync-enterprise-only" >}}) -* [Auth Proxy]({{< relref "auth/auth-proxy.md#team-sync-enterprise-only">}}) +* [LDAP]({{< relref "../auth/enhanced_ldap.md#ldap-group-synchronization-for-teams" >}}) +* [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}}) +* [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}}) ### Data source permissions -Data source permissions allow you to restrict query access to only specific Teams and Users. [Learn More]({{< relref "permissions/datasource_permissions.md" >}}). +Data source permissions allow you to restrict query access to only specific Teams and Users. [Learn More]({{< relref "../permissions/datasource_permissions.md" >}}). ### Reporting -Reporting make it possible to take any Dashboard and generate a PDF report and setup a schedule to have it delivered. [Learn More]({{< relref "features/reporting.md" >}}). +Reporting make it possible to take any Dashboard and generate a PDF report and setup a schedule to have it delivered. [Learn More]({{< relref "../features/reporting.md" >}}). ### Premium Plugins diff --git a/docs/sources/features/_index.md b/docs/sources/features/_index.md old mode 100644 new mode 100755 diff --git a/docs/sources/features/datasources/azuremonitor.md b/docs/sources/features/datasources/azuremonitor.md old mode 100644 new mode 100755 index 46a0fdaa869..e58953746ff --- a/docs/sources/features/datasources/azuremonitor.md +++ b/docs/sources/features/datasources/azuremonitor.md @@ -155,7 +155,7 @@ Not all metrics returned by the Azure Monitor API have values. The Grafana data ### Azure Monitor Alerting -Grafana alerting is supported for the Azure Monitor service. This is not Azure Alerts support. Read more about how alerting in Grafana works [here]({{< relref "alerting/rules.md" >}}). +Grafana alerting is supported for the Azure Monitor service. This is not Azure Alerts support. Read more about how alerting in Grafana works [here]({{< relref "../../alerting/rules.md" >}}). {{< docs-imagebox img="/img/docs/v60/azuremonitor-alerting.png" class="docs-image--no-shadow" caption="Azure Monitor Alerting" >}} @@ -216,7 +216,7 @@ Examples: ### Application Insights Alerting -Grafana alerting is supported for Application Insights. This is not Azure Alerts support. Read more about how alerting in Grafana works [here]({{< relref "alerting/rules.md" >}}). +Grafana alerting is supported for Application Insights. This is not Azure Alerts support. Read more about how alerting in Grafana works [here]({{< relref "../../alerting/rules.md" >}}). {{< docs-imagebox img="/img/docs/v60/azuremonitor-alerting.png" class="docs-image--no-shadow" caption="Azure Monitor Alerting" >}} diff --git a/docs/sources/features/datasources/cloudwatch.md b/docs/sources/features/datasources/cloudwatch.md old mode 100644 new mode 100755 index 784fe12877c..bfec9ece8d9 --- a/docs/sources/features/datasources/cloudwatch.md +++ b/docs/sources/features/datasources/cloudwatch.md @@ -306,7 +306,7 @@ Please see the AWS documentation for [Service Quotas](https://docs.aws.amazon.co ## Configure the data source with provisioning -It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) +It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}}) Here are some provisioning examples for this data source. diff --git a/docs/sources/features/datasources/elasticsearch.md b/docs/sources/features/datasources/elasticsearch.md index c25a0724e78..e5c31a4d1ab 100644 --- a/docs/sources/features/datasources/elasticsearch.md +++ b/docs/sources/features/datasources/elasticsearch.md @@ -84,7 +84,7 @@ Identifier | Description > Only available in Grafana v6.3+. There are two parameters, `Message field name` and `Level field name`, that can optionally be configured from the data source settings page that determine -which fields will be used for log messages and log levels when visualizing logs in [Explore](/features/explore). +which fields will be used for log messages and log levels when visualizing logs in [Explore]({{< relref "../explore" >}}). For example, if you're using a default setup of Filebeat for shipping logs to Elasticsearch the following configuration should work: @@ -172,7 +172,7 @@ Example dashboard: ## Annotations -[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. Grafana can query any Elasticsearch index for annotation events. @@ -188,7 +188,7 @@ Tags | Optional field name to use for event tags (can be an array or a CSV strin > Only available in Grafana v6.3+. -Querying and displaying log data from Elasticsearch is available via [Explore](/features/explore). +Querying and displaying log data from Elasticsearch is available via [Explore]({{< relref "../explore" >}}).  @@ -208,7 +208,7 @@ Optionally enter a lucene query into the query field to filter the log messages. ## Configure the data source with provisioning -It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) +It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}}) Here are some provisioning examples for this data source. diff --git a/docs/sources/features/datasources/graphite.md b/docs/sources/features/datasources/graphite.md old mode 100644 new mode 100755 index 29eb1f3a41f..10f03fa0ce2 --- a/docs/sources/features/datasources/graphite.md +++ b/docs/sources/features/datasources/graphite.md @@ -163,7 +163,7 @@ Checkout the [Advanced Formatting Options section in the Variables]({{< relref " ## Annotations -[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. Graphite supports two ways to query annotations. A regular metric query, for this you use the `Graphite query` textbox. A Graphite events query, use the `Graphite event tags` textbox, @@ -171,7 +171,7 @@ specify a tag or wildcard (leave empty should also work) ## Configure the data source with provisioning -It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) +It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}}) Here are some provisioning examples for this data source. diff --git a/docs/sources/features/datasources/influxdb.md b/docs/sources/features/datasources/influxdb.md old mode 100644 new mode 100755 index a6b48c5d9a4..150365f04a8 --- a/docs/sources/features/datasources/influxdb.md +++ b/docs/sources/features/datasources/influxdb.md @@ -121,7 +121,7 @@ change the option `Format As` to `Table` if you want to show raw data in the `Ta > Only available in Grafana v6.3+. -Querying and displaying log data from InfluxDB is available via [Explore](/features/explore). +Querying and displaying log data from InfluxDB is available via [Explore]({{< relref "../explore" >}}).  @@ -203,7 +203,7 @@ be applied to all your InfluxDB queries. ## Annotations -[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. Add annotation queries using the Annotations view in the Dashboard menu. +[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. Add annotation queries using the Annotations view in the Dashboard menu. An example query: diff --git a/docs/sources/features/datasources/loki.md b/docs/sources/features/datasources/loki.md old mode 100644 new mode 100755 index 88ab4f54456..b85fddf59c1 --- a/docs/sources/features/datasources/loki.md +++ b/docs/sources/features/datasources/loki.md @@ -18,7 +18,7 @@ weight = 6 > Viewing Loki data in dashboard panels is supported in Grafana v6.4+. Grafana ships with built-in support for Loki, Grafana's log aggregation system. -Just add it as a data source and you are ready to query your log data in [Explore](/features/explore). +Just add it as a data source and you are ready to query your log data in [Explore]({{< relref "../explore" >}}). ## Adding the data source @@ -57,7 +57,7 @@ The new field with the link shown in log details: ## Querying Logs -Querying and displaying log data from Loki is available via [Explore](/features/explore), and with the [logs panel](/features/panels/logs/) in dashboards. Select the Loki data source, and then enter a log query to display your logs. +Querying and displaying log data from Loki is available via [Explore]({{< relref "../explore" >}}), and with the [logs panel]({{< relref "../panels/logs/" >}}) in dashboards. Select the Loki data source, and then enter a log query to display your logs. ### Log Queries @@ -125,7 +125,7 @@ The following filter types are currently supported: ## Live tailing -Loki supports Live tailing which displays logs in real-time. This feature is supported in [Explore](/features/explore/#loki-specific-features) and in dashboards with a Live toggle in the query editor. +Loki supports Live tailing which displays logs in real-time. This feature is supported in [Explore]({{< relref "../explore/#loki-specific-features" >}}) and in dashboards with a Live toggle in the query editor. Note that Live Tailing relies on two Websocket connections: one between the browser and the Grafana server, and another between the Grafana server and the Loki server. If you run any reverse proxies, please configure them accordingly. @@ -144,7 +144,7 @@ log message you're interested in. Instead of hard-coding things like server, application and sensor name in your metric queries, you can use variables in their place. Variables are shown as drop-down select boxes at the top of the dashboard. These drop-down boxes make it easy to change the data being displayed in your dashboard. -Checkout the [Templating](/reference/templating) documentation for an introduction to the templating feature and the different types of template variables. +Checkout the [Templating]({{< relref "../../reference/templating" >}}) documentation for an introduction to the templating feature and the different types of template variables. ## Annotations @@ -155,7 +155,7 @@ You can use any non-metric Loki query as a source for annotations. Log content w ## Configure the data source with provisioning You can set up the data source via config files with Grafana's provisioning system. -You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) +You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}}) Here is an example: diff --git a/docs/sources/features/datasources/mssql.md b/docs/sources/features/datasources/mssql.md index 5b2718b1d86..92c9a05afd5 100644 --- a/docs/sources/features/datasources/mssql.md +++ b/docs/sources/features/datasources/mssql.md @@ -39,7 +39,7 @@ Name | Description ### Min time interval -A lower limit for the [$__interval](/reference/templating/#the-interval-variable) and [$__interval_ms](/reference/templating/#the-interval-ms-variable) variables. +A lower limit for the [$__interval]({{< relref "../../reference/templating/#the-interval-variable" >}}) and [$__interval_ms]({{< relref "../../reference/templating/#the-interval-ms-variable" >}}) variables. Recommended to be set to write frequency, for example `1m` if your data is written every minute. This option can also be overridden/configured in a dashboard panel under data source options. It's important to note that this value **needs** to be formatted as a number followed by a valid time identifier, e.g. `1m` (1 minute) or `30s` (30 seconds). The following time identifiers are supported: @@ -374,7 +374,7 @@ Read more about variable formatting options in the [Variables]({{< relref "../.. ## Annotations -[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. +[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. **Columns:** @@ -579,7 +579,7 @@ conditions. ## Configure the data source with provisioning -It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) +It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}}) Here are some provisioning examples for this data source. diff --git a/docs/sources/features/datasources/mysql.md b/docs/sources/features/datasources/mysql.md old mode 100644 new mode 100755 index eb09eafbc32..557cb5795b1 --- a/docs/sources/features/datasources/mysql.md +++ b/docs/sources/features/datasources/mysql.md @@ -41,7 +41,7 @@ Name | Description ### Min time interval -A lower limit for the [$__interval](/reference/templating/#the-interval-variable) and [$__interval_ms](/reference/templating/#the-interval-ms-variable) variables. +A lower limit for the [$__interval]({{< relref "../../reference/templating/#the-interval-variable" >}}) and [$__interval_ms]({{< relref "../../reference/templating/#the-interval-ms-variable" >}}) variables. Recommended to be set to write frequency, for example `1m` if your data is written every minute. This option can also be overridden/configured in a dashboard panel under data source options. It's important to note that this value **needs** to be formatted as a number followed by a valid time identifier, e.g. `1m` (1 minute) or `30s` (30 seconds). The following time identifiers are supported: @@ -335,7 +335,7 @@ Read more about variable formatting options in the [Variables]({{< relref "../.. ## Annotations -[Annotations]({{< relref "reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. +[Annotations]({{< relref "../../reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. **Example query using time column with epoch values:** @@ -375,7 +375,7 @@ Time series queries should work in alerting conditions. Table formatted queries ## Configure the data source with provisioning -It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) +It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}}) Here are some provisioning examples for this data source. diff --git a/docs/sources/features/datasources/opentsdb.md b/docs/sources/features/datasources/opentsdb.md index 745bae1848a..4136a91d98c 100644 --- a/docs/sources/features/datasources/opentsdb.md +++ b/docs/sources/features/datasources/opentsdb.md @@ -90,7 +90,7 @@ For details on OpenTSDB metric queries checkout the official [OpenTSDB documenta ## Configure the data source with provisioning -It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) +It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}}) Here are some provisioning examples for this data source. diff --git a/docs/sources/features/datasources/postgres.md b/docs/sources/features/datasources/postgres.md old mode 100644 new mode 100755 index a88e70b355b..10bb0a0f56f --- a/docs/sources/features/datasources/postgres.md +++ b/docs/sources/features/datasources/postgres.md @@ -41,7 +41,7 @@ Name | Description ### Min time interval -A lower limit for the [$__interval](/reference/templating/#the-interval-variable) and [$__interval_ms](/reference/templating/#the-interval-ms-variable) variables. +A lower limit for the [$__interval]({{< relref "../../reference/templating/#the-interval-variable" >}}) and [$__interval_ms]({{< relref "../../reference/templating/#the-interval-ms-variable" >}}) variables. Recommended to be set to write frequency, for example `1m` if your data is written every minute. This option can also be overridden/configured in a dashboard panel under data source options. It's important to note that this value **needs** to be formatted as a number followed by a valid time identifier, e.g. `1m` (1 minute) or `30s` (30 seconds). The following time identifiers are supported: @@ -339,7 +339,7 @@ Read more about variable formatting options in the [Variables]({{< relref "../.. ## Annotations -[Annotations]({{< relref "reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. +[Annotations]({{< relref "../../reference/annotations.md" >}}) allow you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. **Example query using time column with epoch values:** @@ -380,7 +380,7 @@ conditions. ## Configure the data source with provisioning -It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) +It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}}) Here are some provisioning examples for this data source. diff --git a/docs/sources/features/datasources/prometheus.md b/docs/sources/features/datasources/prometheus.md old mode 100644 new mode 100755 index 514dde31580..2c80b9ce41e --- a/docs/sources/features/datasources/prometheus.md +++ b/docs/sources/features/datasources/prometheus.md @@ -62,7 +62,7 @@ Open a graph in edit mode by click the title > Edit (or by pressing `e` key whil The Prometheus datasource allows you to run "instant" queries, which queries only the latest value. You can visualize the results in a table panel to see all available labels of a timeseries. -Instant query results are made up only of one datapoint per series but can be shown in the graph panel with the help of [series overrides](/features/panels/graph/#series-overrides). +Instant query results are made up only of one datapoint per series but can be shown in the graph panel with the help of [series overrides]({{< relref "../panels/graph/#series-overrides" >}}). To show them in the graph as a latest value point, add a series override and select `Points > true`. To show a horizontal line across the whole graph, add a series override and select `Transform > constant`. @@ -96,7 +96,7 @@ For details of _metric names_, _label names_ and _label values_ are please refer > Support for `$__range`, `$__range_s` and `$__range_ms` only available from Grafana v5.3 -It's possible to use some global built-in variables in query variables; `$__interval`, `$__interval_ms`, `$__range`, `$__range_s` and `$__range_ms`, see [Global built-in variables](/reference/templating/#global-built-in-variables) for more information. These can be convenient to use in conjunction with the `query_result` function when you need to filter variable queries since +It's possible to use some global built-in variables in query variables; `$__interval`, `$__interval_ms`, `$__range`, `$__range_s` and `$__range_ms`, see [Global built-in variables]({{< relref "../../reference/templating/#global-built-in-variables" >}}) for more information. These can be convenient to use in conjunction with the `query_result` function when you need to filter variable queries since `label_values` function doesn't support queries. Make sure to set the variable's `refresh` trigger to be `On Time Range Change` to get the correct instances when changing the time range on the dashboard. @@ -129,7 +129,7 @@ options are enabled, Grafana converts the labels from plain text to a regex comp ## Annotations -[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. Prometheus supports two ways to query annotations. @@ -145,7 +145,7 @@ Since 4.6.0 Grafana exposes metrics for Prometheus on the `/metrics` endpoint. W ## Configure the data source with provisioning -It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) +It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}}) Here are some provisioning examples for this data source. diff --git a/docs/sources/features/datasources/stackdriver.md b/docs/sources/features/datasources/stackdriver.md old mode 100644 new mode 100755 index 2421e5a1f49..dab0b3b2585 --- a/docs/sources/features/datasources/stackdriver.md +++ b/docs/sources/features/datasources/stackdriver.md @@ -202,7 +202,7 @@ Why two ways? The first syntax is easier to read and write but does not allow yo {{< docs-imagebox img="/img/docs/v53/stackdriver_annotations_query_editor.png" max-width= "400px" class="docs-image--right" >}} -[Annotations]({{< relref "reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation +[Annotations]({{< relref "../../reference/annotations.md" >}}) allows you to overlay rich event information on top of graphs. You add annotation queries via the Dashboard menu / Annotations view. Annotation rendering is expensive so it is important to limit the number of rows returned. There is no support for showing Stackdriver annotations and events yet but it works well with [custom metrics](https://cloud.google.com/monitoring/custom-metrics/) in Stackdriver. With the query editor for annotations, you can select a metric and filters. The `Title` and `Text` fields support templating and can use data returned from the query. For example, the Title field could have the following text: @@ -224,7 +224,7 @@ Example Result: `monitoring.googleapis.com/uptime_check/http_status has this val ## Configure the data source with provisioning -It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page](/administration/provisioning/#datasources) +It's now possible to configure data sources using config files with Grafana's provisioning system. You can read more about how it works and all the settings you can set for data sources on the [provisioning docs page]({{< relref "../../administration/provisioning/#datasources" >}}) Here is a provisioning example using the JWT (Service Account key file) authentication type. diff --git a/docs/sources/features/explore/index.md b/docs/sources/features/explore/index.md old mode 100644 new mode 100755 diff --git a/docs/sources/features/panels/graph.md b/docs/sources/features/panels/graph.md old mode 100644 new mode 100755 index 969018ec234..26b15cc9ee8 --- a/docs/sources/features/panels/graph.md +++ b/docs/sources/features/panels/graph.md @@ -187,7 +187,7 @@ Time regions allow you to highlight certain time regions of the graph to make it The time range tab allows you to override the dashboard time range and specify a panel specific time. Either through a relative from now time option or through a timeshift. -Panel time overrides and timeshift are described in more detail [here]({{< relref "reference/timerange.md#panel-time-overrides-timeshift" >}}). +Panel time overrides and timeshift are described in more detail [here]({{< relref "../../reference/timerange.md#panel-time-overrides-timeshift" >}}). ### Data link diff --git a/docs/sources/features/panels/heatmap.md b/docs/sources/features/panels/heatmap.md old mode 100644 new mode 100755 diff --git a/docs/sources/features/panels/logs.md b/docs/sources/features/panels/logs.md old mode 100644 new mode 100755 diff --git a/docs/sources/features/panels/singlestat.md b/docs/sources/features/panels/singlestat.md old mode 100644 new mode 100755 diff --git a/docs/sources/features/panels/table_panel.md b/docs/sources/features/panels/table_panel.md old mode 100644 new mode 100755 diff --git a/docs/sources/features/reporting.md b/docs/sources/features/reporting.md old mode 100644 new mode 100755 index 83ebfd32fb5..89c3687846b --- a/docs/sources/features/reporting.md +++ b/docs/sources/features/reporting.md @@ -11,7 +11,7 @@ weight = 8 # Reporting -> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "enterprise" >}}). +> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "../enterprise" >}}). > Only available in Grafana v6.4+ @@ -27,7 +27,7 @@ With Reports there are a few things to keep in mind, most importantly, any chang > SMTP must be configured for reports to be sent -We recommend using the new image rendering plugin with reporting as it supports a wider range of panels than the built-in image rendering. Read more about it [here]({{< relref "administration/image_rendering.md#grafana-image-renderer-plugin" >}}) +We recommend using the new image rendering plugin with reporting as it supports a wider range of panels than the built-in image rendering. Read more about it [here]({{< relref "../administration/image_rendering.md#grafana-image-renderer-plugin" >}}) ## Usage @@ -46,4 +46,4 @@ Currently only Organisation Admins can create reports. To get to report click on ## Debugging errors -If you have problems with the reporting feature you can enable debug logging by switching the logger to debug (`filters = report:debug`). Learn more about making configuration changes [here]({{< relref "installation/configuration.md#filters" >}}). +If you have problems with the reporting feature you can enable debug logging by switching the logger to debug (`filters = report:debug`). Learn more about making configuration changes [here]({{< relref "../installation/configuration.md#filters" >}}). diff --git a/docs/sources/guides/basic_concepts.md b/docs/sources/guides/basic_concepts.md old mode 100644 new mode 100755 index dcb432eb7bc..fd3cf2df74b --- a/docs/sources/guides/basic_concepts.md +++ b/docs/sources/guides/basic_concepts.md @@ -20,12 +20,12 @@ Grafana supports many different storage backends for your time series data (Data The following data sources are officially supported: -* [CloudWatch]({{< relref "features/datasources/cloudwatch.md" >}}) -* [Elasticsearch]({{< relref "features/datasources/elasticsearch.md" >}}) -* [Graphite]({{< relref "features/datasources/graphite.md" >}}) -* [InfluxDB]({{< relref "features/datasources/influxdb.md" >}}) -* [OpenTSDB]({{< relref "features/datasources/opentsdb.md" >}}) -* [Prometheus]({{< relref "features/datasources/prometheus.md" >}}) +* [CloudWatch]({{< relref "../features/datasources/cloudwatch.md" >}}) +* [Elasticsearch]({{< relref "../features/datasources/elasticsearch.md" >}}) +* [Graphite]({{< relref "../features/datasources/graphite.md" >}}) +* [InfluxDB]({{< relref "../features/datasources/influxdb.md" >}}) +* [OpenTSDB]({{< relref "../features/datasources/opentsdb.md" >}}) +* [Prometheus]({{< relref "../features/datasources/prometheus.md" >}}) The query language and capabilities of each Data Source are obviously very different. You can combine data from multiple Data Sources onto a single Dashboard, but each Panel is tied to a specific Data Source that belongs to a particular Organization. diff --git a/docs/sources/guides/getting_started.md b/docs/sources/guides/getting_started.md old mode 100644 new mode 100755 index 7d461e7d561..278a63addf2 --- a/docs/sources/guides/getting_started.md +++ b/docs/sources/guides/getting_started.md @@ -13,11 +13,11 @@ weight = 1 # Getting started -This guide will help you get started and acquainted with Grafana. It assumes you have a working Grafana server up and running. If not please read the [installation guide](/installation/). +This guide will help you get started and acquainted with Grafana. It assumes you have a working Grafana server up and running. If not please read the [installation guide]({{< relref "../installation/" >}}). ## Logging in for the first time -To run Grafana open your browser and go to http://localhost:3000/. 3000 is the default HTTP port that Grafana listens to if you haven't [configured a different port](/installation/configuration/#http-port). +To run Grafana open your browser and go to http://localhost:3000/. 3000 is the default HTTP port that Grafana listens to if you haven't [configured a different port]({{< relref "../installation/configuration/#http-port" >}}). There you will see the login page. Default username is admin and default password is admin. When you log in for the first time you will be asked to change your password. We strongly encourage you to follow Grafana’s best practices and change the default administrator password. You can later go to user preferences and change your user name. @@ -36,7 +36,7 @@ Click Add data source and you will come to the settings page of your new data so {{< docs-imagebox img="/img/docs/v52/add-datasource.png" max-width="700px" class="docs-image--no-shadow">}} -First, give the data source a Name and then select which Type of data source you'll want to create, see [Supported data sources](/features/datasources/#supported-data-sources/) for more information and how to configure your data source. +First, give the data source a Name and then select which Type of data source you'll want to create, see [Supported data sources]({{< relref "../features/datasources/#supported-data-sources/" >}}) for more information and how to configure your data source. {{< docs-imagebox img="/img/docs/v52/datasource-settings.png" max-width="700px" class="docs-image--no-shadow">}} @@ -49,7 +49,7 @@ Watch the 10min [beginners guide to building dashboards](https://www.youtube.com ## Basic concepts -Read the [Basic Concepts](/guides/basic_concepts) document to get a crash course in key Grafana concepts. +Read the [Basic Concepts]({{< relref "basic_concepts" >}}) document to get a crash course in key Grafana concepts. ### Top header @@ -69,7 +69,7 @@ The image above shows you the top header for a Dashboard. ## Dashboards, panels, the building blocks of Grafana... -Dashboards are at the core of what Grafana is all about. Dashboards are composed of individual Panels arranged on a grid. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect Dashboard for your need. Each Panel can interact with data from any configured Grafana Data Source (currently Graphite, Prometheus, Elasticsearch, InfluxDB, OpenTSDB, MySQL, PostgreSQL, Microsoft SQL Server and AWS Cloudwatch). The [Basic Concepts](/guides/basic_concepts) guide explores these key ideas in detail. +Dashboards are at the core of what Grafana is all about. Dashboards are composed of individual Panels arranged on a grid. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect Dashboard for your need. Each Panel can interact with data from any configured Grafana Data Source (currently Graphite, Prometheus, Elasticsearch, InfluxDB, OpenTSDB, MySQL, PostgreSQL, Microsoft SQL Server and AWS Cloudwatch). The [Basic Concepts]({{< relref "basic_concepts" >}}) guide explores these key ideas in detail.