Added help text where needed on connectors and alert actions UI #69601

YulNaumenko · 2020-06-18T23:27:07Z

elasticmachine · 2020-06-18T23:27:10Z

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

…ns-help-text-links

…ns-help-text-links # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

pmuellr

I like the idea of the links in the connector creation / usage forms for help, but ... some issues.

I think we probably should NOT provide links to other sites other than our own docs, within Kibana. That includes GH READMEs - we shouldn't link to them.

What we probably should do is have a link in every action creation / usage form, that points back into our docs for that action. The forms for creation for Slack and PagerDuty seem to have these links already. I like the styling on them as well (presumably already approved by design) of slightly smaller font size.

We can then add links to non-elastic sites in the asciidoc pages, as needed.

...gers_actions_ui/public/application/components/builtin_action_types/email/email_connector.tsx

...ctions_ui/public/application/components/builtin_action_types/es_index/es_index_connector.tsx

pmuellr

Requested some changes (mainly the email port), but otherwise LGTM, seems to work as intended.

Since there's enough new public text here, probably worth having someone from docs review as well.

docs/user/alerting/action-types/email.asciidoc

docs/user/alerting/action-types/index.asciidoc

…ns-help-text-links # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.

docs/user/alerting/action-types/email.asciidoc

x-pack/plugins/actions/README.md

x-pack/plugins/triggers_actions_ui/README.md

docs/user/alerting/action-types/email.asciidoc

Co-authored-by: gchaps <[email protected]>

kibanamachine · 2020-07-14T01:57:18Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 50e613d

Build metrics

✅ unchanged

History

💚 Build #61190 succeeded 59681ef
💛 Build #61184 was flaky 15c4b37
💚 Build #61164 succeeded 1f4e13e
💛 Build #61139 was flaky 316cc7b
💚 Build #60531 succeeded 3cf6705

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

…tic#69601) * Added help text where needed on connectors and alert actions UI * fixed ui form * Added index action type examples, fixed slack link * Fixed email connector docs and links * Additional cleanup on email * Removed autofocus to avoid twice link click for opening in the new page * Extended documentation for es index action type * Fixed tests * Fixed doc link * fixed due to comments * fixed due to comments * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update x-pack/plugins/actions/README.md Co-authored-by: gchaps <[email protected]> * Update x-pack/plugins/actions/README.md Co-authored-by: gchaps <[email protected]> * Update x-pack/plugins/triggers_actions_ui/README.md Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/index.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/slack.asciidoc Co-authored-by: gchaps <[email protected]> * Fixed due to comments Co-authored-by: gchaps <[email protected]>

