Skip to content

Conversation

@evazorro
Copy link
Contributor

@evazorro evazorro commented Oct 24, 2025

What does this PR do? What is the motivation?

Adds a guide to the new annotations feature for timeseries widgets, including creation, bulk creation, editing, and deletion.

Merge instructions

I'd like to add a screenshot before merge (see comment inline) done

Merge readiness:

  • Ready for merge

Additional notes

@evazorro evazorro requested a review from a team as a code owner October 24, 2025 18:18
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Oct 24, 2025

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.

<!-- screenshot -->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to add a screenshot -- @amymzhou, what would be a few good example metrics to show?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a Org 2 link you can use! https://app.datadoghq.com/notebook/12907421/annotations-demo

The data is "real", but the chart title and annotation text is fake, so it's ok to show on our public docs site

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's currently in a notebook, but you can copy it to a dashboard too if you prefer a screenshot of a dashboard widget

@github-actions
Copy link
Contributor

Preview links (active after the build_preview check completes)

New or renamed files


To apply an annotation to multiple timeseries at once:

1. Select the widgets you want to apply the annotation to (or leave everything unselected to apply to all widgets).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@evazorro I feel like Step 1 is misleading, since people would create an annotation (Steps 1-4 in adding an annotation), then use the dropdown to select if they want to add it to more than one widget. Because of that, I feel like we can remove Step 1 "Select the widgets you want to..." altogether.

But maybe we can expand a bit more on Step 3 "Choose All widgets or selected widgets"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely happy to remove that step! I was trying to account for the "apply to selected widgets" case assuming that you'd need to select the widgets ahead of time. But now that I'm trying it again, I see that you can check/uncheck widgets in the list after choosing that option. I'll revise!

@github-actions github-actions bot added the Images Images are added/removed with this PR label Oct 27, 2025
@evazorro evazorro requested a review from amymzhou October 27, 2025 20:25
Copy link
Contributor

@amymzhou amymzhou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@evazorro evazorro merged commit 3a891f7 into master Oct 27, 2025
23 checks passed
@evazorro evazorro deleted the eva/DOCS-12263 branch October 27, 2025 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend Images Images are added/removed with this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants