Skip to content

[R2] Improving visibility of common use-cases #22687

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
Merged
merged 6 commits into from
May 28, 2025
Merged

[R2] Improving visibility of common use-cases #22687

merged 6 commits into from
May 28, 2025

Conversation

@Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented May 27, 2025 •
edited
Loading

Summary

  1. Making it easier to go to R2 Workers Binding API by surfacing links in more places.
  2. Adding a small section on changing the object type from STANDARD to STANDARD_IA using aws cli. This does not require users to configure lifecycle rules. I've explicitly tested the steps using aws cli, and have confirmed it to work.
  3. Surfacing link to the tutorial 'Protect an R2 Bucket with Cloudflare Access` (https://developers.cloudflare.com/r2/tutorials/cloudflare-access/) in more / relevant places for better discoverability.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@Oxyjun Oxyjun requested review from a team, aninibread, elithrar and harshil1712 as code owners May 27, 2025 14:46
@github-actions github-actions bot added size/m product:r2 R2 object storage: https://developers.cloudflare.com/r2 labels May 27, 2025
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented May 27, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Enhanced the documentation for R2 by improving link visibility and adding information on storage class changes.

  • Improved discoverability of the R2 Workers Binding API by adding links in multiple locations.
  • Added instructions for changing object storage class from STANDARD to STANDARD_IA using AWS CLI.
  • Included a link to the tutorial on protecting R2 buckets with Cloudflare Access in relevant sections.

Modified Files

  • src/content/docs/r2/buckets/create-buckets.mdx
  • src/content/docs/r2/buckets/public-buckets.mdx
  • src/content/docs/r2/buckets/storage-classes.mdx
  • src/content/docs/r2/get-started.mdx
  • src/content/docs/r2/objects/delete-objects.mdx
  • src/content/docs/r2/objects/download-objects.mdx
  • src/content/docs/r2/objects/index.mdx
  • src/content/docs/r2/objects/multipart-objects.mdx
  • src/content/docs/r2/objects/upload-objects.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions
Copy link
Contributor

github-actions bot commented May 27, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/r2/ @oxyjun, @elithrar, @jonesphillip, @aninibread, @harshil1712, @cloudflare/workers-docs, @cloudflare/pcx-technical-writing
* @cloudflare/pcx-technical-writing

Maddy-Cloudflare
Maddy-Cloudflare approved these changes May 28, 2025
View reviewed changes
@Oxyjun Oxyjun requested a review from jonesphillip as a code owner May 28, 2025 11:29
@github-actions
Copy link
Contributor

github-actions bot commented May 28, 2025 •
edited
Loading

Preview URL: https://73303e53.preview.developers.cloudflare.com
Preview Branch URL: https://jun-r2-feedback.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/r2/buckets/storage-classes/ https://jun-r2-feedback.preview.developers.cloudflare.com/r2/buckets/storage-classes/
https://developers.cloudflare.com/r2/objects/upload-objects/ https://jun-r2-feedback.preview.developers.cloudflare.com/r2/objects/upload-objects/
https://developers.cloudflare.com/r2/objects/delete-objects/ https://jun-r2-feedback.preview.developers.cloudflare.com/r2/objects/delete-objects/
https://developers.cloudflare.com/r2/objects/download-objects/ https://jun-r2-feedback.preview.developers.cloudflare.com/r2/objects/download-objects/
https://developers.cloudflare.com/r2/objects/ https://jun-r2-feedback.preview.developers.cloudflare.com/r2/objects/
https://developers.cloudflare.com/r2/objects/multipart-objects/ https://jun-r2-feedback.preview.developers.cloudflare.com/r2/objects/multipart-objects/
https://developers.cloudflare.com/r2/buckets/create-buckets/ https://jun-r2-feedback.preview.developers.cloudflare.com/r2/buckets/create-buckets/
https://developers.cloudflare.com/r2/buckets/public-buckets/ https://jun-r2-feedback.preview.developers.cloudflare.com/r2/buckets/public-buckets/
https://developers.cloudflare.com/r2/get-started/ https://jun-r2-feedback.preview.developers.cloudflare.com/r2/get-started/

aninibread
aninibread reviewed May 28, 2025
View reviewed changes
@Oxyjun Oxyjun enabled auto-merge (squash) May 28, 2025 15:06
@Oxyjun Oxyjun merged commit b8be519 into production May 28, 2025
11 checks passed
@Oxyjun Oxyjun deleted the jun/r2/feedback branch May 28, 2025 15:17
sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
@Oxyjun @Maddy-Cloudflare
@aninibread @sdnts
[R2] Improving visibility of common use-cases (cloudflare#22687)
e01325c 
* Adding a partial file to direct users to WB API

* Surfacing link to Access <> R2 tutorial page for
better discoverability.

* Adding example of copying object using aws s3api

* Switching order of links

* Apply suggestions from code review

Co-authored-by: Maddy <[email protected]>

* Update src/content/docs/r2/buckets/storage-classes.mdx

Co-authored-by: Anni Wang <[email protected]>

---------

Co-authored-by: Maddy <[email protected]>
Co-authored-by: Anni Wang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aninibread aninibread aninibread left review comments

@Maddy-Cloudflare Maddy-Cloudflare Maddy-Cloudflare approved these changes

@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner

@harshil1712 harshil1712 Awaiting requested review from harshil1712 harshil1712 is a code owner

@jonesphillip jonesphillip Awaiting requested review from jonesphillip jonesphillip is a code owner

Assignees

@elithrar elithrar

@jonesphillip jonesphillip

@harshil1712 harshil1712

@aninibread aninibread

@Oxyjun Oxyjun

Labels

product:r2 R2 object storage: https://developers.cloudflare.com/r2 size/m

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Oxyjun @aninibread @Maddy-Cloudflare @elithrar @jonesphillip @harshil1712