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,20 @@
+++
title = "Transform data"
aliases = ["/docs/grafana/latest/panels/transformations/", "/docs/grafana/latest/panels/transformations/config-from-query/", "/docs/grafana/latest/panels/transformations/rows-to-fields/", "/docs/grafana/latest/panels/transformations/apply-transformations/", "/docs/sources/panels/transform-data/"]
weight = 500
+++
# Transform data
Transformations are a powerful way to manipulate data returned by a query before the system applies a visualization.
With transformations, you can:
- Rename fields
- Join time series data
- Perform mathematical operations across queries
- Use the output of one transformation as the input to another transformation
This section includes the following topics:
{{< section >}}
@@ -0,0 +1,31 @@
+++
title = "About transformations"
weight = 10
aliases = ["/docs/sources/panels/transform-data/about-transformation/"]
+++
# About transformations
Transformations process the result set of a query before it’s passed on for visualization. Using transformations, you can:
- Rename fields
- Join time series data
- Perform mathematical operations across queries
- Use the output of one transformation as the input to another transformation
For users that rely on multiple views of the same dataset, transformations offer an efficient method of creating and maintaining numerous dashboards.
You can also use the output of one transformation as the input to another transformation, which results in a performance gain.
> Sometimes the system cannot graph transformed data. When that happens, click the `Table view` toggle above the visualization to switch to a table view of the data. This can help you understand the final result of your transformations.
## Transformation types
Grafana provides a number of ways that you can transform data. For a complete list of transformations, refer to
[Reference: Transformation functions]({{< relref "../reference-transformation-functions.md" >}}).
## Order of transformations
When there are multiple transformations, Grafana applies them in the order they are listed. Each transformation creates a result set that then passes on to the next transformation in the processing pipeline.
The order in which Grafana applies transformations directly impacts the results. For example, if you use a Reduce transformation to condense all the results of one column into a single value, then you can only apply transformations to that single value.
@@ -0,0 +1,36 @@
+++
title = "Apply a transformation to data"
weight = 20
aliases = ["/docs/sources/panels/transform-data/apply-transformation-to-data/"]
+++
# Apply a transformation function to data
The following steps guide you in applying a transformation to data. This documentation does not include steps for each type of transformation. For a complete list of transformations, refer to [Reference: Transformation functions]({{< relref "../reference-transformation-functions.md" >}}).
## Before you begin
- [Add a query]({{< relref "../query-a-data-source/add-a-query.md" >}}).
**To apply a transformation function to data**:
1. Navigate to the panel where you want to add one or more transformations.
1. Click the panel title and then click **Edit**.
1. Click the **Transform** tab.
1. Click a transformation.
A transformation row appear where you configure the transformation options. For more information about how to configure a transformation, refer to [Reference: Transformation functions]({{< relref "../reference-transformation-functions.md" >}}).
For information about available calculations, refer to [Reference: Calculations]({{< relref "../reference-calculation-types.md" >}}).
1. To apply another transformation, click **Add transformation**.
This transformation acts on the result set returned by the previous transformation.
{{< figure src="/static/img/docs/transformations/transformations-7-0.png" class="docs-image--no-shadow" max-width= "1100px" >}}
## Options
- **Config query**: Select the query that returns the data you want to use as configuration.
- **Apply to**: Select what fields or series to apply the configuration to.
- **Apply to options**: Usually a field type or field name regex depending on what option you selected in **Apply to**.
@@ -0,0 +1,13 @@
+++
title = "Debug a transformation"
weight = 30
aliases = ["/docs/sources/panels/transform-data/debug-transformation/"]
+++
# Debug a transformation
To see the input and the output result sets of the transformation, click the bug icon on the right side of the transformation row.
The input and output results sets can help you debug a transformation.
{{< figure src="/static/img/docs/transformations/debug-transformations-7-0.png" class="docs-image--no-shadow" max-width= "1100px" >}}
@@ -0,0 +1,19 @@
+++
title = "Delete a transformation"
weight = 40
aliases = ["/docs/sources/panels/transform-data/delete-transformation/"]
+++
# Delete a transformation
We recommend that you remove transformations that you don't need. When you delete a transformation, you remove the data from the visualization.
## Before you begin
- Identify all dashboards that rely on the transformation and inform impacted dashboard users.
**To delete a transformation**:
1. Open a panel for editing.
1. Click the **Transform** tab.
1. Click the trash icon next to the transformation you want to delete.