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

[ci skip] Add link with full list of options for S3-compatible services #42548

Merged

Conversation

ceritium
Copy link
Contributor

@ceritium ceritium commented Jun 21, 2021

Summary

Add a link with a full list of options for S3-compatible services.

It was a bit hard for me to find the proper configuration for "minio" (S3-compatible), so I guess it would help others.

@rails-bot rails-bot bot added the docs label Jun 21, 2021
@ghiculescu
Copy link
Member

ghiculescu commented Jun 21, 2021

Does this work with Active Storage out of the box? I don't see minio as an included service: https://github.com/rails/rails/tree/main/activestorage/lib/active_storage/service

edit: oh wait, service: S3.

@ceritium ceritium marked this pull request as ready for review June 21, 2021 15:05
@zzak
Copy link
Member

zzak commented Jun 21, 2021

I think we should not add documentation for services that are not officially supported 🤔 but I could be missing some context here as I also have no idea what minio is..

@ceritium
Copy link
Contributor Author

minio is a storage service compatible with S3 with a community edition. I thought that it was more popular. Some teams use it on production, of course, but also for development.

Maybe the problem is on the AWS documentation (linked in the guides), for me was not clear what options can I use until I found this yard documentation.

Since "minio" is just another s3 compatible service and the API can change, maybe it would make sense to point to the yard documentation and remove the "minio" example. I will push a more generic proposal later.

@ghiculescu
Copy link
Member

@ceritium I think it would be better if this was updated in the AWS documentation directly. Do they accept PRs?

@ceritium ceritium force-pushed the active-storage-guide-minio-example branch 2 times, most recently from ace6d7e to 559b110 Compare June 23, 2021 13:56
@ceritium
Copy link
Contributor Author

@ghiculescu they accept PRs. I can try to improve their docs too. But in any case, I think that this PR can help to rails devs experience.

I just pushed a new approach. Let me know what do you think.

@ceritium ceritium changed the title [ci skip] Add minio example to ActiveStorage guide [ci skip] Add link with full list of options for S3-compatible services Jun 23, 2021
@ghiculescu
Copy link
Member

Yep, I like that much better 👍

@zzak
Copy link
Member

zzak commented Jun 24, 2021

@ceritium Could you squash your commits please? 🙇

Add a link to AWS S3 yard documentation on the ActiveStorage guide
under section "S3-compatible storage services".
@ceritium ceritium force-pushed the active-storage-guide-minio-example branch from 559b110 to 05e0125 Compare June 24, 2021 08:41
@ceritium
Copy link
Contributor Author

ceritium commented Jun 24, 2021

@zzak, I kept both commits to allow review of the PR with all the context. I already squashed them and rephrased the commit. Thanks!

@guilleiguaran guilleiguaran merged commit 2c51d7e into rails:main Jun 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants