Skip to content

[Doc] Fix docs for KubeRay v1.7 - #65513

Open
machichima wants to merge 2 commits into
ray-project:masterfrom
machichima:1.7-fix-docs
Open

[Doc] Fix docs for KubeRay v1.7#65513
machichima wants to merge 2 commits into
ray-project:masterfrom
machichima:1.7-fix-docs

Conversation

@machichima

Copy link
Copy Markdown
Contributor

Description

Found some bug in the docs while testing with v1.7.0-rc.0. This is the PR updating those docs.

  1. doc/source/cluster/kubernetes/user-guides/k8s-events.md: official ray image does not include kubernetes Python package
  2. doc/source/cluster/kubernetes/user-guides/network-policy.md: set a wrong field, should be networkPolicy

Related issues

Link related issues: "Fixes #1234", "Closes #1234", or "Related to #1234".

Additional information

Optional: Add implementation details, API changes, usage examples, screenshots, etc.

Signed-off-by: machichima <nary12321@gmail.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the Ray Kubernetes documentation, specifically clarifying the installation of the Kubernetes Python client for platform events and updating the Network Policy configuration example to use the correct networkPolicy structure. Feedback on the changes points out a contradiction in the platform events guide regarding whether official Ray images include the kubernetes package, which should be corrected to avoid misleading users.

Comment thread doc/source/cluster/kubernetes/user-guides/k8s-events.md
@ray-gardener ray-gardener Bot added docs An issue or change related to documentation core Issues that should be addressed in Ray Core community-contribution Contributed by the community labels Aug 16, 2026
@rueian rueian added the go add ONLY when ready to merge, run all tests label Aug 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Contributed by the community core Issues that should be addressed in Ray Core docs An issue or change related to documentation go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ray fails to serialize self-reference objects

2 participants