public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/dashboards/build-dashboards/annotate-visualizations/index.md
+10 -2
View File
@@ -31,7 +31,7 @@ You can annotate visualizations in three ways:
In the first two cases, you're creating new annotations, while in the last you're querying existing annotations from data sources. The built-in annotation query also supports this.
This page explains the first and third options; for information about using the HTTP API, refer to [Annotations API]({{< relref "../../../developers/http_api/annotations/" >}}).
This page explains the first and third options; for information about using the HTTP API, refer to [Annotations API][].
Annotations are supported for the following visualization types:
@@ -113,7 +113,7 @@ To add a new annotation query to a dashboard, take the following steps:
1. Configure the query.
The annotation query options are different for each data source. For information about annotations in a specific data source, refer to the specific [data source]({{< relref "../../../datasources/" >}}) topic.
The annotation query options are different for each data source. For information about annotations in a specific data source, refer to the specific [data source][] topic.
## Built-in query
@@ -163,3 +163,11 @@ When adding or editing an annotation, you can define a repeating time region by
The above configuration will produce the following result in the Time series panel:
{{< figure src="/media/docs/grafana/screenshot-grafana-10-0-timeseries-time-regions.png" max-width="600px" caption="Time series time regions business hours" >}}
{{% docs/reference %}}
[Annotations API]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/developers/http_api/annotations"
[Annotations API]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/developers/http_api/annotations"
[data source]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/datasources"
[data source]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/datasources"
{{% /docs/reference %}}