Skip to content

Commit

Permalink
josh code review fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Bamieh committed Jun 29, 2021
1 parent e5a25ba commit b254c46
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions src/core/server/deprecations/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,23 @@ deprecation service docs generated by in core.

## What is the deprecations service?
The deprecations service provides a way for the Kibana platform to communicate deprecated features
and configs with its users. These deprecations are only communicated if the deployment is using these features,
allowing for a user tailored experience for upgrading the stack version.
and configs with its users. These deprecations are only communicated to the user if the deployment is using
these features, allowing for a user tailored experience for upgrading the stack version.

The Upgrade Assistant (UA) is the main consumer of the deprecations to show them to users and signal to Cloud that the Stack is ready
for a major upgrade.
The Upgrade Assistant (UA) is the main consumer of these deprecations. The UA displays them to users and signals to
Cloud that the Stack is ready for a major upgrade.


## Where are deprecations displayed to users?
The Upgrade Assistant (UA) in Kibana is consuming the core deprecations service in order to surface plugin
deprecations. Each deprecation is required to provide manual steps that we display in the UI. Additionally
each deprecations can provide an optional API to automatically resolve the deprecation.
each deprecation can provide an optional API to automatically resolve the deprecation.

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 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.
To display deprecations in the UA set `xpack.upgrade_assistant.readonly: false` in the kibana configurations.
The UA is in read-only mode and will be enabled up until the last minor before the next major release.

## How do I use this service for deprecated plugin configurations?
The deprecations service automatically hooks deprecated configs with the deprecations service.
Expand Down

0 comments on commit b254c46

Please sign in to comment.