[Deprecations service] make correctiveActions.manualSteps required
#100997
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bamieh
added
Team:Core
|
Pinging @elastic/kibana-core (Team:Core) |
legrego
approved these changes
Jun 1, 2021
YulNaumenko
approved these changes
Jun 1, 2021
alisonelizabeth
approved these changes
Jun 2, 2021
There was a problem hiding this comment.
Thanks for working on this! ES UI changes LGTM (updated test mock).
Side comment: We've started to do some user testing around Upgrade Assistant. One thing that's been made apparent is the importance of providing clear and concise instructions. I think it could be helpful to have someone from the docs team review the copy we're providing in the steps. Let me know what you think, and if I can help in any way.
igoristic
approved these changes
Jun 2, 2021
Co-authored-by: igoristic <igor.zaytsev.dev@gmail.com> Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
mshustov
approved these changes
Jun 2, 2021
@alisonelizabeth I believe that is a great idea and much needed since this text is directly communicated with users. I'd like to have that follow up in a separate issue and PRs since this PR involves many teams and has both content and code changes. Lets create a meta issue with all the config deprecations we have (not only the ones changed in this PR) and then asking the docs team to go over each deprecation and create separate PR changes for each team would be a lot smoother for everyone. It would also help me avoid merge conflicts, re-reviews, and being noisy. |
💛 Build succeeded, but was flaky
Test FailuresKibana Pipeline / general / task-queue-process-20 / X-Pack Endpoint Functional Tests.x-pack/test/security_solution_endpoint/apps/endpoint/policy_details·ts.endpoint When on the Endpoint Policy Details Page and the save button is clicked should have cleared the advanced section when the user deletes the valueStandard OutStack TraceMetrics [docs]Unknown metric groupsReferences to deprecated APIs
History
To update your PR or re-run it, just comment with: |
💔 Backport failed
To backport manually run: |
gmmorris
added a commit
to gmmorris/kibana
that referenced
this pull request
Jun 2, 2021
* master: (68 commits) Unskip advanced settings a11y test (elastic#100558) [App Search] Crawler Landing Page (elastic#100822) [DOCS] Clarify when to use kbn clean (elastic#101155) change label behavior (elastic#100991) skip flaky suite (elastic#101126) Fix cases plugin ownership (elastic#101073) [Home] Adding file upload to add data page (elastic#100863) [ML] Functional tests - reenable categorization tests (elastic#101137) [DOCS] Adds server.uuid to settings docs (elastic#101121) Fix newsfeed unread notifications always on when reloading Kibana (elastic#100357) [Lens] Time shift metrics (elastic#98781) [Deprecations service] make `correctiveActions.manualSteps` required (elastic#100997) Add "Risk Matrix" section to the PR template (elastic#100649) [Maps] spatially filter by all geo fields (elastic#100735) [Security Solution] Add Ransomware canary advanced policy option (elastic#101068) [Exploratory view] Core web vitals (elastic#100320) [Security solution][Endpoint] Add unit tests for fleet event filters/trusted apps cards (elastic#101034) [Lens] Use a setter function for the dimension panel (elastic#101123) [Index Patterns] Fix return saved index pattern object (elastic#101051) [CI] For PRs, build TS refs before public api docs check (elastic#100791) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Not having any
correctiveActionsleads to a poor UX, as a user doesn't have context on how to resolve a deprecation. It also is an inconsistent experience as some config deprecations provide manual corrective steps, while others do not.This PR enforces all deprecations to register manual corrective steps.
Changes
correctiveActions.manualStepsrequired in for all deprecations.Closes #96059
Note to reviewers
If your team is pinged it means I've added manual corrective steps for your custom config deprecations based on the deprecation details. Please filter the files by CODEOWNERS and make sure the manual steps make sense.