IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Reorganize reference topics (#25915)

Browse Source 
* moved annotations.md

* Update annotations.md

* moved dashboard_folders.md

* moved dashboard_history.md

* moved playlist.md

* moved search.md
This commit is contained in:
Diana Payton
2020-06-30 14:18:38 -07:00
committed by GitHub
parent d4239e6fd2
commit e07d0ae452
19 changed files with 27 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/sources/developers/plugins/add-support-for-annotations.md
View File

@@ -5,11 +5,11 @@ type = "docs"
# Add support for annotations
This guide explains how to add support for [annotations]({{< relref "../../reference/annotations.md" >}}) to an existing data source plugin.
This guide explains how to add support for [annotations]({{< relref "../../dashboards/annotations.md" >}}) to an existing data source plugin.
This guide assumes that you're already familiar with how to [Build a data source plugin]({{< relref "../../../../../tutorials/build-a-data-source-plugin.md" >}}).
Data sources in Grafana can support [Annotations]({{< relref "../../reference/annotations.md" >}}) by handling _annotation queries_.
Data sources in Grafana can support [Annotations]({{< relref "../../dashboards/annotations.md" >}}) by handling _annotation queries_.
Handling annotation queries is similar to how you'd handle a metrics query. The difference is that instead of returning [data frames]({{< relref "data-frames.md" >}}), an annotation query returns _annotation events_.
@@ -65,7 +65,7 @@ async annotationQuery(options: AnnotationQueryRequest<MyQuery>): Promise<Annotat
## Region annotations
[Region annotations]({{< relref "../../reference/annotations.md#adding-regions-events" >}}) have a start and end time. This can for example be used to annotate maintenance windows or downtime.
[Region annotations]({{< relref "../../dashboards/annotations.md#adding-regions-events" >}}) have a start and end time. This can for example be used to annotate maintenance windows or downtime.
To return a region annotation, set the `timeEnd`, and `isRegion` properties.