Skip to content

[DOCS-13765] Document widget descriptions feature#35811

Merged
evazorro merged 5 commits intomasterfrom
eva/DOCS-13765-widget-descriptions
Apr 8, 2026
Merged

[DOCS-13765] Document widget descriptions feature#35811
evazorro merged 5 commits intomasterfrom
eva/DOCS-13765-widget-descriptions

Conversation

@evazorro
Copy link
Copy Markdown
Contributor

@evazorro evazorro commented Apr 7, 2026

What does this PR do? What is the motivation?

Fixes DOCS-13765

Adds a new "Widget descriptions" section to the widget configuration page documenting the widget descriptions feature, including how to add a description in the graph editor and how to view it on hover.

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

@github-actions github-actions bot added the Images Images are added/removed with this PR label Apr 7, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 7, 2026

Preview links (active after the build_preview check completes)

Modified Files


## Widget descriptions

Widget descriptions let you add a text description to any dashboard widget, including timeseries, geomap, and bar chart widgets. Use descriptions to provide context about a metric, such as what it represents, how to interpret it, or what action to take.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@amymzhou do we want to include these examples of the types of widgets that support descriptions? I pulled this from Alessandro's email

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

don't feel too strongly here - honestly it's pretty much all widgets, so I'm not sure we need to add examples!

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Okey doke, I'll remove it!

@evazorro evazorro marked this pull request as ready for review April 7, 2026 18:40
@evazorro evazorro requested a review from a team as a code owner April 7, 2026 18:40
@evazorro evazorro requested a review from amymzhou April 7, 2026 18:40
@joepeeples joepeeples self-assigned this Apr 7, 2026
Copy link
Copy Markdown
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

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

A couple non-blocking suggestions, thanks!

Copy link
Copy Markdown
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, thank you Eva!

evazorro and others added 3 commits April 8, 2026 11:05
@evazorro evazorro merged commit 28c553e into master Apr 8, 2026
16 checks passed
@evazorro evazorro deleted the eva/DOCS-13765-widget-descriptions branch April 8, 2026 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Images Images are added/removed with this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants