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

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

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

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

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

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

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

@@ -1,7 +1,6 @@
 +++
 title = "Filter table columns"
 keywords = ["grafana", "table options", "documentation", "format tables", "table filter", "filter columns"]
-type = "docs"
 weight = 600
 +++

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