[Alerting] Update UI to reflect new terminology #93597

ymao1 · 2021-03-04T13:45:05Z

Resolves #92166

Summary

Renamed Alerts -> Rules and Actions -> Connectors in UI
Renamed routes from /alerts and /alert/{alertId} to /rules and /rule/{ruleId} and added redirect to make sure old URLs redirect to new URLs
Updated docs to reflect new terminology and updated screenshots in docs to show updated UI.

Updated docs (these are the entry points to all the updated doc pages)

https://kibana_93597.docs-preview.app.elstc.co/guide/en/kibana/master/managing-alerts-and-actions.html
https://kibana_93597.docs-preview.app.elstc.co/guide/en/kibana/master/alerting-getting-started.html

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios

…ing/rename-ui

elasticmachine · 2021-03-09T17:01:21Z

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

ymao1 · 2021-03-09T19:20:18Z

jenkins retest this please

…ing/rename-ui

darnautov

ML changes LGTM

x-pack/test/functional/services/ml/navigation.ts

gmmorris · 2021-03-10T11:07:23Z

docs/management/alerting/rule-management.asciidoc

@@ -0,0 +1,58 @@
+[role="xpack"]
+[[alert-management]]
+=== Managing Rules


Should we be referring to these as "Alerting Rules" here? 🤔

I'm not 100% sure when we should use the whole term rather than just "Rules"...

Since this is under the Rules and Connectors page and there's a sibling page called Managing Connectors, I think Managing Rules is ok here? I'll let @gchaps be the final judge :)

gmmorris · 2021-03-10T11:30:43Z

Should this dropdown be relabeled?
I'm actually ok with it staying "action" here, as it is the action that's attached to the rule, rather than the connector, but it can be confusing how we use both "Connector Type" and "Action Type" interchangeably 🤔

Not sure... so just floating the question.

gmmorris · 2021-03-10T11:50:36Z

The Alerting Example app still uses the legacy terminology.
Should we take this opportunity to update it as well?

I know I'm moving the goal posts here as I forgot about it 😆 sorry about that.

gmmorris

I've looked through the docs and UI, and it all looks spot on :)

Asked a couple of questions, but broadly, looks like all bases have been covered 😄

ymao1 · 2021-03-10T12:53:26Z

Should this dropdown be relabeled?

I debated this as well and kept it for the same reason you mentioned: it is specifically referencing the action in the context of a rule.

…ing/rename-ui

ymao1 · 2021-03-10T13:23:30Z

The Alerting Example app still uses the legacy terminology.
Should we take this opportunity to update it as well?

Updated!

YulNaumenko

LGTM

ymao1 · 2021-03-15T11:53:08Z

@elasticmachine merge upstream

kibanamachine · 2021-03-15T13:53:37Z

💚 Build Succeeded

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
`triggersActionsUi`	1.5MB	1.5MB	+1.8KB

Page load bundle

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

id	before	after	diff
`triggersActionsUi`	104.2KB	104.3KB	+171.0B

History

💛 Build #112452 was flaky 73f2c4c
💔 Build #111894 failed 4f976b7
💚 Build #111870 succeeded c5255de
💚 Build #111508 succeeded 2af1eb8
💔 Build #111381 failed 92e6def

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

cc @ymao1

ymao1 · 2021-03-15T14:03:26Z

@gchaps I am merging this PR because it contains a lot of changed files and I want to avoid too many conflicts. I will address any docs feedback you have separately.

* Renaming alerts to rules * Updating formatted messages * Updating i18n labels * Completed renaming in UI * Updating client routes including redirect * wip docs update * Reverting title changes for now * Fixing types check * Fixing unit tests * Fixing functional test * Fixing functional test * docs wip * wip docs update * Finished first run through docs * docs docs docs * Fixing bad merge * Fixing functional test * Docs cleanup * Cleaning up i18n labels * Fixing functional test * Updating screenshots * Updating screenshots * Updating screenshots * Updating terminology in alerting examples * Updating terminology in alerting examples Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2021-03-15T14:07:09Z

💚 Backport successful

✅ 7.x / #94572

Successful backport PRs will be merged automatically after passing CI.

* Renaming alerts to rules * Updating formatted messages * Updating i18n labels * Completed renaming in UI * Updating client routes including redirect * wip docs update * Reverting title changes for now * Fixing types check * Fixing unit tests * Fixing functional test * Fixing functional test * docs wip * wip docs update * Finished first run through docs * docs docs docs * Fixing bad merge * Fixing functional test * Docs cleanup * Cleaning up i18n labels * Fixing functional test * Updating screenshots * Updating screenshots * Updating screenshots * Updating terminology in alerting examples * Updating terminology in alerting examples Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: ymao1 <ying.mao@elastic.co>

ymao1 added 30 commits March 2, 2021 14:34

Renaming alerts to rules

ab63e5f

Merge branch 'master' of https://github.com/elastic/kibana into alert…

13331bf

…ing/rename-ui

Updating formatted messages

