IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-14 01:23:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Fix typo and clarify need for query editor (#27796)

Browse Source 
* Fix typo and clarify need for query editor

* Update docs/sources/developers/plugins/add-support-for-annotations.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
This commit is contained in:
Marcus Olsson 2020-09-29 17:26:01 +02:00 committed by GitHub
parent a9afb750d9
commit 03f059b7c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -15,7 +15,7 @@ Handling annotation queries is similar to how you'd handle a metrics query. The
## Add annotations support to your data source
To add logs support to an existing data source, you need to:
To add support for annotations to an existing data source, you need to:
- Enable annotations support
- Override the `annotationQuery` method
@ -81,9 +81,9 @@ const regionEvent: AnnotationEvent = {
## Build a annotation query editor
Let users write custom annotation queries to only display the annotation events they care about, by adding a _query editor_.
Let users write custom annotation queries to only display the annotation events they care about, by adding a _query editor_. You only need to build a query editor if you want to let users query or filter annotations.
> **Note**: Annotation query editors have yet to receive support for React. The instructions here are given for Angular. Fortunately, you can run Angular even in a plugin otherwise written using React. This section will be updated once React support for annotation queries editors is available.
> **Note:** Annotation query editors have yet to receive support for React. The instructions here are given for Angular. Fortunately, you can run Angular even in a plugin otherwise written using React. This section will be updated once React support for annotation queries editors is available.
1. Create a file called `AnnotationQueryEditor.ts` in the `src` directory, with the following content.