[DOCS] Updates Watcher docs to match updated UI#40106
Conversation
|
Pinging @elastic/kibana-docs |
KOTungseth
left a comment
There was a problem hiding this comment.
I have 2 very small comments. But other than these, this LGTM.
| ==== Add an action | ||
|
|
||
| Click `Add new action` to trigger a dropdown selection: | ||
| Now that the condition is set, you must define an action. The action triggers |
| [[watcher-getting-started]] | ||
| === View watch history and status | ||
| The Watcher overview page lists all your watches, | ||
| including their state: `Firing`, `Error`, `OK`, or `Disabled`. |
There was a problem hiding this comment.
Maybe not for this PR, but it would be cool if these states were defined. For example, I'm not 100% sure what Firing means.
| == Watcher UI | ||
| == Watcher | ||
|
|
||
| Watcher is an {es} feature that you can use to create actions based on |
There was a problem hiding this comment.
I think in general we're not using "Watcher" as much anymore. If you look on https://www.elastic.co/subscriptions and https://www.elastic.co/products/stack/alerting it's not mentioned there.
I recommend using the alert-features attribute from https://github.com/elastic/docs/blob/master/shared/attributes.asciidoc
For example:
| Watcher is an {es} feature that you can use to create actions based on | |
| The {alert-features} enable you to create actions based on |
There was a problem hiding this comment.
It seems to me that this section only applies when security features are enabled, so it's a good idea to add that qualification. For example:
| To use Watcher, you must have the built-in `kibana_user` role. | |
| If the {es} {security-features} are enabled, to use {alert-features} in {kib}, you must have the built-in `kibana_user` role. |
There was a problem hiding this comment.
| You must also have one of the following Watcher roles: | |
| You must also have one of the following {stack-ov}/built-in-roles.html[built-in roles]: |
There was a problem hiding this comment.
When we're describing security requirements, we often start by saying which privileges they require (e.g. manage_watcher or monitor_watcher cluster privileges per https://www.elastic.co/guide/en/elastic-stack-overview/master/security-privileges.html . Then we mention the built-in roles in case they don't want to add these privileges to their existing roles.
lcawl
left a comment
There was a problem hiding this comment.
I added a comment about terminology but otherwise it builds successfully and LGTM
d55d472 to
797a6ff
Compare
Co-Authored-By: Lisa Cawley <lcawley@elastic.co>
* [DOCS] Updates Watcher docs to match updated UI * [DOCS] Incoporates watcher review comments and adds badge * [DOCS] Updated watcher security doc based on feedback * Update docs/management/watcher-ui/index.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co>
* [DOCS] Updates Watcher docs to match updated UI * [DOCS] Incoporates watcher review comments and adds badge * [DOCS] Updated watcher security doc based on feedback * Update docs/management/watcher-ui/index.asciidoc Co-Authored-By: Lisa Cawley <lcawley@elastic.co>
Summary
This PR updates the Watcher docs to match the revisions in the UI
[skip ci]