* master: (314 commits) [APM] Use status_code field to calculate error rate (elastic#71109) [Observability] Change appLink passing the date range (elastic#71259) [Security] Add Timeline improvements (elastic#71506) adjust vislib bar opacity (elastic#71421) Fix ScopedHistory mock and adapt usages (elastic#71404) [Security Solution] Add hook for reading/writing resolver query params (elastic#70809) [APM] Bug fixes from ML integration testing (elastic#71564) [Discover] Add caused_by.type and caused_by.reason to error toast modal (elastic#70404) [Security Solution] Add 3rd level breadcrumb to admin page (elastic#71275) [Security Solution][Exceptions] Exception modal bulk close alerts that match exception attributes (elastic#71321) Change signal.rule.risk score mapping from keyword to float (elastic#71126) Added help text where needed on connectors and alert actions UI (elastic#69601) [SIEM][Detections] Value Lists Management Modal (elastic#67068) [test] Skips test preventing promotion of ES snapshot elastic#71582 [test] Skips test preventing promotion of ES snapshot elastic#71555 [ILM] Fix alignment of the timing field (elastic#71273) [SIEM][Detection Engine][Lists] Adds the ability for exception lists to be multi-list queried. (elastic#71540) initial telemetry setup (elastic#69330) [Reporting] Formatting fixes for CSV export in Discover, CSV download from Dashboard panel (elastic#67027) Search across spaces (elastic#67644) ...

…t-apps-page-titles * 'master' of github.com:elastic/kibana: (88 commits) [ML] Functional tests - disable DFA creation and cloning tests [APM] Use status_code field to calculate error rate (elastic#71109) [Observability] Change appLink passing the date range (elastic#71259) [Security] Add Timeline improvements (elastic#71506) adjust vislib bar opacity (elastic#71421) Fix ScopedHistory mock and adapt usages (elastic#71404) [Security Solution] Add hook for reading/writing resolver query params (elastic#70809) [APM] Bug fixes from ML integration testing (elastic#71564) [Discover] Add caused_by.type and caused_by.reason to error toast modal (elastic#70404) [Security Solution] Add 3rd level breadcrumb to admin page (elastic#71275) [Security Solution][Exceptions] Exception modal bulk close alerts that match exception attributes (elastic#71321) Change signal.rule.risk score mapping from keyword to float (elastic#71126) Added help text where needed on connectors and alert actions UI (elastic#69601) [SIEM][Detections] Value Lists Management Modal (elastic#67068) [test] Skips test preventing promotion of ES snapshot elastic#71582 [test] Skips test preventing promotion of ES snapshot elastic#71555 [ILM] Fix alignment of the timing field (elastic#71273) [SIEM][Detection Engine][Lists] Adds the ability for exception lists to be multi-list queried. (elastic#71540) initial telemetry setup (elastic#69330) [Reporting] Formatting fixes for CSV export in Discover, CSV download from Dashboard panel (elastic#67027) ... # Conflicts: # x-pack/plugins/index_management/public/application/index.tsx

* master: (72 commits) [test] Skips test preventing promotion of ES snapshot elastic#71612 [Logs UI] Remove UUID from Alert Instances (elastic#71340) [Metrics UI] Remove UUID from Alert Instance IDs (elastic#71335) [ML] Functional tests - disable DFA creation and cloning tests [APM] Use status_code field to calculate error rate (elastic#71109) [Observability] Change appLink passing the date range (elastic#71259) [Security] Add Timeline improvements (elastic#71506) adjust vislib bar opacity (elastic#71421) Fix ScopedHistory mock and adapt usages (elastic#71404) [Security Solution] Add hook for reading/writing resolver query params (elastic#70809) [APM] Bug fixes from ML integration testing (elastic#71564) [Discover] Add caused_by.type and caused_by.reason to error toast modal (elastic#70404) [Security Solution] Add 3rd level breadcrumb to admin page (elastic#71275) [Security Solution][Exceptions] Exception modal bulk close alerts that match exception attributes (elastic#71321) Change signal.rule.risk score mapping from keyword to float (elastic#71126) Added help text where needed on connectors and alert actions UI (elastic#69601) [SIEM][Detections] Value Lists Management Modal (elastic#67068) [test] Skips test preventing promotion of ES snapshot elastic#71582 [test] Skips test preventing promotion of ES snapshot elastic#71555 [ILM] Fix alignment of the timing field (elastic#71273) ...

…) (#71586) * Added help text where needed on connectors and alert actions UI * fixed ui form * Added index action type examples, fixed slack link * Fixed email connector docs and links * Additional cleanup on email * Removed autofocus to avoid twice link click for opening in the new page * Extended documentation for es index action type * Fixed tests * Fixed doc link * fixed due to comments * fixed due to comments * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update x-pack/plugins/actions/README.md Co-authored-by: gchaps <[email protected]> * Update x-pack/plugins/actions/README.md Co-authored-by: gchaps <[email protected]> * Update x-pack/plugins/triggers_actions_ui/README.md Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/email.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/index.asciidoc Co-authored-by: gchaps <[email protected]> * Update docs/user/alerting/action-types/slack.asciidoc Co-authored-by: gchaps <[email protected]> * Fixed due to comments Co-authored-by: gchaps <[email protected]> Co-authored-by: gchaps <[email protected]>

Added help text where needed on connectors and alert actions UI

710c890

YulNaumenko added Feature:Alerting v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.9.0 labels Jun 18, 2020

YulNaumenko requested a review from a team as a code owner June 18, 2020 23:27

YulNaumenko self-assigned this Jun 18, 2020

YulNaumenko added 6 commits June 22, 2020 09:53

Merge remote-tracking branch 'upstream/master' into alerting-ui-actio…

520d9db

…ns-help-text-links

fixed ui form

f709dda

Merge upstream

3742a8e

Added index action type examples, fixed slack link

7874318

YulNaumenko linked an issue Jun 27, 2020 that may be closed by this pull request

Plz provide an example on how to use Index connector in alerting #65347

Closed

pmuellr requested changes Jul 2, 2020

View reviewed changes

YulNaumenko added 5 commits July 8, 2020 15:56

Merge master

3555e71

Fixed email connector docs and links

d38ae8c

Additional cleanup on email

b7197c2

Removed autofocus to avoid twice link click for opening in the new page

54a9371

Extended documentation for es index action type

78c3683

YulNaumenko requested a review from pmuellr July 9, 2020 21:56

YulNaumenko added 2 commits July 9, 2020 15:59

Fixed tests

76b129f

Fixed doc link

3cf6705

pmuellr approved these changes Jul 13, 2020

View reviewed changes

YulNaumenko added 3 commits July 13, 2020 15:02

fixed due to comments

316cc7b

fixed due to comments

1f4e13e

gchaps reviewed Jul 13, 2020

View reviewed changes

YulNaumenko and others added 17 commits July 13, 2020 16:25

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

7f11a48

Co-authored-by: gchaps <[email protected]>

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

b0a28f5

Co-authored-by: gchaps <[email protected]>

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

ce97972

Co-authored-by: gchaps <[email protected]>

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

4d8fa7d

Co-authored-by: gchaps <[email protected]>

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

12a0364

Co-authored-by: gchaps <[email protected]>

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

817a476

Co-authored-by: gchaps <[email protected]>

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

0ae05ae

Co-authored-by: gchaps <[email protected]>

Update x-pack/plugins/actions/README.md

39f15d1

Co-authored-by: gchaps <[email protected]>

Update x-pack/plugins/actions/README.md

0ac7dc1

Co-authored-by: gchaps <[email protected]>

Update x-pack/plugins/triggers_actions_ui/README.md

15c4b37

Co-authored-by: gchaps <[email protected]>

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

c87ea4e

Co-authored-by: gchaps <[email protected]>

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

4a1feb3

Co-authored-by: gchaps <[email protected]>

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

3c2dd52

Co-authored-by: gchaps <[email protected]>

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

3191843

Co-authored-by: gchaps <[email protected]>

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

bed176e

Co-authored-by: gchaps <[email protected]>

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

59681ef

Co-authored-by: gchaps <[email protected]>

Fixed due to comments

50e613d

YulNaumenko merged commit 2009447 into elastic:master Jul 14, 2020

YulNaumenko mentioned this pull request Jul 14, 2020

[7.x] Added help text where needed on connectors and alert actions UI (#69601) #71586

Merged

pmuellr mentioned this pull request Feb 1, 2021

Documentation for Alerting Email Action Could Use Updating #88333

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added help text where needed on connectors and alert actions UI #69601

Added help text where needed on connectors and alert actions UI #69601

YulNaumenko commented Jun 18, 2020

elasticmachine commented Jun 18, 2020

pmuellr left a comment

pmuellr left a comment

kibanamachine commented Jul 14, 2020

Added help text where needed on connectors and alert actions UI #69601

Added help text where needed on connectors and alert actions UI #69601

Conversation

YulNaumenko commented Jun 18, 2020

elasticmachine commented Jun 18, 2020

pmuellr left a comment

Choose a reason for hiding this comment

pmuellr left a comment

Choose a reason for hiding this comment

kibanamachine commented Jul 14, 2020

💚 Build Succeeded

Build metrics

History