Skip to content
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

Add documentation for Cloudflare R2 usage. #1549

Merged
merged 3 commits into from
Jan 12, 2023
Merged

Add documentation for Cloudflare R2 usage. #1549

merged 3 commits into from
Jan 12, 2023

Conversation

MrAlex94
Copy link
Contributor

R2 is S3-compatible. Here are some light docs on how to use it.

@@ -28,6 +28,7 @@ Table of Contents (ToC)
* Storage Options
* [Local](docs/Local.md)
* [S3](docs/S3.md)
* [R2](docs/S3.md#R2)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure if we need separate section for all s3-compatible services. Maybe inside S3.md is enough?

Leave this for maintainers @sylvestre @drahnr to decide.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Probably not needed here, but maybe worth changing S3 to S3 and compatible or something similar?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice idea to me.

Copy link
Collaborator

Choose a reason for hiding this comment

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

sounds good

Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe worth changing S3 to S3 and compatible or something similar?

Please do this change, others LGTM~

docs/Configuration.md Outdated Show resolved Hide resolved
docs/Configuration.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Jan 11, 2023

Codecov Report

Base: 30.91% // Head: 30.93% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (d09fc37) compared to base (1a82863).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1549      +/-   ##
==========================================
+ Coverage   30.91%   30.93%   +0.01%     
==========================================
  Files          48       48              
  Lines       16589    16589              
  Branches     7896     7898       +2     
==========================================
+ Hits         5129     5131       +2     
+ Misses       6107     6104       -3     
- Partials     5353     5354       +1     
Impacted Files Coverage Δ
src/jobserver.rs 47.91% <0.00%> (-2.09%) ⬇️
src/compiler/compiler.rs 36.24% <0.00%> (-0.22%) ⬇️
src/config.rs 36.59% <0.00%> (-0.19%) ⬇️
src/compiler/msvc.rs 43.35% <0.00%> (-0.14%) ⬇️
src/server.rs 32.25% <0.00%> (-0.11%) ⬇️
src/compiler/rust.rs 34.14% <0.00%> (-0.07%) ⬇️
src/util.rs 35.50% <0.00%> (ø)
src/lib.rs 10.70% <0.00%> (+0.02%) ⬆️
src/compiler/gcc.rs 55.41% <0.00%> (+0.10%) ⬆️
src/compiler/args.rs 61.70% <0.00%> (+0.35%) ⬆️
... and 3 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@MrAlex94
Copy link
Contributor Author

Updated the S3 doc to be more informative and removed the unused env vars as well.

@sylvestre sylvestre merged commit dbe4ed7 into mozilla:main Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants