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

[issue 450] Deprecate terms #513

Merged
merged 17 commits into from
May 18, 2022

Conversation

alicejw1
Copy link
Contributor

@alicejw1 alicejw1 commented Apr 18, 2022

Description

Replace terms throughout the docs for OpenSearch REST APIs and settings deprecated in version 2.0: "master" is replaced with "cluster manager."

Issue requested to notify customers about the nomenclature change. Plan to add to What’s new post, and the Release Notes. Within the doc set, after first instance of “master”→“cluster manager”, there is a note to call out the change.

Issues Resolved

[FEATURE]Deprecate the "master" nomenclature #450

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@alicejw1 alicejw1 requested a review from a team as a code owner April 18, 2022 21:36
@alicejw1 alicejw1 self-assigned this Apr 18, 2022
@alicejw1 alicejw1 linked an issue Apr 18, 2022 that may be closed by this pull request
@alicejw1 alicejw1 marked this pull request as draft April 18, 2022 21:41
@alicejw1 alicejw1 marked this pull request as ready for review April 18, 2022 23:12
@alicejw1 alicejw1 marked this pull request as draft April 19, 2022 17:21
@alicejw1
Copy link
Contributor Author

Update: I set PR as draft while I add a section.

@alicejw1 alicejw1 marked this pull request as ready for review April 19, 2022 19:30
@alicejw1 alicejw1 changed the title Deprecate terms 450 Deprecate terms - issue #450 Apr 19, 2022
@alicejw1 alicejw1 changed the title Deprecate terms - issue #450 Deprecate terms - [issue #450] Apr 19, 2022
@alicejw1 alicejw1 changed the title Deprecate terms - [issue #450] [issue 450] Deprecate terms Apr 19, 2022
@alicejw1 alicejw1 requested a review from tlfeng April 20, 2022 20:12
@alicejw1
Copy link
Contributor Author

alicejw1 commented Apr 20, 2022

Hi @tlfeng Tianli,
Could you please review this PR for us to verify that all items are documented for the issue #450? Thanks,
Alice

Copy link
Contributor

@keithhc2 keithhc2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few nitpicks

_opensearch/cluster.md Outdated Show resolved Hide resolved
_opensearch/cluster.md Outdated Show resolved Hide resolved
_opensearch/rest-api/cluster-health.md Outdated Show resolved Hide resolved
Signed-off-by: alicejw <[email protected]>
@keithhc2 keithhc2 added upcoming release Don't merge until the version or feature is available v2.0.0 labels Apr 23, 2022
_opensearch/cluster.md Outdated Show resolved Hide resolved
Signed-off-by: alicejw <[email protected]>
@alicejw1
Copy link
Contributor Author

Hi @tlfeng and @Naarcha-AWS,
Just an update, we discussed creating a separate PR for documenting the list of deprecated APIs and settings in these doc locations:

  • Release Notes (2.0) & breaking changes
  • Deprecated APIs (separate page with full list)
  • REST API overview - 1 paragraph announcement:
    "Several APIs and settings are set for deprecation with the next release (3.0). For the complete list, see ."

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see my suggested changes and let me know if you have any questions. Thanks!

_opensearch/cluster.md Outdated Show resolved Hide resolved
_opensearch/cluster.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: alicejw <[email protected]>
Signed-off-by: alicejw <[email protected]>
@alicejw1 alicejw1 merged commit cb4dac4 into opensearch-project:main May 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
upcoming release Don't merge until the version or feature is available v2.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Change the "master" nomenclature
5 participants