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

[Documentation] Description when which s3-integration starter and client should be used. #164

Closed
2 tasks done
boal opened this issue Sep 18, 2024 · 2 comments
Closed
2 tasks done
Assignees
Labels
Type: Documentation The issue contains work for the documentation
Milestone

Comments

@boal
Copy link
Contributor

boal commented Sep 18, 2024

Relevant documentation

refarch-integrations

Problem description (optional)

Currently there is a refarch-s3-integration-rest-starter and a refarch-s3-integration-java-starter available. And there is also an image to run a refarch-s3-integration service.

It is not clear from the documentation what kind of starter/image should be used for which use case. Additionally, it is not clear which client starter can be used for which starter/image mentioned above.

Desired solution

The documentation in the README.md should be extended.

Additional context (optional)

No response

No duplicate

  • I confirm that this issue is not a duplicate

Code of Conduct

  • I agree to follow this project's Code of Conduct
@boal boal added the Type: Documentation The issue contains work for the documentation label Sep 18, 2024
@boal boal changed the title [Documentation] Description when which s3-integration starter should be used. [Documentation] Description when which s3-integration starter and client should be used. Sep 18, 2024
@simonhir simonhir added this to the Release 1.0 milestone Dec 6, 2024
@simonhir
Copy link
Member

simonhir commented Jan 22, 2025

@boal would be nice if you cold review https://refarch.oss.muenchen.de/integrations/s3.html
Hope the description is now more understandable.
Weither to use rest or java starter is an architecture decision in the using projects. Don't think suggesting here one is the right way.

@boal
Copy link
Contributor Author

boal commented Feb 24, 2025

@simonhir

Hi Simon,

i think that is enough documentation for the s3 integration.

@github-project-automation github-project-automation bot moved this from Open to Done in it@M RefArch Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation The issue contains work for the documentation
Projects
Status: Done
Development

No branches or pull requests

2 participants