Update Rclone example #22095
Update Rclone example #22095
Conversation
Pull in latest from the main repo
Merging in prod
rickyrobinett
requested review from
Oxyjun,
elithrar,
jonesphillip,
harshil1712 and
a team
as code owners
|
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 SummaryReorganized and enhanced the Rclone tutorial for better clarity and usability.
Modified Files
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 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 |
github-actions
bot
added
the
product:r2
| import { Render } from "~/components"; | ||
| import { Render, Steps } from "~/components"; | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
Ah, AI sometimes gets heading happy.
I'd typically avoid Overview b/c it's implicit as the top section of the page.
|
|
||
| ## Overview | ||
|
|
||
| [Rclone](https://rclone.org/) is a command-line tool that allows you to manage files on cloud storage directly from your terminal. With Rclone, you can: |
There was a problem hiding this comment.
This is definitely an improvement over the previous lead-in.
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, you'll need: |
There was a problem hiding this comment.
AI gets a little contraction happy, imo
| Before you begin, you'll need: | ||
|
|
||
| - [Rclone installed](https://rclone.org/install/) on your system (v1.59 or later) | ||
| - An R2 bucket created in your Cloudflare account |
There was a problem hiding this comment.
Is this accurate? If so, good (and slightly embarrassing) improvement over the original
There was a problem hiding this comment.
Point 1, yes. Point 2, technically you could try to set this up without any R2 buckets but then there would be nothing for Rclone to do, so I think having a bucket created is a default for productive use.
| 2. Select a name for the new remote. For example, use `r2`. | ||
| 3. Select the `Amazon S3 Compliant Storage Providers` storage type. | ||
| 4. Select `Cloudflare R2 storage` for the provider. | ||
| 5. Select `1` to enter your access credentials manually. |
There was a problem hiding this comment.
Yes. I went through this to check.
| # Creates ./downloads/report.pdf on your local machine | ||
| ``` | ||
|
|
||
| ### Syncing directories |
There was a problem hiding this comment.
Not present before? I don't hate it, but unclear if hallucinating
There was a problem hiding this comment.
I tested. But let's have @Oxyjun double check.
| - `--s3-chunk-size`: The size of each part (default: 5MB) | ||
| - `--s3-upload-cutoff`: Files larger than this will use multipart upload (default: 200MB) | ||
|
|
||
| :::tip[Multipart upload cost optimization] |
There was a problem hiding this comment.
I'd be really careful around cost optimization recommendation if it came from AI
There was a problem hiding this comment.
Came from the original doc, just reworded.
There was a problem hiding this comment.
But still good for @elithrar to validate the framing here.
| You can also generate presigned links which allow you to share public access to a file temporarily using the [rclone link](https://rclone.org/commands/rclone_link/) command. | ||
| ### Common file operations | ||
|
|
||
| Rclone provides many other useful commands for managing your R2 objects: |
There was a problem hiding this comment.
I don't think this section needs to be here. AI can be too verbose.
| R2 doesn't support the `--unlink` flag in rclone. | ||
| ::: | ||
|
|
||
| ## Mounting R2 buckets as local filesystems |
There was a problem hiding this comment.
This specific example was the main thing I started wanting to add to the doc, haha.
| - For macOS, you may need to install [macFUSE](https://osxfuse.github.io/) first | ||
| ::: | ||
|
|
||
| ## Troubleshooting |
There was a problem hiding this comment.
This is an example page, don't think we need the following content.
There was a problem hiding this comment.
Yeah, it's a good debate. Would love @elithrar 's feedback. I'm ok cutting, though added in part because I hit a couple errors trying to get going myself.
Summary
Re-organizing and adding some additional context in Rclone tutorial.
Documentation checklist