-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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
Improve UX for finding documentation for each alert type #75548
Comments
Pinging @elastic/kibana-alerting-services (Team:Alerting Services) |
cc @gchaps, in case you have alternate proposals |
@mikecote It would be nice to get the information to the user as close as possible to the point of use. Can we include a link in the UI that opens a flyout with the information? |
@gchaps That would be a good idea. Would the expectation be to open a tab to the documentation website or to copy a snippet of that documentation in a flyout right within Kibana? |
My preference would be to include a snippet of the documentation in the flyout on the right. |
To require alert types to provide documentation, we can add a required link template string property as part of the alert type, so you couldn't register an alert without doc. Perhaps that would be good for actions as well. |
A couple of notes from an offline discussion I had with @gchaps, @mdefazio and @bmcconaghy:
* question mark ( |
The documentation for alert types states that
For domain-specific alert types, refer to the documentation for that app.
but users are still having a hard time finding the documentation related to the alert type presented in the management creation UI.There may be a few causes for this:
and others.
The text was updated successfully, but these errors were encountered: