-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[Alerting] Add popover for Elasticsearch query rule type #135968
Conversation
Pinging @elastic/response-ops (Team:ResponseOps) |
.../stack_alerts/public/alert_types/es_query/rule_common_expressions/threshold_help_popover.tsx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a nice start. Here are a few comments.
Placement
Can this pop-up cover just the greyed out background and not the Create rule form? It would nice to see the rest of the form for context.
We should look at other help pop-ups and use the same width.
Formatting
-
Larger font size for title
-
Re: the steps, @KOTungseth reminded me that when we first started implementing in-product assistance, we talked about leaving step-by-step content in the product docs, and reference content in the product. So maybe this (with or without the bullets):
-
The threshold value is a comparison operator, for exampel, IS ABOVE 1000. ...
-
The time is how far back in time to search. To avoid gaps...
Text
Overall, I think we can cut down the text a bit.
A few thoughts: I think we'll at least want to put a max-width on the popover panel to account for wide screens... What if we use a tour component instead? It has a maxW prop and we can also break apart the steps based on the input (the multi doc callout might prove tricky though). I'm wondering if this helps us a) avoid taking over the screen and b) is readable in the context of the input (depending on the screen size and how far I've scrolled when I click the help, it may hide the inputs). Here's a rough breakdown of what I was imagining. Granted, I think this does beg the question of whether this should go through the whole form... |
.../stack_alerts/public/alert_types/es_query/rule_common_expressions/threshold_help_popover.tsx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just have the one comment on the width of the popover.
I think we can explore some other options on incorporating this copy within the form. But this certainly is an improvement.
.../stack_alerts/public/alert_types/es_query/rule_common_expressions/threshold_help_popover.tsx
Outdated
Show resolved
Hide resolved
…ommon_expressions/threshold_help_popover.tsx
…ommon_expressions/threshold_help_popover.tsx Co-authored-by: Ying Mao <ying.mao@elastic.co>
I didn't see how to make that happen, but I did change the anchor position so it's less likely to cover the pertinent fields.
I was unable to force the popover title and the callout title to match, so I've removed the callout title.
Sure, I've changed it back to paragraphs.
I've reduced the callout to a single line. I think we could likely also drop the "For example..." phrase, but if you see other areas to cut, let me know! |
.../stack_alerts/public/alert_types/es_query/rule_common_expressions/threshold_help_popover.tsx
Outdated
Show resolved
Hide resolved
…ommon_expressions/threshold_help_popover.tsx
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Looking good. I think we should be more direct in the second paragraph:
Hopefully, the pop-up doesn't cover the "Check every" field. I like the blue box at the bottom and without the title. Is there a way we can indicate this is a note? Maybe an icon and the word note:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Thanks! I made that change in c6592f6
Unfortunately the "check every" field is right near the top of that UI so folks have likely scrolled too far to see it anymore. Hopefully it's still fresh in their memory.
Since it's a single sentence in that callout now, I was able to get the icon to re-appear (it disappeared when I removed the title) by turning the sentence into the title: 1718236. I've refreshed the initial screenshot with the result. |
💚 Build Succeeded
Metrics [docs]Module Count
Async chunks
History
To update your PR or re-run it, just comment with: |
Summary
Relates to #134763
That PR included edits to the UI text for the Elasticsearch query rule type and removed a tooltip associated with the query threshold fields.
This PR:
Screenshots
Checklist
Delete any items that are not applicable to this PR.
For maintainers