docs: add note for confiservice and adminservice #5355
Conversation
dosubot
bot
added
the
size:S
WalkthroughThis pull request updates the distributed deployment guides in both the English and Chinese documentation. It adds clarifying notes on the default registration ports for Changes
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/en/deployment/distributed-deployment-guide.md (1)
125-132: JVM System Property Example Update:
The examples for setting thehomePageUrlnow correctly reflect the distinct default ports for each service. The configuration forapollo-configserviceon port 8080 and forapollo-adminserviceon port 8090 is clear. For additional clarity, you might consider adding brief inline comments (e.g., “# Config service URL” and “# Admin service URL”) next to each URL.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/deployment/distributed-deployment-guide.md(1 hunks)docs/zh/deployment/distributed-deployment-guide.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build (8)
🔇 Additional comments (5)
docs/en/deployment/distributed-deployment-guide.md (2)
120-121: Clarifying Note Addition:
The newly added note clearly states that the default registration ports forapollo-configserviceandapollo-adminserviceare 8080 and 8090 respectively. This directly addresses the PR’s objective to prevent confusion during configuration.
137-144: OS Environment Variable Example Update:
The OS Environment Variable examples are updated consistently with the JVM examples, specifying port 8080 forapollo-configserviceand port 8090 forapollo-adminservice. The clarity and consistency across examples improve the documentation significantly.docs/zh/deployment/distributed-deployment-guide.md (3)
120-121: Clarifying Note for Default Ports Added
The inserted note clearly informs users that the default registration ports forapollo-configserviceandapollo-adminserviceare 8080 and 8090 respectively. This clarification is very useful to prevent configuration errors during deployment.
125-133: JVM System Property Examples Updated
The examples for setting JVM system properties now explicitly differentiate between the two services. By using the correct port in the property value for-Deureka.instance.homePageUrl(8080 forapollo-configserviceand 8090 forapollo-adminservice), the documentation now provides clear guidance. The usage and formatting appear correct and consistent.
137-145: OS Environment Variable Examples Updated
The revised OS environment variable examples mirror the JVM examples by clearly assigning the appropriate home page URLs for each service. This ensures users set the values correctly when configuring via environment variables, thus reducing potential misconfigurations.
|
I have read the CLA Document and I hereby sign the CLA |
What's the purpose of this PR
优化分布式环境搭建文档
Which issue(s) this PR fixes:
Fixes #5348
Brief changelog
修改分分布式搭建文档，提醒用户apollo-configservice 和 apollo-adminservice注册端口不一样
Follow this checklist to help us incorporate your contribution quickly and easily:
mvn clean testto make sure this pull request doesn't break anything.CHANGESlog.Summary by CodeRabbit