Docs/panel refactor (#43569)

* new refactored panel docs

* fixed links

* removed xtra sharing link, added links to panel display option tasks

* fixed typo

* add aliases

* incorporate PM feedback

* intermediate commit to resolve merge conflict

* final changes to resolve merge conflicts
This commit is contained in:
Christopher Moyer
2022-01-18 15:06:27 -06:00
committed by GitHub
parent 959723050f
commit 449c608ef1
118 changed files with 2043 additions and 1668 deletions
@@ -0,0 +1,12 @@
+++
title = "Enable template variables to add panels dynamically"
keywords = ["dynamic", "variable", "panel"]
aliases = ["/docs/grafana/latest/panels/repeat-panels-or-rows/", "/docs/sources/panels/add-panels-dynamically/"]
weight = 800
+++
# Enable template variables to add panels dynamically
Harness the power of Grafana by configuring the system to automatically and dynamically add panels based on criteria that you define.
{{< section >}}
@@ -0,0 +1,16 @@
+++
title = "About repeating panels or rows"
weight = 10
aliases = ["/docs/sources/panels/add-panels-dynamically/about-repeating-panels-rows/"]
+++
# About repeating panels and rows
You can configure Grafana to dynamically add panels or rows to a dashboard. A dynamic panel (or row) is a panel that the system creates based on the value of a variable. Variables dynamically change your queries across all panels in a dashboard.
## Grafana Play examples
You can see examples in the following dashboards:
- [Prometheus repeat](https://play.grafana.org/d/000000036/prometheus-repeat)
- [Repeated Rows Dashboard](https://play.grafana.org/d/000000153/repeat-rows).
@@ -0,0 +1,28 @@
+++
title = "Configure repeating panels"
weight = 20
aliases = ["/docs/sources/panels/add-panels-dynamically/configure-repeating-panels/"]
+++
# Configure repeating panels
For queries that return multiple values for a variable, you can configure Grafana to dynamically add panels based on those values.
> **Note:** Repeating panels require variables to have one or more items selected; you cannot repeat a panel zero times to hide it.
## Before you begin
- Ensure that the query includes a multi-value variable.
**To configure repeating panels**:
1. Edit the panel you want to repeat.
1. On the display options pane, expand **Panel options > Repeat options**.
1. Select a `direction`.
- Choose `horizontal` to arrange panels side-by-side. Grafana adjusts the width of a repeated panel. Currently, you cannot mix other panels on a row with a repeated panel.
- Choose `vertical` to arrange panels in a column. The width of repeated panels is the same as the original, repeated panel.
1. To propagate changes to all panels, reload the dashboard.
@@ -0,0 +1,26 @@
+++
title = "Configure repeating rows"
weight = 30
aliases = ["/docs/sources/panels/add-panels-dynamically/configure-repeating-rows/"]
+++
# Configure repeating rows
As seen above with the panels you can also repeat rows if you have variables set with `Multi-value` or
`Include all value` selection option.
## Before you begin
- Ensure that the query includes a multi-value variable.
**To configure repeating rows**:
1. On the dashboard home page, click **Add panel**.
1. On the **Add a panel** dialog box, click **Add a new row**.
1. Hover over the row title and click the cog icon.
1. On the `Row Options` configuration panel, select the variable for which you want to add repeating rows.
> To help provide context to dashboard users, add the variable to the row title.