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>
2020-11-09 12:26:49 -08:00
parent a7e092f243
commit abee02dbcd
271 changed files with 260 additions and 1266 deletions
@@ -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
@@ -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">}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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