Skip to content

[r2] add troubleshooting #17623

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

Merged
merged 21 commits into from
Apr 16, 2025

Conversation

Le0Developer
Copy link
Contributor

@Le0Developer Le0Developer commented Oct 18, 2024

Summary

Hi 👋

This adds a troubleshooting guide for R2 with issues we frequently encountered on the Cloudflare Discord server.

Very open to all feedback as this is a rough draft!

Screenshots (optional)

(very outdated wording)
image

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.

@github-actions github-actions bot added the product:r2 R2 object storage: https://developers.cloudflare.com/r2 label Oct 18, 2024
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

1 files reviewed, 3 total issue(s) found.

Le0Developer and others added 4 commits October 18, 2024 10:56
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
@dcpena
Copy link
Collaborator

dcpena commented Oct 18, 2024

@Le0Developer Thanks so much for the contribution! I'll bring this up to stakeholders today for review and will hopefully be ready to move forward with the PR next week.

@dcpena
Copy link
Collaborator

dcpena commented Oct 28, 2024

@Le0Developer Thanks so much for the contribution! I'll bring this up to stakeholders today for review and will hopefully be ready to move forward with the PR next week.

Just wanted to follow up and let you know that I brought it up, and we'll likely want to take some of this info and put it on the CORS page instead of a separate Troubleshooting page. When a new PR gets opened, I'll be sure to tag you for review!

@Le0Developer
Copy link
Contributor Author

Just wanted to follow up and let you know that I brought it up, and we'll likely want to take some of this info and put it on the CORS page instead of a separate Troubleshooting page. When a new PR gets opened, I'll be sure to tag you for review!

These issues are not related to CORS – CORS failure is just a sympton because the appropriate headers aren't being returned. The underlying issue is the WAF/Hotlink protection/Incorrect S3 signature, so I don't think putting it into the CORS page makes much sense. Although I'd put a link from CORS to the troubleshooting section.

@dcpena dcpena removed their assignment Feb 10, 2025
@kodster28
Copy link
Contributor

Howdy @Oxyjun, mind taking a look at this now that you're over in this area.

Apologies this has sat for a while, @Le0Developer.

Copy link
Contributor

hyperlint-ai bot commented Mar 25, 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

Added a troubleshooting guide for R2 addressing common issues encountered by users.

  • Introduced a troubleshooting guide for CORS and HTTP 5XX errors in R2.
  • Provided detailed steps for diagnosing CORS issues and managing request volume.
  • Included recommendations for bucket sharding to improve system resilience.

Added Files

  • src/content/docs/r2/platform/troubleshooting.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.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

Copy link
Contributor

@Oxyjun Oxyjun left a comment

Choose a reason for hiding this comment

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

Style guide check

@dcpena dcpena removed their request for review April 4, 2025 21:40
@helloimalastair
Copy link
Contributor

LGTM

@Oxyjun Oxyjun merged commit 6131dc7 into cloudflare:production Apr 16, 2025
6 checks passed
@workers-devprod workers-devprod added the contribution [Holopin] Recognizes a docs contribution, big or small label Apr 16, 2025
Copy link

holopin-bot bot commented Apr 16, 2025

Congratulations @Le0Developer, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cm9jnlam127180cjir1kuqu3t

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* add r2 troubleshooting

* update wording to be friendlier and point to more docs

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>

* worker -> client

* remove "fyi" of OPTIONS method

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

* Update src/content/docs/r2/platform/troubleshooting.mdx

Co-authored-by: Jun Lee <[email protected]>

---------

Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: Jun Lee <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution [Holopin] Recognizes a docs contribution, big or small product:r2 R2 object storage: https://developers.cloudflare.com/r2 size/s
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants