Added documentation for R2 bucket locks #19477
Merged
Conversation
This file contains hidden or 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
jonesphillip
requested review from
a team,
Oxyjun and
elithrar
as code owners
github-actions
bot
added
size/s
product:r2
Deploying cloudflare-docs with
|
| Latest commit: |
4e04711
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7c629144.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://pjones-bucket-lock.cloudflare-docs-7ou.pages.dev |
Contributor
|
Files with changes (up to 15)
|
Oxyjun
reviewed
Jan 28, 2025
| @@ -0,0 +1,77 @@ | |||
| --- | |||
| title: Bucket locks | |||
Contributor
There was a problem hiding this comment.
Suggested change
| title: Bucket locks | |
| title: Use bucket locks |
Do you think it's worth changing this title, and removing the "Get started with bucket locks" H2 below?
|
|
||
| Bucket locks prevent the deletion and overwriting of objects in an R2 bucket for a specified period — or indefinitely. When enabled, bucket locks enforce retention policies on your objects, helping protect them from accidental or premature deletions. | ||
|
|
||
| ## Get started with bucket locks |
Contributor
There was a problem hiding this comment.
Suggested change
| ## Get started with bucket locks |
|
|
||
| ## Get started with bucket locks | ||
|
|
||
| ### Prerequisites |
Contributor
There was a problem hiding this comment.
Suggested change
| ### Prerequisites | |
| ## Prerequisites |
| Bucket locks are currently configurable via API only. | ||
| ::: | ||
|
|
||
| ### Enable bucket lock via API |
Contributor
There was a problem hiding this comment.
Suggested change
| ### Enable bucket lock via API | |
| ## Enable bucket lock via API |
|
|
||
| For more information on required parameters and examples of how to enable bucket lock, refer to the [API documentation](/api/resources/r2/subresources/buckets/subresources/lock/methods/update/). For information about getting started with the Cloudflare API, refer to [Make API calls](/fundamentals/api/how-to/make-api-calls/). | ||
|
|
||
| ### Get bucket lock rules via API |
Contributor
There was a problem hiding this comment.
Suggested change
| ### Get bucket lock rules via API | |
| ## Get bucket lock rules via API |
|
|
||
| For more information on required parameters and examples of how to get bucket lock rules, refer to the [API documentation](/api/resources/r2/subresources/buckets/subresources/lock/methods/update/). | ||
|
|
||
| ## Bucket lock rules |
Contributor
There was a problem hiding this comment.
I've not turned this H2 into a H1, as we don't typically have H1s later in the page. I personally think this still works?
We can consider adding numbers to the other H2s if we want to emphasise a sense of progression.
Oxyjun
approved these changes
Jan 28, 2025
Co-authored-by: Jun Lee <[email protected]>
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Added documentation for R2 bucket locks