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

[OSCI] Remove Snapshot Material in 1.3 Documentation #5376

Merged
merged 2 commits into from
Nov 3, 2023

Conversation

JohnathonBowers
Copy link

Description

This change removes material related to snapshots from the documentation website for version 1.3.

Before the change, the website included an "Availability and Recovery" accordion under "Creating and Tuning Your Cluster":

Screenshot 2023-10-23 at 4 30 46 PM

After the change, the website no longer displays that accordion:

Screenshot 2023-10-23 at 4 33 56 PM

Issues Resolved

Closes #5188

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.

@JohnathonBowers JohnathonBowers changed the title [OCLI] Remove Snapshot Repository [OCLI] Remove Snapshot Material in 1.3 Documentation Oct 23, 2023
Copy link
Contributor

@BigSamu BigSamu left a comment

Choose a reason for hiding this comment

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

@JohnathonBowers,

I am not pretty sure if your changes are correct. The person how brought the issue specifically refers to take out the Snapshot Management feature (check the issue again).

I think what he is asking is to get rid of the section Snapshot Management API on the documentation. However, I am not an expert neither in OpenSearch v1.3 nor v2.1. What I suggest you is to ask setiah
Himanshu Setia what specifically is the request. Or instead, ask the main maintainers of OpenSearch for help (there is a group in Slack called core where everything about OpenSearch backbone is talked about).

Regards,

Samuel

@Naarcha-AWS Naarcha-AWS changed the title [OCLI] Remove Snapshot Material in 1.3 Documentation [OSCI] Remove Snapshot Material in 1.3 Documentation Oct 24, 2023
@Naarcha-AWS Naarcha-AWS added the OSCI An OSCI contribution. label Oct 25, 2023
@Naarcha-AWS
Copy link
Collaborator

@JohnathonBowers: @BigSamu is correct. We need only to remove this page: https://github.com/opensearch-project/documentation-website/blob/1.3/_tuning-your-cluster/availability-and-recovery/snapshots/sm-api.md.

All other APIs and Snapshot information should still be relevant to 1.3.

Signed-off-by: Johnathon Bowers <[email protected]>
@JohnathonBowers
Copy link
Author

Thank you, @BigSamu and @Naarcha-AWS , for the feedback. I undid the changes I had made and then made a new commit with only the sm-api.md file removed. Below is a screenshot of the documentation website before this most recent change:

Screenshot 2023-10-31 at 3 13 13 PM

And here is a screenshot of the website after the change, showing that the Snapshot management API page has been removed:

Screenshot 2023-10-31 at 3 15 04 PM

@Naarcha-AWS Naarcha-AWS merged commit 8e1f86a into opensearch-project:1.3 Nov 3, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OSCI An OSCI contribution.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants