Skip to content

fix java sdk doc#5427

Merged
nobodyiam merged 2 commits intoapolloconfig:masterfrom
shalk:fix-java-sdk-doc
Jul 13, 2025
Merged

fix java sdk doc#5427
nobodyiam merged 2 commits intoapolloconfig:masterfrom
shalk:fix-java-sdk-doc

Conversation

@shalk
Copy link
Contributor

@shalk shalk commented Jul 10, 2025

What's the purpose of this PR

XXXXX

Which issue(s) this PR fixes:

Fixes #

Brief changelog

XXXXX

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Read the Contributing Guide before making this pull request.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit tests to verify the code.
  • Run mvn clean test to make sure this pull request doesn't break anything.
  • Update the CHANGES log.

Summary by CodeRabbit

  • Documentation
    • Updated several URLs in the Java SDK user guide to reference the correct repository and branch for source code and test examples.

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Jul 10, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 10, 2025

Walkthrough

The documentation was updated to correct several URLs, redirecting references from the old Apollo repository to the new apollo-java repository for Java SDK source code and test example links. No functional or logical documentation content was changed; only the URLs were modified.

Changes

File(s) Change Summary
docs/zh/client/java-sdk-user-guide.md Updated repository URLs for Java SDK source code and test examples.

Suggested labels

lgtm

Suggested reviewers

  • nobodyiam

Poem

In the garden of docs, a hop and a leap,
URLs corrected, no secrets to keep.
From old to new, the links now align,
The Java SDK shines, everything’s fine.
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6a35fa4 and 4e09819.

📒 Files selected for processing (1)
  • docs/zh/client/java-sdk-user-guide.md (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/zh/client/java-sdk-user-guide.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build (8)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions
Copy link

github-actions bot commented Jul 10, 2025

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 74f0152 and 2972195.

📒 Files selected for processing (1)
  • docs/zh/client/java-sdk-user-guide.md (2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: youngzil
PR: apolloconfig/apollo#5262
File: docs/en/client/java-sdk-user-guide.md:1108-1112
Timestamp: 2024-10-26T15:04:39.631Z
Learning: In `docs/en/client/java-sdk-user-guide.md`, the Eureka client configuration properties such as `eureka.client.serviceUrl.defaultZone`, `eureka.client.healthcheck.enabled`, `eureka.client.registerWithEureka`, `eureka.client.fetchRegistry`, and `eureka.client.eurekaServiceUrlPollIntervalSeconds` cannot be changed to kebab-case and must remain in their original camelCase form.
Learnt from: youngzil
PR: apolloconfig/apollo#5262
File: docs/zh/client/java-sdk-user-guide.md:1054-1060
Timestamp: 2024-10-26T14:54:04.074Z
Learning: Within the `application.properties` file in `docs/zh/client/java-sdk-user-guide.md`, the `eureka.client.serviceUrl.defaultZone` and related Eureka client properties should remain in their existing camelCase format and should not be converted to kebab-case, as they cannot be changed.
docs/zh/client/java-sdk-user-guide.md (2)
Learnt from: youngzil
PR: apolloconfig/apollo#5262
File: docs/en/client/java-sdk-user-guide.md:1108-1112
Timestamp: 2024-10-26T15:04:39.631Z
Learning: In `docs/en/client/java-sdk-user-guide.md`, the Eureka client configuration properties such as `eureka.client.serviceUrl.defaultZone`, `eureka.client.healthcheck.enabled`, `eureka.client.registerWithEureka`, `eureka.client.fetchRegistry`, and `eureka.client.eurekaServiceUrlPollIntervalSeconds` cannot be changed to kebab-case and must remain in their original camelCase form.
Learnt from: youngzil
PR: apolloconfig/apollo#5262
File: docs/zh/client/java-sdk-user-guide.md:1054-1060
Timestamp: 2024-10-26T14:54:04.074Z
Learning: Within the `application.properties` file in `docs/zh/client/java-sdk-user-guide.md`, the `eureka.client.serviceUrl.defaultZone` and related Eureka client properties should remain in their existing camelCase format and should not be converted to kebab-case, as they cannot be changed.
🪛 markdownlint-cli2 (0.17.2)
docs/zh/client/java-sdk-user-guide.md

1377-1377: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build (8)
🔇 Additional comments (2)
docs/zh/client/java-sdk-user-guide.md (2)

108-108: URL update looks good

链接已正确指向 apollo-java 仓库中的 MetaServerProvider.java,语法无误。


116-116: Both reference links resolve correctly

LegacyMetaServerProviderDefaultMetaServerProvider 的新 URL 均指向 apollo-java 仓库且格式正确。

@shalk
Copy link
Contributor Author

shalk commented Jul 10, 2025

I have read the CLA Document and I hereby sign the CLA

Copy link
Member

@hezhangjian hezhangjian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jul 10, 2025
@nobodyiam nobodyiam merged commit 3ca217f into apolloconfig:master Jul 13, 2025
8 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jul 13, 2025
@nobodyiam nobodyiam added this to the 2.5.0 milestone Feb 19, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants