[Upgrade Assistant] Update UX for 7.17 #119798

sabarasaba · 2021-11-29T08:20:35Z

Fixes #119738

Summary

Given that we'll have another minor update before the next major, we need to tweak the UX of Upgrade Assistant to give the right message to our users. In order to achieve that, there is a few changes we'll have to do to the copy of the page to make it clearer that this is a preparation for the next major version:

Change the copy in the header, step 3(Review deprecated settings) and step 4(get ready for upgrade)
Change the copy in ES deprecation issue/logs and kibana deprecations
Change the URL link for "What's new in 8.x" (which now points to what's new in 7.16)

Also, a few UI elements were hidden from the UI:

Remove step 2(upgrade system indices) from the wizard
Remove both CTA (Cloud and on prem) in Step 4(get ready for upgrade)

About system indices migration

Initially the Upgrade Assistant in 7.16 was designed specifically for upgrading to the next major. But with the addition of the 7.17 release, we decided to only leave the necessary tools to the user to assist him with the upcoming minor upgrade. We then ended up removing the system indices migration from the UI since it was designed to assist users into major upgrades and not minors in an effort to align it more with some of the thoughts explained with #117220.

With these changes we expect users to upgrade to 7.17 before actually migrating to the next major, as we always guide them to do. Note that I removed the entry point for system indices management from the code and skipped the tests, the code wont get into the bundle since its not required anywhere.

Screenshots

Overview of changes

elasticmachine · 2021-11-29T10:52:51Z

Pinging @elastic/kibana-stack-management (Team:Stack Management)

sebelga

LGTM! I tested locally and works as expected.
I left a few note around using "to prepare for the upgrade" (which is the terminology our docs use).

src/core/public/doc_links/doc_links_service.ts

...upgrade_assistant/__jest__/client_integration/overview/migrate_system_indices/flyout.test.ts

.../upgrade_assistant/public/application/components/es_deprecation_logs/es_deprecation_logs.tsx

sebelga · 2021-11-29T10:42:45Z

...lic/application/components/es_deprecation_logs/fix_deprecation_logs/fix_deprecation_logs.tsx

@@ -38,7 +38,7 @@ const i18nTexts = {
 apiCompatibilityNoteBody: (docLink: string) => (
 <FormattedMessage
 id="xpack.upgradeAssistant.overview.apiCompatibilityNoteBody"
- defaultMessage="We recommend you resolve all deprecation issues before upgrading. If needed, you can apply API compatibility headers to requests that use deprecated features. {learnMoreLink}."
+ defaultMessage="You can start resolving deprecation issues before upgrading to the next major version of Elastic. If needed, you can apply API compatibility headers to requests that use deprecated features. {learnMoreLink}."


What do you think of:

"You can start resolving deprecation issues to prepare the upgrade to the next major..."

I think we should leave this largely as is and just append "to the next major version of Elastic." We're trying to present the API compatibility headers as a less preferred safety mechanism. It doesn't really work without "We recommend..."

Suggested change

defaultMessage="You can start resolving deprecation issues before upgrading to the next major version of Elastic. If needed, you can apply API compatibility headers to requests that use deprecated features. {learnMoreLink}."

defaultMessage="We recommend you resolve all deprecation issues before upgrading to the next major version of Elastic. If needed, you can apply API compatibility headers to requests that use deprecated features. {learnMoreLink}."

.../plugins/upgrade_assistant/public/application/components/es_deprecations/es_deprecations.tsx

sebelga · 2021-11-29T11:22:07Z

.../upgrade_assistant/public/application/components/kibana_deprecations/kibana_deprecations.tsx

@@ -30,7 +30,8 @@ const i18nTexts = {
 defaultMessage: 'Kibana deprecation issues',
 }),
 pageDescription: i18n.translate('xpack.upgradeAssistant.kibanaDeprecations.pageDescription', {
- defaultMessage: 'Resolve all critical issues before upgrading.',
+ defaultMessage:
+ 'Resolve all critical issues before upgrading to the next major version of Elastic.',


Again, but let's see what @debadair thinks, I'd put "to prepare the upgrade to"

I don't think "to prepare" is necessary. I think it's understood that you're preparing to upgrade.

...upgrade_assistant/public/application/components/overview/fix_issues_step/fix_issues_step.tsx

...ugins/upgrade_assistant/public/application/components/overview/upgrade_step/upgrade_step.tsx

sabarasaba · 2021-11-29T13:49:25Z

Thanks for having a look @sebelga! I've addressed your feedback about the tests and docs link. I'll defer on the copy changes to the docs team 🚀

sabarasaba · 2021-11-29T13:50:04Z

@elasticmachine merge upstream

jrodewig

Thanks for making these changes @sabarasaba. I noted some grammatical issues with a few bits of the copy. I also don't think we should go overboard with "to prepare," etc. here as long as it's clear that the steps are related to a major version upgrade.

My only large piece of feedback is related to step 3. I think we should update this step to advise users to come back to the page when they're ready to upgrade to 8.x. The current wording is kind of circular.

src/core/public/doc_links/doc_links_service.ts

.../upgrade_assistant/public/application/components/es_deprecation_logs/es_deprecation_logs.tsx

jrodewig · 2021-11-29T15:12:53Z

...lic/application/components/es_deprecation_logs/fix_deprecation_logs/fix_deprecation_logs.tsx

@@ -38,7 +38,7 @@ const i18nTexts = {
 apiCompatibilityNoteBody: (docLink: string) => (
 <FormattedMessage
 id="xpack.upgradeAssistant.overview.apiCompatibilityNoteBody"
- defaultMessage="We recommend you resolve all deprecation issues before upgrading. If needed, you can apply API compatibility headers to requests that use deprecated features. {learnMoreLink}."
+ defaultMessage="You can start resolving deprecation issues before upgrading to the next major version of Elastic. If needed, you can apply API compatibility headers to requests that use deprecated features. {learnMoreLink}."


I think we should leave this largely as is and just append "to the next major version of Elastic." We're trying to present the API compatibility headers as a less preferred safety mechanism. It doesn't really work without "We recommend..."

Suggested change

defaultMessage="You can start resolving deprecation issues before upgrading to the next major version of Elastic. If needed, you can apply API compatibility headers to requests that use deprecated features. {learnMoreLink}."

defaultMessage="We recommend you resolve all deprecation issues before upgrading to the next major version of Elastic. If needed, you can apply API compatibility headers to requests that use deprecated features. {learnMoreLink}."

.../plugins/upgrade_assistant/public/application/components/es_deprecations/es_deprecations.tsx

jrodewig · 2021-11-29T15:21:30Z

.../upgrade_assistant/public/application/components/kibana_deprecations/kibana_deprecations.tsx

@@ -30,7 +30,8 @@ const i18nTexts = {
 defaultMessage: 'Kibana deprecation issues',
 }),
 pageDescription: i18n.translate('xpack.upgradeAssistant.kibanaDeprecations.pageDescription', {
- defaultMessage: 'Resolve all critical issues before upgrading.',
+ defaultMessage:
+ 'Resolve all critical issues before upgrading to the next major version of Elastic.',


I don't think "to prepare" is necessary. I think it's understood that you're preparing to upgrade.

...upgrade_assistant/public/application/components/overview/fix_issues_step/fix_issues_step.tsx

...ugins/upgrade_assistant/public/application/components/overview/upgrade_step/upgrade_step.tsx

sebelga · 2021-11-29T16:07:36Z

@sabarasaba I think this is going to 7.16.0 (for the label you put). @cjcenizal can you confirm?

cjcenizal · 2021-11-29T17:12:06Z

@sebelga Correct, AFAIK we want this to ship with 7.16.0.

cjcenizal

💥 These changes LGTM. My only concerns are addressed by James's suggestions. Thanks for the fast turnaround on this! We will cut a new BC on Thursday, so let's aim to merge this by Wednesday, 5PM Pacific.

sabarasaba · 2021-11-30T08:22:15Z

Thanks for having a look @jrodewig! I've addressed your feedback with 1b221d3 and also updated the screenshots from the PR description.

jrodewig

I didn't test locally, but this LGTM based on the screenshots and code. There was one suggestion that may have been overlooked, but it's not blocking either way: #119798 (comment)

Thanks for the fast work on this @sabarasaba! 🚀

Co-authored-by: James Rodewig <[email protected]>

kibana-ci · 2021-11-30T16:10:14Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`upgradeAssistant`	145	140	-5

Async chunks

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

id	before	after	diff
`upgradeAssistant`	138.6KB	127.9KB	-10.7KB

Page load bundle

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

id	before	after	diff
`core`	308.2KB	308.3KB	+89.0B
`upgradeAssistant`	18.3KB	18.2KB	-41.0B
total			+48.0B

History

💔 Build #10000 failed 3304cea
💚 Build #9888 succeeded 1b221d3
💚 Build #9637 succeeded 55334d7
💔 Build #9616 failed 80b36bb
💚 Build #9523 succeeded 097e88e
💔 Build #9505 failed eabcb9c

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

cc @sabarasaba

This reverts commit 34dcc1e.

sabarasaba and others added 2 commits November 29, 2021 09:17

commit using @elastic.co

57dec17

Copy and design tweaks for UA

eabcb9c

sabarasaba self-assigned this Nov 29, 2021

sabarasaba added enhancement New value added to drive a business result Feature:Upgrade Assistant release_note:skip Skip the PR/issue when compiling release notes Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v7.16.1 labels Nov 29, 2021

Fix translations

097e88e

sabarasaba marked this pull request as ready for review November 29, 2021 10:52

sabarasaba requested review from debadair and sebelga November 29, 2021 10:52

sebelga approved these changes Nov 29, 2021

View reviewed changes

Address CR changes

dff9822

sabarasaba requested a review from jrodewig November 29, 2021 13:44

kibanamachine and others added 2 commits November 29, 2021 08:50

Merge branch '7.16' into ua/update_design

80b36bb

Remove unused snapshot artifact

55334d7

jrodewig reviewed Nov 29, 2021

View reviewed changes

cjcenizal approved these changes Nov 30, 2021

View reviewed changes

sabarasaba added v7.16.0 and removed v7.16.1 labels Nov 30, 2021

sabarasaba removed the request for review from debadair November 30, 2021 08:16

Address CR feedback

1b221d3

sabarasaba requested a review from jrodewig November 30, 2021 14:31

jrodewig approved these changes Nov 30, 2021

View reviewed changes

sabarasaba and others added 2 commits November 30, 2021 15:37

Change step title as suggested

3304cea

Co-authored-by: James Rodewig <[email protected]>

Fix linter error

7fc9ee1

sabarasaba merged commit 34dcc1e into elastic:7.16 Nov 30, 2021

sabarasaba mentioned this pull request Nov 30, 2021

Update UA design to anticipate additional 7.x releases #119738

Closed

cjcenizal mentioned this pull request Dec 3, 2021

Recovering from 8.0 upgrade failure due to unmigrated 6.x indices elastic/elasticsearch#81326

Closed

sebelga added a commit to sebelga/kibana that referenced this pull request Dec 14, 2021

Revert "[Upgrade Assistant] Update UX for 7.17 (elastic#119798)"

d46d222

This reverts commit 34dcc1e.

sebelga mentioned this pull request Dec 14, 2021

Revert "[Upgrade Assistant] Update UX for 7.17 (#119798)" #121175

Merged

sebelga added a commit to sebelga/kibana that referenced this pull request Dec 15, 2021

Revert "[Upgrade Assistant] Update UX for 7.17 (elastic#119798)"

5ec0f4e

This reverts commit 34dcc1e.

sebelga added a commit to sebelga/kibana that referenced this pull request Dec 15, 2021

Revert "[Upgrade Assistant] Update UX for 7.17 (elastic#119798)"

c17915e

This reverts commit 34dcc1e.

sebelga mentioned this pull request Dec 15, 2021

Revert "[Upgrade Assistant] Update UX for 7.17 (#119798)" #121276

Closed

sebelga added a commit that referenced this pull request Dec 15, 2021

Revert "[Upgrade Assistant] Update UX for 7.17 (#119798)" (#121175)

6bcbcb0

sebelga added a commit that referenced this pull request Dec 20, 2021

Revert "[Upgrade Assistant] Update UX for 7.17 (#119798)" (#121175)

53e9ceb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Upgrade Assistant] Update UX for 7.17 #119798

[Upgrade Assistant] Update UX for 7.17 #119798

sabarasaba commented Nov 29, 2021 •

edited

Loading

elasticmachine commented Nov 29, 2021

sebelga left a comment

sebelga Nov 29, 2021

jrodewig Nov 29, 2021

sebelga Nov 29, 2021

jrodewig Nov 29, 2021

sabarasaba commented Nov 29, 2021

sabarasaba commented Nov 29, 2021

jrodewig left a comment •

edited

Loading

jrodewig Nov 29, 2021

jrodewig Nov 29, 2021

sebelga commented Nov 29, 2021

cjcenizal commented Nov 29, 2021

cjcenizal left a comment

sabarasaba commented Nov 30, 2021

jrodewig left a comment

kibana-ci commented Nov 30, 2021

	defaultMessage="You can start resolving deprecation issues before upgrading to the next major version of Elastic. If needed, you can apply API compatibility headers to requests that use deprecated features. {learnMoreLink}."
	defaultMessage="We recommend you resolve all deprecation issues before upgrading to the next major version of Elastic. If needed, you can apply API compatibility headers to requests that use deprecated features. {learnMoreLink}."

[Upgrade Assistant] Update UX for 7.17 #119798

[Upgrade Assistant] Update UX for 7.17 #119798

Conversation

sabarasaba commented Nov 29, 2021 • edited Loading

Summary

About system indices migration

elasticmachine commented Nov 29, 2021

sebelga left a comment

Choose a reason for hiding this comment

sebelga Nov 29, 2021

Choose a reason for hiding this comment

jrodewig Nov 29, 2021

Choose a reason for hiding this comment

sebelga Nov 29, 2021

Choose a reason for hiding this comment

jrodewig Nov 29, 2021

Choose a reason for hiding this comment

sabarasaba commented Nov 29, 2021

sabarasaba commented Nov 29, 2021

jrodewig left a comment • edited Loading

Choose a reason for hiding this comment

jrodewig Nov 29, 2021

Choose a reason for hiding this comment

jrodewig Nov 29, 2021

Choose a reason for hiding this comment

sebelga commented Nov 29, 2021

cjcenizal commented Nov 29, 2021

cjcenizal left a comment

Choose a reason for hiding this comment

sabarasaba commented Nov 30, 2021

jrodewig left a comment

Choose a reason for hiding this comment

kibana-ci commented Nov 30, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

sabarasaba commented Nov 29, 2021 •

edited

Loading

jrodewig left a comment •

edited

Loading