-
Notifications
You must be signed in to change notification settings - Fork 8.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Deprecation service] Using i18n for deprecation messages #103422
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @Bamieh for updating this FAQ! Left a couple nits, but overall LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add guidance on what we should do for deprecations like HTTP APIs? For instance, should those be logged in a specific format or with a specific meta field for filtering
To check your plugin deprecations, go to the UA interface via **Stack Management > Stack > Upgrade Assistant** and | ||
click on `View deprecations` under the Kibana section. | ||
|
||
To display Kibana deprecations in the UA set `xpack.upgrade_assistant.readonly: false` in the kibana configurations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a reader it's not clear to me the difference between plugin deprecations and Kibana deprecations and why this config is necessary to view the Kibana ones.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed kibana deprecations
in favor of plugin deprecations
across the doc file. i've adedd an explanation why this config is needed:
The UA is in read-only mode and will be enabled up until the last minor before the next major release.
@joshdover we dont have any concrete best practices around this yet. I believe we'd be developing them with time based on feedback and UA requirements. Currently we only use Do you have something specific in mind that we can add related to this? |
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
Let's discuss this as a follow up. I suspect we need to align on this pretty soon as we improve the upgrade experience. |
💚 Backport successful
This backport PR will be merged automatically after passing CI. |
Adds a
.mdx
FAQ guide for deprecations service to help people get started.Note:
We've decided to add
i18n
to the deprecation config objects. First we need to inject i18n into the deprecation function to enable teams to use it before adding it to the docs and guideline. This will be done in a follow up PR with code changes. Related: #99072Previous PR: #99043