200c2df

Updating i18n labels

b3992b8

Completed renaming in UI

0bbde1a

Updating client routes including redirect

bad4432

Merge branch 'master' of https://github.com/elastic/kibana into alert…

551c00d

…ing/rename-ui

wip docs update

d007cad

Reverting title changes for now

48e3b1e

Fixing types check

02493a4

Fixing unit tests

4ee19eb

Fixing functional test

f403960

Fixing functional test

c7bcede

docs wip

5967eb6

Merging in master

4c64785

wip docs update

04b020e

Finished first run through docs

1f989fd

docs docs docs

1272436

Fixing bad merge

cdc58ff

Merging in master

c59e12a

Fixing functional test

e18b02e

Docs cleanup

d1ec60a

Cleaning up i18n labels

92e6def

Merge branch 'master' of https://github.com/elastic/kibana into alert…

b6914c8

…ing/rename-ui

Fixing functional test

2af1eb8

Merging in master

c5255de

Updating screenshots

4f976b7

Updating screenshots

ac977cb

Updating screenshots

0a525a8

Merge branch 'master' of https://github.com/elastic/kibana into alert…

d7c6c91

…ing/rename-ui

ymao1 requested a review from a team as a code owner March 9, 2021 17:01

Merge branch 'master' of https://github.com/elastic/kibana into alert…

7c407bd

…ing/rename-ui

darnautov approved these changes Mar 10, 2021

View reviewed changes

x-pack/test/functional/services/ml/navigation.ts Show resolved Hide resolved

gmmorris self-requested a review March 10, 2021 11:05

gmmorris reviewed Mar 10, 2021

View reviewed changes

gmmorris approved these changes Mar 10, 2021

View reviewed changes

ymao1 added 3 commits March 10, 2021 07:53

Merge branch 'master' of https://github.com/elastic/kibana into alert…

222bed4

…ing/rename-ui

Updating terminology in alerting examples

28fc765

Updating terminology in alerting examples

73f2c4c

YulNaumenko approved these changes Mar 10, 2021

View reviewed changes

Merge branch 'master' into alerting/rename-ui

ebe293c

ymao1 added the auto-backport Deprecated: Automatically backport this PR after it's merged label Mar 15, 2021

ymao1 merged commit a7c9d3f into elastic:master Mar 15, 2021

kibanamachine mentioned this pull request Mar 15, 2021

[7.x] [Alerting] Update UI to reflect new terminology (#93597) #94572

Merged

bmorelli25 mentioned this pull request Mar 16, 2021

Update alerting docs to reflect new terminology elastic/observability-docs#443

Closed

2 tasks

ymao1 mentioned this pull request Mar 17, 2021

remove legacy doc links file #94274

Merged

ymao1 deleted the alerting/rename-ui branch March 25, 2021 14:41

lcawl mentioned this pull request Jun 9, 2021

Add shared attribute for Rules and Connectors elastic/docs#2133

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Alerting] Update UI to reflect new terminology #93597

[Alerting] Update UI to reflect new terminology #93597

ymao1 commented Mar 4, 2021 •

edited

Loading

elasticmachine commented Mar 9, 2021

ymao1 commented Mar 9, 2021

darnautov left a comment

gmmorris Mar 10, 2021

ymao1 Mar 10, 2021

gmmorris commented Mar 10, 2021

gmmorris commented Mar 10, 2021 •

edited

Loading

gmmorris left a comment

ymao1 commented Mar 10, 2021

ymao1 commented Mar 10, 2021

YulNaumenko left a comment

ymao1 commented Mar 15, 2021

kibanamachine commented Mar 15, 2021

ymao1 commented Mar 15, 2021

kibanamachine commented Mar 15, 2021

[Alerting] Update UI to reflect new terminology #93597

[Alerting] Update UI to reflect new terminology #93597

Conversation

ymao1 commented Mar 4, 2021 • edited Loading

Summary

Updated docs (these are the entry points to all the updated doc pages)

Checklist

elasticmachine commented Mar 9, 2021

ymao1 commented Mar 9, 2021

darnautov left a comment

Choose a reason for hiding this comment

gmmorris Mar 10, 2021

Choose a reason for hiding this comment

ymao1 Mar 10, 2021

Choose a reason for hiding this comment

gmmorris commented Mar 10, 2021

gmmorris commented Mar 10, 2021 • edited Loading

gmmorris left a comment

Choose a reason for hiding this comment

ymao1 commented Mar 10, 2021

ymao1 commented Mar 10, 2021

YulNaumenko left a comment

Choose a reason for hiding this comment

ymao1 commented Mar 15, 2021

kibanamachine commented Mar 15, 2021

💚 Build Succeeded

Metrics [docs]

Async chunks

Page load bundle

History

ymao1 commented Mar 15, 2021

kibanamachine commented Mar 15, 2021

💚 Backport successful

ymao1 commented Mar 4, 2021 •

edited

Loading

gmmorris commented Mar 10, 2021 •

edited

Loading