Add description and documentation link in alert flyout #81526

mikecote · 2020-10-22T18:53:42Z

Part of and resolves #75548.

In this PR, I'm adding a documentationUrl property to alert types. I've added what I believe is the correct url for each. I'm also displaying the link and description in the alert flyout.

This is based on the mockup from #64077 (comment).

Screenshot (see middle)

Note to codeowners

I think I've found all the proper documentation links for each alert type. Please verify that they are accurate.

Note for docs

The screenshots for create / edit flyout will need to be updated because there is now a description and documentation link displayed.

From a technical perspective, the AlertTypeModel in the UI now has a documentationUrl property that can have one of the following values:

null
string
(docLinks: DocLinksStart) => string

elasticmachine · 2020-11-04T17:24:27Z

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

ymao1 · 2020-11-04T20:34:34Z

Looks good! I noticed that in the mockup, there is another horizontal rule at the bottom of the "header" section of the alert type (containing the name, description & doc link). Do we want to add that in this PR? Otherwise, the rules section of the alert type is sometimes very tight against the doc link

Example of tight spacing:

ymao1 · 2020-11-04T20:37:37Z

I think this is unrelated to this PR, but often when I open the flyout and click directly on the doc link, it triggers the form validation, which shows an error for the "Name" field, which makes all the form fields jump down to accommodate, and then I have to click the doc link again to actually open.

mdefazio

Nice catch on the spacing. I think we can also just add this right after the description, instead of forcing it to its own line.

Change EuiText size to small for the description
Move documentation link inside the description with EuiLink

elasticmachine · 2020-11-04T21:15:05Z

Pinging @elastic/apm-ui (Team:apm)

elasticmachine · 2020-11-04T21:15:05Z

Pinging @elastic/uptime (Team:uptime)

x-pack/plugins/uptime/public/lib/alert_types/monitor_status.tsx

sorenlouv

apm docs lgtm

mikecote · 2020-11-05T14:43:22Z

@ymao1 good catch! I added the horizontal ruler and also applied the change @mdefazio proposed.

Regarding the UX when clicking the link, I see exactly what you mean and it happens when the alert type is pre-selected when opening the flyout. I recall there was a reason why we made the name field auto selected to trigger validation when moving away but I would have to dig into some old issues to make sure we don't bring back new issues. Maybe worth a UX issue and we can discuss there? (I'm happy to create the issue)

shahzad31

Uptime changes LGTM !!

x-pack/plugins/monitoring/public/alerts/disk_usage_alert/index.tsx

x-pack/plugins/monitoring/public/alerts/legacy_alert/legacy_alert.tsx

x-pack/plugins/monitoring/public/alerts/memory_usage_alert/index.tsx

...ins/monitoring/public/alerts/missing_monitoring_data_alert/missing_monitoring_data_alert.tsx

chrisronline

LGTM!

phillipb

Infra LGTM

ymao1

LGTM!

ymao1 · 2020-11-05T16:25:42Z

Regarding the UX when clicking the link, I see exactly what you mean and it happens when the alert type is pre-selected when opening the flyout. I recall there was a reason why we made the name field auto selected to trigger validation when moving away but I would have to dig into some old issues to make sure we don't bring back new issues. Maybe worth a UX issue and we can discuss there? (I'm happy to create the issue)

I think it's a minor annoyance and maybe most people won't go straight to clicking on the Documentation link? I would be fine with waiting to see if any user complains :)

mdefazio

LGTM! Thanks for making the edits.

YulNaumenko

LGTM

* Add description and documentation URL in alert flyout * Add unit tests * Fix type check * Add horizontal rule * Design fixes * Fix uptime alert link * Fix uptime urls * Add anchor tag * Fix jest test failures * Fix monitoring links

kibanamachine · 2020-11-09T19:58:41Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 21aac5e

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`monitoring`	965.0KB	966.0KB	+1.0KB
`triggersActionsUi`	1.5MB	1.5MB	+1.1KB
total			+2.1KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`apm`	48.2KB	48.8KB	+584.0B
`infra`	173.2KB	173.7KB	+502.0B
`triggersActionsUi`	132.5KB	132.7KB	+196.0B
`uptime`	24.7KB	25.2KB	+488.0B
total			+1.7KB

Saved Objects .kibana field count

Every field in each saved object type adds overhead to Elasticsearch. Kibana needs to keep the total field count below Elasticsearch's default limit of 1000 fields. Only specify field mappings for the fields you wish to search on or query. See https://www.elastic.co/guide/en/kibana/master/development-plugin-saved-objects.html#_mappings

id	before	after	diff
`_doc_count`	-	1	+1

History

💚 Build #86141 succeeded 21aac5e
💔 Build #86136 failed 9e6b4ec
💚 Build #85811 succeeded 247157e
💔 Build #85801 failed 0099766
💚 Build #83451 succeeded afdff90

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

mikecote 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.11.0 labels Oct 22, 2020

mikecote self-assigned this Oct 22, 2020

