[Core deprecations] Add title field to deprecation info#109840
[Core deprecations] Add title field to deprecation info#109840Bamieh merged 12 commits intoelastic:masterfrom
Conversation
alisonelizabeth
left a comment
There was a problem hiding this comment.
General approach LGTM. I'd recommend bringing in someone from the docs team as well to review the copy changes once this is ready for review.
x-pack/plugins/upgrade_assistant/__jest__/client_integration/kibana.test.ts
Outdated
Show resolved
Hide resolved
jportner
left a comment
There was a problem hiding this comment.
Code review only -- snapshot changes in x-pack/plugins/security/server/config_deprecations.test.ts LGTM
jloleysens
left a comment
There was a problem hiding this comment.
Thanks for making these changes @Bamieh ! App services changes look good, though I think we should update the titles to something a bit more helpful.
I agree with @alisonelizabeth that getting proper copy review before (or soon after) merging would be best.
x-pack/plugins/reporting/server/deprecations/migrate_existing_indices_ilm_policy.ts
Outdated
Show resolved
Hide resolved
| { | ||
| message: `You have ${indexPatternsWithScriptedFields.length} index patterns (${titlesPreview}...) that use scripted fields. Scripted fields are deprecated and will be removed in future. Use runtime fields instead.`, | ||
| title: i18n.translate('data.deprecations.scriptedFieldsTitle', { | ||
| defaultMessage: 'Found scripted fields', |
There was a problem hiding this comment.
| defaultMessage: 'Found scripted fields', | |
| defaultMessage: 'Found index patterns using scripted fields', |
CC @mattkime for the accuracy of this title.
debadair
left a comment
There was a problem hiding this comment.
I didn't provide suggestions for every occurrence, as it was repetitive. I can if it's helpful, but felt like I was just repeating myself. :-) In general:
- Avoid repeating the title in the message.
- Avoid using quotes for emphasis.
- Make sure there is end punctuation on the messages.
- Where possible, lead with the action the user has to take, rather than the context.
docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md
Show resolved
Hide resolved
docs/development/core/server/kibana-plugin-core-server.deprecationsservicesetup.md
Show resolved
Hide resolved
| i18n.translate('xpack.timelion.deprecations.worksheets.manualStepOneMessage', { | ||
| defaultMessage: 'Navigate to the Kibana Dashboard and click "Create dashboard".', | ||
| }), | ||
| i18n.translate('xpack.timelion.deprecations.worksheets.manualStepTwoMessage', { | ||
| defaultMessage: 'Select Timelion from the "New Visualization" window.', | ||
| }), |
There was a problem hiding this comment.
This feels incomplete--or at least unclear where you need to select Timelion.
There was a problem hiding this comment.
This is just an example so I only kept the first two steps
packages/kbn-config/src/deprecation/deprecation_factory.test.ts
Outdated
Show resolved
Hide resolved
packages/kbn-config/src/deprecation/deprecation_factory.test.ts
Outdated
Show resolved
Hide resolved
stratoula
left a comment
There was a problem hiding this comment.
Kibana app code changes LGTM, code review only
💛 Build succeeded, but was flaky
Test FailuresKibana Pipeline / general / X-Pack Detection Engine API Integration Tests.x-pack/test/detection_engine_api_integration/security_and_spaces/tests/exception_operators_data_types/ip_array·ts.detection engine api security and spaces enabled Detection exceptions data types and operators Rule exception operators for data type ip "is in list" operator will return 1 result if we have a list that includes all ipsStandard OutStack TraceMetrics [docs]Public APIs missing comments
Page load bundle
History
To update your PR or re-run it, just comment with: |
💔 Backport failed
To backport manually run: |
… (#110776) * merge conflicts * fix snapshot
Summary
Use i18n for all current deprecations + update all documentations to include
i18nguidelines and i18n in the examples.Update deprecation service README to include best practices for writing deprecations
Add support for deprecation
title. The title will be displayed in multiple places in the Upgrade assistant.Config deprecation title for
unused,rename,renameFromRootandunusedFromRoot:Custom config deprecation default title
deprecation title on fetch failure
deprecation title for plugin deprecations: no default and required for each deprecation.
Context: #109166
Closes #99625
Closes #99072
Note to reviewers:
Since the
titlefield is required I've also added titles to the following list of deprecations. If your team is requested a review please filter changes by codeowners and verify that the title makes sense.Updated deprecation titles