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.

Sign up for GitHub

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

Jump to bottom

[issue 450] Deprecate terms #513

Merged
merged 17 commits into from
May 18, 2022
Merged

[issue 450] Deprecate terms #513

merged 17 commits into from
May 18, 2022

Conversation

alicejw1
Copy link
Contributor

@alicejw1 alicejw1 commented Apr 18, 2022 •
edited
Loading

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
[FEATURE] Change the "master" nomenclature #450
Closed
@alicejw1 alicejw1 marked this pull request as draft April 18, 2022 21:41
alicejw1 added 2 commits April 18, 2022 15:40
@alicejw1
for image update to match new terminology text
616dcac 
Signed-off-by: alicejw <alicejw@amazon.com>
@alicejw1
for edits to make consistent in table
38b9d58 
Signed-off-by: alicejw <alicejw@amazon.com>
@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 added 3 commits April 19, 2022 10:36
@alicejw1
fix formatting in table
2292d7f 
Signed-off-by: alicejw <alicejw@amazon.com>
@alicejw1
to add announcement of nomenclature change, per requirements in issue…
e16dc53 
…#450

Signed-off-by: alicejw <alicejw@amazon.com>
@alicejw1
more clarity in example for setting cluster manager node
0664f4d 
Signed-off-by: alicejw <alicejw@amazon.com>
@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 added 4 commits April 20, 2022 10:00
@alicejw1
add table heading
45946f8 
Signed-off-by: alicejw <alicejw@amazon.com>
@alicejw1
to add original png file
ade31ba 
Signed-off-by: alicejw <alicejw@amazon.com>
@alicejw1
to replace updated png with original file name
fbba4ff 
Signed-off-by: alicejw <alicejw@amazon.com>
@alicejw1
switch left nav as acronmy-only, and page with full title, then acronym
e669674 
Signed-off-by: alicejw <alicejw@amazon.com>
@alicejw1 alicejw1 requested a review from tlfeng April 20, 2022 20:12
@alicejw1
Copy link
Contributor Author

alicejw1 commented Apr 20, 2022 •
edited
Loading

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

keithhc2
keithhc2 approved these changes Apr 20, 2022
View reviewed changes
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
@alicejw1
for reviewer comments
a5811c1 
Signed-off-by: alicejw <alicejw@amazon.com>
@keithhc2 keithhc2 added upcoming release Don't merge until the version or feature is available v2.0.0 labels Apr 23, 2022
tlfeng
tlfeng reviewed Apr 26, 2022
View reviewed changes
_opensearch/cluster.md Outdated Show resolved Hide resolved
@alicejw1
for feedback comments
6b9a22c 
Signed-off-by: alicejw <alicejw@amazon.com>
@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 ."

natebower
natebower requested changes Apr 27, 2022
View reviewed changes
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
@alicejw1
for updates to cluster manager nomenclature throughout descriptive se…
64e8e4b 
…ctions

Signed-off-by: alicejw <alicejw@amazon.com>
natebower
natebower approved these changes Apr 28, 2022
View reviewed changes
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

alicejw1 added 3 commits May 3, 2022 13:00
@alicejw1
resolve merge conflicts
8a8f16e 
Signed-off-by: alicejw <alicejw@amazon.com>
@alicejw1
resolve conflicts
2bbe6d0 
Signed-off-by: alicejw <alicejw@amazon.com>
@alicejw1
fix merge conflict
2bcfb4a 
Signed-off-by: alicejw <alicejw@amazon.com>
@alicejw1 alicejw1 merged commit cb4dac4 into opensearch-project:main May 18, 2022
@keithhc2 keithhc2 mentioned this pull request Jun 1, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natebower natebower natebower approved these changes

@Naarcha-AWS Naarcha-AWS Naarcha-AWS approved these changes

@tlfeng tlfeng tlfeng approved these changes

@keithhc2 keithhc2 keithhc2 approved these changes

Assignees

@alicejw1 alicejw1

Labels
upcoming release Don't merge until the version or feature is available v2.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FEATURE] Change the "master" nomenclature
5 participants
@alicejw1 @keithhc2 @tlfeng @Naarcha-AWS @natebower