mikecote changed the title ~~Improve UX for finding documentation for each alert type~~ Add documentationUrl and link to documentation in alert flyout Oct 28, 2020

mikecote mentioned this pull request Oct 28, 2020

Improve UX for finding documentation for each alert type #75548

Closed

mikecote changed the title ~~Add documentationUrl and link to documentation in alert flyout~~ Add description and documentation link in alert flyout Oct 28, 2020

Add description and documentation URL in alert flyout

0099766

mikecote force-pushed the alerts/type-documentation branch from afdff90 to 0099766 Compare November 4, 2020 13:46

mikecote added 2 commits November 4, 2020 09:27

Add unit tests

9f99be8

Fix type check

247157e

mikecote marked this pull request as ready for review November 4, 2020 17:24

mikecote requested review from a team as code owners November 4, 2020 17:24

mikecote requested a review from a team November 4, 2020 17:24

mikecote requested a review from a team as a code owner November 4, 2020 17:24

mikecote requested a review from mdefazio November 4, 2020 17:26

mdefazio requested changes Nov 4, 2020

View reviewed changes

botelastic bot added Team:APM All issues that need APM UI Team support Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability labels Nov 4, 2020

shahzad31 reviewed Nov 4, 2020

View reviewed changes

x-pack/plugins/uptime/public/lib/alert_types/monitor_status.tsx Outdated Show resolved Hide resolved

sorenlouv approved these changes Nov 5, 2020

View reviewed changes

mikecote added 3 commits November 5, 2020 09:31

Add horizontal rule

7c46b8d

Design fixes

5d7850b

Fix uptime alert link

3e62a8c

mikecote requested review from mdefazio, ymao1 and shahzad31 November 5, 2020 14:43

mikecote added 2 commits November 5, 2020 09:50

Fix uptime urls

192efaf

Add anchor tag

9e6b4ec

shahzad31 approved these changes Nov 5, 2020

View reviewed changes

Fix jest test failures

f42c633

chrisronline suggested changes Nov 5, 2020

View reviewed changes

Fix monitoring links

21aac5e

chrisronline approved these changes Nov 5, 2020

View reviewed changes

phillipb approved these changes Nov 5, 2020

View reviewed changes

ymao1 approved these changes Nov 5, 2020

View reviewed changes

mdefazio approved these changes Nov 5, 2020

View reviewed changes

YulNaumenko approved these changes Nov 5, 2020

View reviewed changes

mikecote merged commit 1ecd12c into elastic:master Nov 6, 2020

mikecote mentioned this pull request Nov 6, 2020

[7.x] Add description and documentation link in alert flyout (#81526) #82795

Merged

mikecote mentioned this pull request Nov 6, 2020

[Maps] Geo containment alert V1 completion tasks #80749

Closed

20 tasks

mikecote added the needs_docs label Nov 9, 2020

mikecote added release_note:enhancement and removed release_note:skip Skip the PR/issue when compiling release notes labels Dec 16, 2020

mikecote mentioned this pull request Feb 22, 2021

Documentation for alert variables/parameters #80953

Closed

mikecote removed the needs_docs label Feb 23, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add description and documentation link in alert flyout #81526

Add description and documentation link in alert flyout #81526

mikecote commented Oct 22, 2020 •

edited

Loading

elasticmachine commented Nov 4, 2020

ymao1 commented Nov 4, 2020

ymao1 commented Nov 4, 2020

mdefazio left a comment

elasticmachine commented Nov 4, 2020

elasticmachine commented Nov 4, 2020

sorenlouv left a comment

mikecote commented Nov 5, 2020 •

edited

Loading

shahzad31 left a comment

chrisronline left a comment

phillipb left a comment

ymao1 left a comment

ymao1 commented Nov 5, 2020

mdefazio left a comment

YulNaumenko left a comment

kibanamachine commented Nov 9, 2020

Add description and documentation link in alert flyout #81526

Add description and documentation link in alert flyout #81526

Conversation

mikecote commented Oct 22, 2020 • edited Loading

Note to codeowners

Note for docs

elasticmachine commented Nov 4, 2020

ymao1 commented Nov 4, 2020

ymao1 commented Nov 4, 2020

mdefazio left a comment

Choose a reason for hiding this comment

elasticmachine commented Nov 4, 2020

elasticmachine commented Nov 4, 2020

sorenlouv left a comment

Choose a reason for hiding this comment

mikecote commented Nov 5, 2020 • edited Loading

shahzad31 left a comment

Choose a reason for hiding this comment

chrisronline left a comment

Choose a reason for hiding this comment

phillipb left a comment

Choose a reason for hiding this comment

ymao1 left a comment

Choose a reason for hiding this comment

ymao1 commented Nov 5, 2020

mdefazio left a comment

Choose a reason for hiding this comment

YulNaumenko left a comment

Choose a reason for hiding this comment

kibanamachine commented Nov 9, 2020

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

Saved Objects .kibana field count

History

mikecote commented Oct 22, 2020 •

edited

Loading

mikecote commented Nov 5, 2020 •

edited

Loading