Docs: update content to work with website repo (#20693)

Updates the docs to work with the website repo - mainly relative link updates. Adds a menu.yaml file to build the sidebar menu (no longer using front matter weight).
2019-12-05 13:09:57 +01:00
parent 827688f152
commit cbd81ffeb8
73 changed files with 507 additions and 197 deletions
@@ -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" >}}

@@ -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.

@@ -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" >}}).

 ![](/img/docs/v63/elasticsearch_explore_logs.png)

@@ -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.

@@ -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.

@@ -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" >}}).

 ![](/img/docs/v63/influxdb_explore_logs.png)

@@ -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:

@@ -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:

@@ -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.

@@ -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.

@@ -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.

@@ -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.

@@ -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.

@@ -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.