Skip to content

Add bar chart widget file #30739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 1, 2025
Merged

Conversation

estherk15
Copy link
Contributor

@estherk15 estherk15 commented Jul 28, 2025

What does this PR do? What is the motivation?

Merge instructions

Merge readiness:
Pending PM review

Add bar chart widget

Add relative links to bar chart widget
@estherk15 estherk15 requested a review from a team as a code owner July 28, 2025 15:22
@github-actions github-actions bot added the Images Images are added/removed with this PR label Jul 28, 2025
Copy link
Contributor

github-actions bot commented Jul 28, 2025

✅ Documentation Team Review

The documentation team has approved this pull request. Thank you for your contribution!

@iadjivon
Copy link
Contributor

Created an editorial review card: DOCS-11652

@iadjivon iadjivon added the editorial review Waiting on a more in-depth review label Jul 28, 2025
@jess-sylvester
Copy link

quick question: is there reasoning behind excluding the API section? it seems like most other widgets have one, with the model and example (ref from toplist). it would be nice if it were included directly on the page so users can have an idea of what the schema looks like.

Copy link
Contributor

@janine-c janine-c left a comment

Choose a reason for hiding this comment

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

Looks great, Esther! I made some comments about some steps that I'm sure make sense in context or with more experience, but that I worried might leave a newer user feeling a bit lost. Nothing that isn't already in other related pages, though, so I'm approving it if the level of detail was a conscious decision 🙂


### Configuration

1. Select from the available data sources.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe this makes more sense in the context of creating dashboards (I can see that this isn't the only page it's on), but this had me confused about what the user is supposed to select or where. Usually we orient the user on where they're supposed to be in the app and something along the lines of adding the widget to the dashboard before getting into the configuration settings. Is there a reason we skip over that here? Even if there is, can we add some more context?

* Metrics: See the [querying ][1] documentation to configure a metric query.
* Events: See the [log search][2] documentation to configure a log event query.
3. (Optional) Modify query with a [formula][3].
4. Customize your graph.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure what this means or how you would do it...does this mean the graph title? Or the time span maybe? And then I imagine you probably have to click Save or something?

Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com>
@estherk15
Copy link
Contributor Author

Thanks so much for your feedback @janine-c! I created a tasker to reevaluate the setup for Widgets and update the docs en masse. These could use an audit!

@estherk15 estherk15 merged commit 7769a8e into master Aug 1, 2025
16 checks passed
@estherk15 estherk15 deleted the esther/docs-11468-bar-chart-widget branch August 1, 2025 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial review Waiting on a more in-depth review Images Images are added/removed with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants