Skip to content
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

Merged
merged 5 commits into from
Jun 30, 2021

Conversation

Bamieh
Copy link
Member

@Bamieh Bamieh commented Jun 27, 2021

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: #99072

Previous PR: #99043

@Bamieh Bamieh added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes test-docs docs v7.14.0 auto-backport Deprecated - use backport:version if exact versions are needed labels Jun 27, 2021
@Bamieh Bamieh requested a review from a team as a code owner June 27, 2021 15:54
Copy link
Contributor

@alisonelizabeth alisonelizabeth left a 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.

src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@joshdover joshdover left a 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

src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
src/core/server/deprecations/README.mdx Outdated Show resolved Hide resolved
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.
Copy link
Contributor

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.

Copy link
Member Author

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.

@Bamieh
Copy link
Member Author

Bamieh commented Jun 29, 2021

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

@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 meta field for configs. if UA intends to expand on this field we'll document it here later on.

Do you have something specific in mind that we can add related to this?

@Bamieh Bamieh requested a review from joshdover June 29, 2021 07:19
@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

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

@joshdover
Copy link
Contributor

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 meta field for configs. if UA intends to expand on this field we'll document it here later on.

Do you have something specific in mind that we can add related to this?

Let's discuss this as a follow up. I suspect we need to align on this pretty soon as we improve the upgrade experience.

@Bamieh Bamieh merged commit 23621e6 into elastic:master Jun 30, 2021
@Bamieh Bamieh deleted the deprecations/docs branch June 30, 2021 13:51
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jun 30, 2021
@kibanamachine
Copy link
Contributor

💚 Backport successful

Status Branch Result
7.x

This backport PR will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request Jun 30, 2021
@spalger spalger added v7.15.0 and removed v7.14.0 labels Jul 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed docs release_note:skip Skip the PR/issue when compiling release notes test-docs v7.15.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants