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

Add documentation for segment replication GA release #3461

Merged
merged 18 commits into from
Apr 18, 2023
Merged

Conversation

ariamarble
Copy link
Contributor

@ariamarble ariamarble commented Mar 15, 2023

Description

Adds documentation for segment replication GA release

Issues Resolved

fixes #2255
fixes #3695

Checklist

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

Signed-off-by: ariamarble <armarble@amazon.com>
@ariamarble ariamarble requested a review from a team as a code owner March 15, 2023 18:16
@ariamarble ariamarble self-assigned this Mar 15, 2023
@ariamarble ariamarble added 2 - In progress Issue/PR: The issue or PR is in progress. performance Documentation related to OpenSearch performance release-notes PR: Include this PR in the automated release notes v2.7.0 labels Mar 15, 2023
@ariamarble ariamarble added 3 - Tech review PR: Tech review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Apr 5, 2023
@ariamarble ariamarble added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 3 - Tech review PR: Tech review in progress labels Apr 10, 2023
Signed-off-by: ariamarble <armarble@amazon.com>
@ariamarble ariamarble added 4 - Doc review PR: Doc review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Apr 10, 2023
Copy link
Collaborator

@Naarcha-AWS Naarcha-AWS left a comment

Choose a reason for hiding this comment

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

A few suggestions.

Copy link
Collaborator

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

Global comment: Check to make sure one space is used between sentences. There are a few double spaces between sentences.

ariamarble and others added 3 commits April 10, 2023 15:36
Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: ariamarble <armarble@amazon.com>
Signed-off-by: ariamarble <armarble@amazon.com>
@Naarcha-AWS Naarcha-AWS self-requested a review April 11, 2023 14:59
@ariamarble ariamarble added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Apr 11, 2023
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.

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

1. Track [future enhancements on segment replication](https://github.com/orgs/opensearch-project/projects/99).
1. [Segment replication blog post](https://github.com/opensearch-project/project-website/pull/1504/files).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this the correct link?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no, it will be updated once the blog goes live

@natebower natebower removed the 5 - Editorial review PR: Editorial review in progress label Apr 11, 2023
Co-authored-by: Nathan Bower <nbower@amazon.com>
@ariamarble ariamarble added the 6 - Done but waiting to merge PR: The work is done and ready to merge label Apr 11, 2023
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
@ariamarble ariamarble merged commit f831c33 into main Apr 18, 2023
@ariamarble ariamarble added Closed - Complete Issue: Work is done and associated PRs closed and removed 6 - Done but waiting to merge PR: The work is done and ready to merge labels Apr 18, 2023
@Rishikesh1159
Copy link
Member

@ariamarble @kolchfa-aws Sorry I forgot to mention this before. We need to let users using segment replication know that Segment Replication currently doesn't support wait_for requests in refresh API. Can we please include this limitation with segment replication in appropriate place.

vagimeli added a commit that referenced this pull request Apr 25, 2023
* Add documentation for segment replication GA release

Signed-off-by: ariamarble <armarble@amazon.com>

* SegRep doc updates GA

Signed-off-by: ariamarble <armarble@amazon.com>

* content updates

Signed-off-by: ariamarble <armarble@amazon.com>

* Apply suggestions from doc review

Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* additional doc review changes

Signed-off-by: ariamarble <armarble@amazon.com>

* small changes

Signed-off-by: ariamarble <armarble@amazon.com>

* Apply suggestions from editorial review

Co-authored-by: Nathan Bower <nbower@amazon.com>

* Update _tuning-your-cluster/availability-and-recovery/segment-replication/index.md

* Add primary balance information

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* adding backpressure page

Signed-off-by: ariamarble <armarble@amazon.com>

* Implemented tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* final changes

Signed-off-by: ariamarble <armarble@amazon.com>

---------

Signed-off-by: ariamarble <armarble@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
vagimeli added a commit that referenced this pull request Apr 25, 2023
vagimeli added a commit that referenced this pull request May 4, 2023
* Add documentation for segment replication GA release

Signed-off-by: ariamarble <armarble@amazon.com>

* SegRep doc updates GA

Signed-off-by: ariamarble <armarble@amazon.com>

* content updates

Signed-off-by: ariamarble <armarble@amazon.com>

* Apply suggestions from doc review

Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* additional doc review changes

Signed-off-by: ariamarble <armarble@amazon.com>

* small changes

Signed-off-by: ariamarble <armarble@amazon.com>

* Apply suggestions from editorial review

Co-authored-by: Nathan Bower <nbower@amazon.com>

* Update _tuning-your-cluster/availability-and-recovery/segment-replication/index.md

* Add primary balance information

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* adding backpressure page

Signed-off-by: ariamarble <armarble@amazon.com>

* Implemented tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* final changes

Signed-off-by: ariamarble <armarble@amazon.com>

---------

Signed-off-by: ariamarble <armarble@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
vagimeli added a commit that referenced this pull request May 5, 2023
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
…ect#3461)

* Add documentation for segment replication GA release

Signed-off-by: ariamarble <armarble@amazon.com>

* SegRep doc updates GA

Signed-off-by: ariamarble <armarble@amazon.com>

* content updates

Signed-off-by: ariamarble <armarble@amazon.com>

* Apply suggestions from doc review

Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* additional doc review changes

Signed-off-by: ariamarble <armarble@amazon.com>

* small changes

Signed-off-by: ariamarble <armarble@amazon.com>

* Apply suggestions from editorial review

Co-authored-by: Nathan Bower <nbower@amazon.com>

* Update _tuning-your-cluster/availability-and-recovery/segment-replication/index.md

* Add primary balance information

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* adding backpressure page

Signed-off-by: ariamarble <armarble@amazon.com>

* Implemented tech review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* final changes

Signed-off-by: ariamarble <armarble@amazon.com>

---------

Signed-off-by: ariamarble <armarble@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Melissa Vagi <105296784+vagimeli@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
@hdhalter hdhalter deleted the issue12255 branch March 28, 2024 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed - Complete Issue: Work is done and associated PRs closed performance Documentation related to OpenSearch performance release-notes PR: Include this PR in the automated release notes v2.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add Segment Replication Backpressure to documentation [DOC] Segment Replication - GA release
8 participants