docs:clarify prerequisites and external Zookeper setup #1275
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This pull request improves the documentation for Apache Dubbo Samples by clarifying the required prerequisites and explicitly documenting the use of an external ZooKeeper setup.
Previously, it was not clear whether the samples relied on an embedded ZooKeeper instance, which could cause confusion for new users. This change makes the setup process more explicit and easier to follow.
What’s Changed
Clarified required prerequisites (JDK, Maven, external ZooKeeper)
Explicitly stated that the samples do not rely on embedded ZooKeeper
Added step-by-step instructions to download and start a standard ZooKeeper distribution
Improved README clarity for running samples in a normal application setup
Why This Change Is Needed
Prevents confusion for first-time users running the samples
Aligns documentation with real-world usage and best practices
Makes the setup process clearer and more beginner-friendly
Scope of Change
Documentation-only change
No functional or behavioral changes to the codebase
Related Issue
Fixes #13847