Skip to content

Commit 3a891f7

Browse files
evazorroestherk15
andauthored
Add annotations documentation (#32392)
* Add annotations documentation * Uncomment menu * Remove stray note * Apply suggestions from code review Co-authored-by: Esther Kim <[email protected]> * Fix menu ordering * Fix procedure and add screenshot * Small tweaks --------- Co-authored-by: Esther Kim <[email protected]>
1 parent 063ebc2 commit 3a891f7

File tree

3 files changed

+49
-4
lines changed

3 files changed

+49
-4
lines changed

config/_default/menus/main.en.yaml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1624,26 +1624,31 @@ menu:
16241624
parent: dashboards
16251625
weight: 9
16261626
identifier: dashboards_overlays
1627+
- name: Annotations
1628+
url: dashboards/annotations/
1629+
parent: dashboards
1630+
weight: 10
1631+
identifier: dashboards_annotations
16271632
- name: Sharing
16281633
identifier: dashboards_sharing
16291634
url: dashboards/sharing/
16301635
parent: dashboards
1631-
weight: 10
1636+
weight: 1001
16321637
- name: Shared Dashboards
16331638
identifier: dashboards_sharing_shared_dashboards
16341639
url: dashboards/sharing/shared_dashboards
16351640
parent: dashboards_sharing
1636-
weight: 1001
1641+
weight: 1002
16371642
- name: Share Graphs
16381643
identifier: dashboards_sharing_graphs
16391644
url: dashboards/sharing/graphs
16401645
parent: dashboards_sharing
1641-
weight: 1002
1646+
weight: 1003
16421647
- name: Scheduled Reports
16431648
identifier: dashboards_reporting
16441649
url: dashboards/sharing/scheduled_reports
16451650
parent: dashboards_sharing
1646-
weight: 1003
1651+
weight: 1004
16471652
- name: Guides
16481653
url: dashboards/guide/
16491654
parent: dashboards
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Annotations
3+
description: Learn how to add, customize, and manage annotations on timeseries widgets in dashboards and notebooks to highlight important events.
4+
disable_toc: false
5+
---
6+
7+
## Overview
8+
9+
Annotations let you manually place vertical markers with descriptions on timeseries widgets. Adding annotations can be useful to visually call out key events like deploys, incidents, or spikes. Click any point in time and add a note.
10+
11+
{{< img src="dashboards/annotations.png" alt="Timeseries showing a drop-off in availability with a vertical annotation line at the end of the drop-off and a comment that says 'Rollback completed — service availability restored.'" style="width:100%;" >}}
12+
13+
Annotations are available in both dashboards and notebooks. If you export a widget from a dashboard to a notebook, any annotations you've added to the widget persist.
14+
15+
## Adding an annotation
16+
17+
1. Create an annotation by:
18+
- Left-clicking anywhere on a timeseries widget and selecting **Add annotation** from the context menu that appears, or
19+
- Clicking the x-axis on a timeseries graph
20+
3. Type your comment, and optionally click the timestamp field to manually adjust to the precise time you want to annotate.
21+
4. (Optional) Change the color of the annotation from the dropdown in the bottom left.
22+
5. Click **Save**.
23+
24+
## Adding multiple annotations
25+
26+
To apply an annotation to multiple timeseries at once:
27+
28+
1. Follow steps 1-4 in [Adding an annotation](#adding-an-annotation) to create an annotation.
29+
2. From the **Applying to** dropdown, choose **All widgets** or **Selected widgets**.
30+
<br>
31+
If you choose **Selected widgets**, you see a list of all the widgets in the dashboard or notebook and can check or uncheck the widgets you want to apply the annotation to.
32+
3. Click **Save**.
33+
34+
## Editing an annotation
35+
36+
To edit an annotation, hover over the annotation line, click the three dots menu, and choose **Edit** or **Edit for all widgets**.
37+
38+
## Deleting an annotation
39+
40+
To delete an annotation you've created, hover over the annotation line, click the three dots menu, and choose **Delete** or **Delete from all widgets**.
109 KB
Loading

0 commit comments

Comments
 (0)