Prepare dashboards, panels, and visualizations for Grafana Cloud mount (#73632)

* Update dashboards pages to use `docs/reference` shortcode

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

* Update panels-visualizations pages to use `docs/reference` shortcode

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

* Use raw Markdown admonitions for contextual links

See https://discourse.gohugo.io/t/markdown-reference-links-in-shortcodes/5770/3.
Should be resolved by https://docs.google.com/document/d/19xd4CD3IrAqQqNR3xQeLfuIV-u2iNSQSBEvPZE9J4qU/edit#heading=h.5sybau7waq2q.

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

* Prefer "Warning" over "Caution"

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Prettier

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

* Fix some links missing destinations

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

* Fix 'time range controls' link

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

* Add missing 'HTTP APIs' link

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

* Fix dashboard links missing destinations

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

* Fix links missing destinations in panels and visualizations documentation

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

* Fix dud link

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
This commit is contained in:
Jack Baldry
2023-09-13 11:39:04 +02:00
committed by GitHub
co-authored by Isabel
parent 00c6b87210
commit 7ef7cedc11
50 changed files with 963 additions and 320 deletions
@@ -24,7 +24,7 @@ weight: 200
# Query and transform data
Grafana supports many types of [data sources]({{< relref "../../datasources/" >}}).
Grafana supports many types of [data sources][].
Data source **queries** return data that Grafana can **transform** and visualize.
Each data source uses its own query language, and data source plugins each implement a query-building user interface called a query editor.
@@ -37,7 +37,7 @@ You can configure query frequency and data collection limits in the panel's data
Grafana supports up to 26 queries per panel.
> **Important:** You **must** be familiar with a data source's query language.
> For more information, refer to [Data sources]({{< relref "../../datasources/" >}}).
> For more information, refer to [Data sources][].
### Query editors
@@ -54,10 +54,10 @@ For example, this video demonstrates the visual Prometheus query builder:
For details on a specific data source's unique query editor features, refer to its documentation:
- For data sources included with Grafana, refer to [Built-in core data sources]({{< relref "../../datasources/#data-source-plugins" >}}), which links to each core data source's documentation.
- For data sources included with Grafana, refer to [Built-in core data sources][], which links to each core data source's documentation.
- For data sources installed as plugins, refer to its own documentation.
- Data source plugins in Grafana's [plugin catalog](/grafana/plugins/) link to or include their documentation in their catalog listings.
For details about the plugin catalog, refer to [Plugin management]({{< relref "../../administration/plugin-management/" >}}).
For details about the plugin catalog, refer to [Plugin management][].
- For links to Grafana Enterprise data source plugin documentation, refer to the [Enterprise plugins index](/docs/plugins/).
### Query syntax
@@ -80,19 +80,19 @@ query_result(max_over_time(<metric>[${__range_s}s]) != <state>)
### Special data sources
Grafana also includes three special data sources: **Grafana**, **Mixed**, and **Dashboard**.
For details, refer to [Data sources]({{< relref "../../datasources/#special-data-sources" >}})
For details, refer to [Data sources][]
## Navigate the Query tab
A panel's Query tab consists of the following elements:
- **Data source selector:** Selects the data source to query.
For more information about data sources, refer to [Data sources]({{< relref "../../datasources/" >}}).
For more information about data sources, refer to [Data sources][].
- **Query options:** Sets maximum data retrieval parameters and query execution time intervals.
- **Query inspector button:** Opens the query inspector panel, where you can view and optimize your query.
- **Query editor list:** Lists the queries you've written.
- **Expressions:** Uses the expression builder to create alert expressions.
For more information about expressions, refer to [Use expressions to manipulate data]({{< relref "expression-queries/" >}}).
For more information about expressions, refer to [Use expressions to manipulate data][].
{{< figure src="/static/img/docs/queries/query-editor-7-2.png" class="docs-image--no-shadow" max-width="1000px" >}}
@@ -110,7 +110,7 @@ When you create a panel, Grafana automatically selects the default data source.
If you're creating a new dashboard, you'll be prompted to select a data source when you add the first panel.
1. Click **Query options** to configure the maximum number of data points you need.
For more information about query options, refer to [Query options]({{< relref "#query-options" >}}).
For more information about query options, refer to [Query options](#query-options).
1. Write the query using the query editor.
1. Click **Apply**.
@@ -169,7 +169,7 @@ Panel data source query options include:
As the user zooms out on a visualization, the interval grows, resulting in a more coarse-grained aggregation.
Likewise, if the user zooms in, the interval decreases, resulting in a more fine-grained aggregation.
For more information, refer to [Global variables]({{< relref "../../dashboards/variables/add-template-variables/#global-variables" >}}).
For more information, refer to [Global variables][].
- **Relative time:** Overrides the relative time range for individual panels, which causes them to be different than what is selected in the dashboard time picker in the top-right corner of the dashboard.
You can use this to show metrics from different time periods or days on the same dashboard.
@@ -199,3 +199,23 @@ Panel data source query options include:
- **Cache timeout:** _(Visible only if available in the data source)_ Overrides the default cache timeout if your time series store has a query cache.
Specify this value as a numeric value in seconds.
{{% docs/reference %}}
[Use expressions to manipulate data]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/query-transform-data/expression-queries"
[Use expressions to manipulate data]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/panels-visualizations/query-transform-data/expression-queries"
[Plugin management]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/administration/plugin-management"
[Plugin management]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/administration/plugin-management"
[Global variables]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/variables/add-template-variables#global-variables"
[Global variables]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/variables/add-template-variables#global-variables"
[Built-in core data sources]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/datasources#data-source-plugins"
[Built-in core data sources]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/datasources#data-source-plugins"
[data sources]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/datasources"
[data sources]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/datasources"
[Data sources]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/datasources"
[Data sources]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/datasources"
{{% /docs/reference %}}