Docs: Enhance immutable snapshots guide with detailed instructions #811
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Revise 'enabling_immutable_snapshots.md' to provide a comprehensive guide on enabling immutable snapshots in `etcd-backup-restore`. - Add a Terminology section for clarity and consistent use of terms. - Include detailed instructions for configuring bucket-level immutability on Google Cloud Storage (GCS) and Azure Blob Storage (ABS). - Elaborate on best practices. - Improve grammar and readability throughout the document.
gardener-robot
added
needs/review
gardener-robot-ci-3
added
the
reviewed/ok-to-test
gardener-robot-ci-2
added
needs/ok-to-test
renormalize
requested changes
Dec 3, 2024
- Changed 'Retention Period' to 'Immutability Period'. - Removed reference to future AWS S3 support.
gardener-robot-ci-1
added
reviewed/ok-to-test
|
Thanks @renormalize for reviewing. I've addressed all your review comments. |
renormalize
approved these changes
Dec 5, 2024
There was a problem hiding this comment.
Thanks for the PR @seshachalam-yv!
I've pointed out one comment again which you'd missed. Other than that, the doc looks great.
gardener-robot-ci-1
added
the
reviewed/ok-to-test
gardener-robot-ci-2
removed
the
reviewed/ok-to-test
gardener-robot
added
the
status/closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR enhances the documentation for enabling immutable snapshots in
etcd-backup-restore. It provides a comprehensive guide with detailed instructions for configuring bucket-level immutability on Google Cloud Storage (GCS) and Azure Blob Storage (ABS). The updated guide includes:Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
docs/usage/immutable_snapshots.mdhas been revised and renamed todocs/usage/enabling_immutable_snapshots.mdto better reflect its content.cc: @renormalize @ishan16696
Release note: