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

[deprecations] Expose docLinks in the ConfigDeprecationContext #131991

Closed
lukeelmers opened this issue May 10, 2022 · 1 comment · Fixed by #132424
Closed

[deprecations] Expose docLinks in the ConfigDeprecationContext #131991

lukeelmers opened this issue May 10, 2022 · 1 comment · Fixed by #132424
Assignees
Labels
enhancement New value added to drive a business result impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@lukeelmers
Copy link
Member

As discussed in #112221, we'd like to make it as easy as possible for a ConfigDeprecationProvider to provide links to users to relevant documentation for addressing deprecated configs.

In #114065 we exposed the current branch to the ConfigDeprecationProvider so that plugins could construct their own doc links manually. But now that #95389 has been addressed and the docLinks service is exposed on the server, a more convenient approach would be to provide the docLinks directly in the ConfigDeprecationContext:

/**
* Deprecation context provided to {@link ConfigDeprecation | config deprecations}
*
* @public
*/
export interface ConfigDeprecationContext {
/** The current Kibana version, e.g `7.16.1`, `8.0.0` */
version: string;
/** The current Kibana branch, e.g `7.x`, `7.16`, `master` */
branch: string;
}

This way plugins can leverage the existing doclinks infrastructure instead of building their own urls manually.

@lukeelmers lukeelmers added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc enhancement New value added to drive a business result loe:small Small Level of Effort impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. labels May 10, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants