simplify and clarify documentation for local development #85
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
prestona
reviewed
Mar 15, 2023
| @@ -94,15 +94,14 @@ We will not discuss establishing a connection from your laptop to Event Streams | |||
|
|
|||
| The `java -jar ./build/libs/kafka-java-console-sample-2.0.jar` part of the command identifies the locations of the .JAR file to run within the cloned repository. You do not need to change this. | |||
|
|
|||
| Use the `kafka_brokers_sasl` from the **Service credentials** created in Step 2. We recommend using all the `kafka_brokers_sasl` listed in the **Service credentials** that you created. | |||
| Use the `kafka_brokers_sasl` from the **Service credentials** created in Step 2. We recommend using only one of the `kafka_brokers_sasl` at first and then growing to multiple brokers later, this makes running the samples much simpler however it is important to use all the `kafka_brokers_sasl` in your production workloads | |||
There was a problem hiding this comment.
Hi @Gorgonx7, what's your thinking behind this recommendation? Is it that the kafka_brokers_sasl property is annoying to combine into the right format? If so, I think the recommendation should be to use the (new-ish) bootstrap_endpoints property - which is already formatted in an appropriate way.
I'm reluctant to suggest "only use a single bootstrap endpoint", even for initial testing, as I think it is something that's easily forgotten about (at least until it becomes a problem).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This should make it a bit clearer about how to run these samples locally