Skip to content

Split action types into own page#63516

Merged
mikecote merged 3 commits intoelastic:masterfrom
mikecote:docs/split-action-types
Apr 15, 2020
Merged

Split action types into own page#63516
mikecote merged 3 commits intoelastic:masterfrom
mikecote:docs/split-action-types

Conversation

@mikecote
Copy link
Copy Markdown
Contributor

@mikecote mikecote commented Apr 14, 2020

Fixes #62445

Landing page:
Screen Shot 2020-04-15 at 2 42 25 PM

@mikecote mikecote added Feature:Alerting v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.7.0 Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// v7.8.0 labels Apr 14, 2020
@mikecote mikecote self-assigned this Apr 14, 2020
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@mikecote
Copy link
Copy Markdown
Contributor Author

@gchaps this is what I have as the landing page now for the action and connector types. All the content that was there previously is now moved into their own sub-pages.

One sentence from the previous page is "This section describes how to configure connectors and actions for each type." which I'm not sure what to do with to instruct the reader to select an action type to see how to configure them.

Screen Shot 2020-04-15 at 9 09 03 AM

@mikecote mikecote marked this pull request as ready for review April 15, 2020 16:20
@mikecote mikecote requested a review from gchaps April 15, 2020 16:21
Copy link
Copy Markdown
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

@mikecote The sentence "This section describes how to configure connectors and actions for each type." isn't needed here, so OK to remove. Instead, I suggest starting with a description about what an action is. Maybe something like this (but without the word invocation).

Actions are invocations of Kibana services or integrations with third-party systems, that run as background tasks on the Kibana server when alert conditions are met.

Also, would it be helpful to the user to add a 1-line description about what each action is? Something similar to how its done on this page: https://www.elastic.co/guide/en/kibana/master/devtools-kibana.html

For the action types, I recall a suggestion to add a snapshot to each page.

Copy link
Copy Markdown
Contributor

@pmuellr pmuellr left a comment

Choose a reason for hiding this comment

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

LGTM

mikecote and others added 2 commits April 15, 2020 14:28
Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>
@mikecote
Copy link
Copy Markdown
Contributor Author

Updated landing page based on @gchaps feedback:
Screen Shot 2020-04-15 at 2 42 25 PM

@mikecote mikecote requested a review from gchaps April 15, 2020 18:45
Copy link
Copy Markdown
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

LGTM

@mikecote mikecote merged commit 6c670b7 into elastic:master Apr 15, 2020
mikecote added a commit to mikecote/kibana that referenced this pull request Apr 15, 2020
* Split action types into own page

* Update docs/user/alerting/action-types.asciidoc

Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>

* Apply changes based on feedback

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
mikecote added a commit to mikecote/kibana that referenced this pull request Apr 15, 2020
* Split action types into own page

* Update docs/user/alerting/action-types.asciidoc

Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>

* Apply changes based on feedback

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
mikecote added a commit that referenced this pull request Apr 15, 2020
* Split action types into own page

* Update docs/user/alerting/action-types.asciidoc

Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>

* Apply changes based on feedback

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
mikecote added a commit that referenced this pull request Apr 15, 2020
* Split action types into own page

* Update docs/user/alerting/action-types.asciidoc

Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>

* Apply changes based on feedback

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
gmmorris added a commit to gmmorris/kibana that referenced this pull request Apr 17, 2020
* master: (56 commits)
  [i18n] Update CODEOWNERS (elastic#63354)
  add platform team definition of done (elastic#59993)
  [SIEM] move away from Joi for importing/exporting timeline (elastic#62125)
  Fix discover preserve url (elastic#63580)
  [alerting] Adds an alertServices mock and uses it in siem, monitoring and uptime (elastic#63489)
  Closes elastic#63109 for Service Map by resetting edges styles for the selected node (elastic#63655)
  MIgrated index_header to react (elastic#63490)
  Index pattern management UI -> TypeScript and New Platform Ready (indexed_fields_table) (elastic#63364)
  [SIEM] [Cases] Insert timeline and reporters/tags in table bug fixes (elastic#63642)
  [Reporting] Make usable default element positions (elastic#63191)
  [Reporting] Switch Serverside Config Wrapper to NP (elastic#62500)
  [Reporting] Add "warning" status as an alternate type of completed job (elastic#63498)
  Split action types into own page (elastic#63516)
  [Lens] Only show copy on save for previously saved docs (elastic#63535)
  Update README.md (elastic#63622)
  Bugfix clear saved query crashes kibana on Discover in some cases (elastic#63554)
  Add uptime CODEOWNER entries. (elastic#63616)
  [ML] Extract apiDoc params from the schema definitions (elastic#62933)
  Fix alerting documentation encryption key requirement (elastic#63512)
  Fix CODEOWNERS and sass lint paths (elastic#63552)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// v7.7.0 v7.8.0 v8.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Split out connector documentation into individual sections

4 participants