Docs: Setup refactor (#49739)

* builds out refactored setup topics

* Automatically fix some relrefs with mv-manager

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Use refs for tutorials content which is outside of this repository

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Manually fix complicated relrefs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* consolidates team sync and db encryption topics

* Fix relrefs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* updates setup index file

* Convert TOML to YAML

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add current alias for new alerting content

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add current aliases to new setup-grafana and configure-security pages

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/setup-grafana/configure-grafana/_index.md

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>

* moves saml docs, updates order in TOC

* Manually fix relrefs

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* added usage insights topics, adjusted weights

* corrected relrefs

* Fix relrefs broken in rebase

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
This commit is contained in:
Christopher Moyer
2022-06-02 11:57:22 -05:00
committed by GitHub
parent 104c4a7630
commit a568d421f8
345 changed files with 1557 additions and 1733 deletions
@@ -14,7 +14,7 @@ A query returns data that Grafana visualizes in dashboards. When you create a pa
- [Add a data source](../../../datasources/add-a-data-source).
- Ensure that you know the query language of the data source.
- [Add a panel]({{< relref "../working-with-panels/add-panel.md" >}}).
- [Add a panel]({{< relref "../working-with-panels/add-panel/" >}}).
**To add a query**:
@@ -23,7 +23,7 @@ A query returns data that Grafana visualizes in dashboards. When you create a pa
1. Click the **Data source** drop-down menu and select a data source.
1. Click **Query options** to configure the maximum number of data points returned by the query and how frequently you want the query to request data from the data source.
For more information about query options, refer to [Query options]({{< relref "../query-options.md" >}}).
For more information about query options, refer to [Query options]({{< relref "../query-options/" >}}).
1. Write the query.
1. Click **Apply**.
@@ -12,8 +12,8 @@ Grafana generates a CSV file that contains your data, including any transformati
## Before you begin
- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}).
- [Add a query]({{< relref "add-a-query.md" >}}).
- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}).
- [Add a query]({{< relref "add-a-query/" >}}).
**To download raw query results**:
@@ -12,8 +12,8 @@ The **Stats** tab displays statistics that tell you how long your query takes, h
## Before you begin
- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}).
- [Add a query]({{< relref "add-a-query.md" >}}).
- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}).
- [Add a query]({{< relref "add-a-query/" >}}).
**To inspect query performance**:
@@ -12,8 +12,8 @@ Inspect query request and response data when you want to troubleshoot a query th
## Before you begin
- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}).
- [Add a query]({{< relref "add-a-query.md" >}}).
- [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}).
- [Add a query]({{< relref "add-a-query/" >}}).
**To inspect query request and response data**:
@@ -16,9 +16,9 @@ This strategy can drastically reduce the number of queries being made when you f
**To share data source queries with another panel**:
1. [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel.md" >}}).
1. [Add a panel to a dashboard]({{< relref "../working-with-panels/add-panel/" >}}).
1. Change the title to "Source panel". You'll use this panel as a source for the other panels.
1. Define the [query]({{< relref "add-a-query.md" >}}) or queries that you want share.
1. Define the [query]({{< relref "add-a-query/" >}}) or queries that you want share.
If you don't have a data source available, use the **Grafana** data source, which returns a random time series that you can use for testing.
@@ -14,7 +14,7 @@ Server-side expressions allow you to manipulate data returned from queries with
## Using expressions
Expressions are primarily used by [Grafana alerting]({{< relref "../../../alerting/_index.md" >}}). The processing is done server-side, so expressions can operate without a browser session. However, expressions can also be used with backend data sources and visualization.
Expressions are primarily used by [Grafana alerting]({{< relref "../../../alerting/" >}}). The processing is done server-side, so expressions can operate without a browser session. However, expressions can also be used with backend data sources and visualization.
> **Note:** Expressions do not work with legacy dashboard alerts.
@@ -22,7 +22,7 @@ Expressions are meant to augment data sources by enabling queries from different
> **Note:** When possible, you should do data processing inside the data source. Copying data from storage to the Grafana server for processing is inefficient, so expressions are targeted at lightweight data processing.
Expressions work with data source queries that return time series or number data. They also operate on [multiple-dimensional data]({{< relref "../../../basics/timeseries-dimensions.md" >}}). For example, a query that returns multiple series, where each series is identified by labels or tags.
Expressions work with data source queries that return time series or number data. They also operate on [multiple-dimensional data]({{< relref "../../../basics/timeseries-dimensions/" >}}). For example, a query that returns multiple series, where each series is identified by labels or tags.
An individual expression takes one or more queries or other expressions as input and adds data to the result. Each individual expression or query is represented by a variable that is a named identifier known as its RefID (e.g., the default letter `A` or `B`).
@@ -35,7 +35,7 @@ Expressions work with two types of data.
- A collection of time series.
- A collection of numbers, where each number is an item.
Each collection is returned from a single data source query or expression and represented by the RefID. Each collection is a set, where each item in the set is uniquely identified by its dimensions which are stored as [labels]({{< relref "../../../basics/timeseries-dimensions.md#labels" >}}) or key-value pairs.
Each collection is returned from a single data source query or expression and represented by the RefID. Each collection is a set, where each item in the set is uniquely identified by its dimensions which are stored as [labels]({{< relref "../../../basics/timeseries-dimensions/#labels" >}}) or key-value pairs.
## Data source queries
@@ -10,11 +10,11 @@ weight: 20
If your data source supports them, then Grafana displays the **Expression** button and shows any existing expressions in the query editor list.
For more information about expressions, refer to [About expressions]({{< relref "about-expressions.md" >}}).
For more information about expressions, refer to [About expressions]({{< relref "about-expressions/" >}}).
## Before you begin
- [Add a panel]({{< relref "../../working-with-panels/add-panel.md" >}}).
- [Add a panel]({{< relref "../../working-with-panels/add-panel/" >}}).
**To write an expression**:
@@ -22,7 +22,7 @@ For more information about expressions, refer to [About expressions]({{< relref
1. Below the query, click **Expression**.
1. In the **Operation** field, select the type of expression you want to write.
For more information about expression operations, refer to [About expressions]({{< relref "about-expressions.md" >}}).
For more information about expression operations, refer to [About expressions]({{< relref "about-expressions/" >}}).
1. Write the expression.
1. Click **Apply**.