Skip to content

[improve][docs] Clarify Java client setup and Functions runtime requirements - #1237

Merged
lhotari merged 3 commits into
apache:mainfrom
lhotari:docs/java-client-setup-and-functions-guidance
Oct 1, 2026
Merged

lhotari merged 3 commits into
apache:mainfrom
lhotari:docs/java-client-setup-and-functions-guidance

Conversation

@lhotari

@lhotari lhotari commented Oct 1, 2026

Copy link
Copy Markdown
Member

Java client setup now links to a dedicated dependency configuration page with copyable Maven and Gradle builds. The guide explains the single unshaded dependency for the v4, v5, and admin clients, aligns Pulsar and Netty with BOMs, and documents exclusions, the shaded fallback, Spring Boot, and Gradle API/implementation separation.

Also:

  • Add a version-aware upgrade tip to the documentation portal and link release highlights to the Java dependency guide.
  • Add trusted-code warnings to Functions worker and runtime guides, and remove the obsolete Python protobuf installation instruction.
  • Refresh the 5.0.x documentation snapshot from the current docs; the regenerated version-specific sidebar is unchanged.

Validation:

  • Built the site with both current and 5.0.x documentation enabled; existing unrelated link warnings remain.
  • Compiled sample code against the v4, v5, and admin APIs using the documented Maven and Gradle builds, including the shaded fallback.
  • Verified that a Gradle consumer receives the public API artifacts without client implementations on its compile classpath.
  • Confirmed all 259 files in the 5.0.x snapshot match the current docs and ran git diff --check.

@lhotari
lhotari merged commit 154181e into apache:main Oct 1, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant