-
Notifications
You must be signed in to change notification settings - Fork 90
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
Suggestion to make example docker README.md more intuitive #236
Conversation
Attempt and suggestion to make this example more intuitive to reproduce with docker compose. Signed-off-by: Florian Knip <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
@@ -9,8 +9,24 @@ Building | |||
|
|||
Copy resources to prepare the docker-compose project by running: | |||
|
|||
mvn clean package | |||
|
|||
1. Make sure to reference the desired version for the dependencies. If in doubt you may just reference the latest version from the [official public maven repository](https://mvnrepository.com/artifact/io.strimzi/kafka-oauth-client). For example, add the line `<version>0.15.0</version>` the [pom.xlm](./kafka/pom.xlm) in the [kafka dir](./kafka) for each dependency to go with version 0.15.0.: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Make sure to reference the desired version for the dependencies. If in doubt you may just reference the latest version from the [official public maven repository](https://mvnrepository.com/artifact/io.strimzi/kafka-oauth-client). For example, add the line `<version>0.15.0</version>` the [pom.xlm](./kafka/pom.xlm) in the [kafka dir](./kafka) for each dependency to go with version 0.15.0.: | |
1. Make sure to reference the desired version for the dependencies. If in doubt, specify the latest version from the [official public maven repository](https://mvnrepository.com/artifact/io.strimzi/kafka-oauth-client). For example, add the line `<version>0.15.0</version>` the [pom.xlm](./kafka/pom.xlm) in the [kafka dir](./kafka) for each dependency to go with version 0.15.0.: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I follow this change and the error in the related issue. It seems you just didn't build the project first? Can you please elaborate more on it?
@scholzj is right. The problem is simply in that the particular README is actually confusing for the beginner about which should be the current directory where |
@scholzj Yes, certainly. Will try to answer both questions in one answer and try to relate to what @mstruk commented before: In short: Not 'connect the dots' is exactly what happened. Coming to the repo as a generalist with some knowledge and experience around kafka, k8s, java, auth, github - but fairly new to strimiz and total newbie/beginner to strimzi-kafka-oauth, I think the docs on how to get started and get things up an running is not clear:
Not sure if anything general can be derived from this, maybe for others familiar with the ecosystem everything is clear. Personally from my perspective a bit more getting started guidance from the docs would have been beneficial. |
@flo-kn Right. I'm not arguing that it was your fault or that the READMEs are all perfect. All I was trying to say is that I do not think you are supposed to add the 0.15.0 version into the
That is what I think we need to cover in the READMEs. |
Yes, thanks for the quick feedback and clarification. Appreciate it. 🫶 Suggesting to just close this PR. |
Attempt and suggestion to make this example more intuitive to reproduce with docker compose.
closes #237