[Docs][KubeRay] Fix RayJob quickstart doc step 9 error #53887
Merged
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
MortalHappiness
requested review from
pcmoritz,
kevin85421 and
a team
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an error in the RayJob quickstart documentation by updating step 9 to ignore output from deleted clusters.
- Updated notebook cell metadata to include "remove-output" and "nbval-ignore-output" tags
- Ensures the expected output (i.e., no RayClusters displayed) without affecting test coverage
Signed-off-by: Chi-Sheng Liu <chishengliu@chishengliu.com>
MortalHappiness
force-pushed
the
docs/kuberay-rayjob-quickstart-step-9-error
branch
from
11b8a48 to
af4475a
Compare
kevin85421
reviewed
Jun 17, 2025
| "rayjob-sample-raycluster-7965c-small-group-worker-nlzwx 1/1 Running 0 117s\n", | ||
| "rayjob-sample-74pmj 1/1 Running 0 2s\n" | ||
| "kuberay-operator-6bc45dd644-lc45k 1/1 Running 0 81s\n", | ||
| "rayjob-sample-raycluster-jbd9q-head-66cgd 1/1 Running 0 58s\n", |
There was a problem hiding this comment.
Do you use v1.4? In my memory, the head should not have suffix 66cgd if you use v1.4.
There was a problem hiding this comment.
There is another PR to update the KubeRay version for doctests and then rerun them all. But it needs to wait for the formal release to use 1.4.0 version.
kevin85421
approved these changes
Jun 18, 2025
minerharry
pushed a commit
to minerharry/ray
that referenced
this pull request
Jun 27, 2025
…3887) Signed-off-by: Chi-Sheng Liu <chishengliu@chishengliu.com>
elliot-barn
pushed a commit
that referenced
this pull request
Jul 2, 2025
Signed-off-by: Chi-Sheng Liu <chishengliu@chishengliu.com> Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why are these changes needed?
Step 9 should show no RayClusters. It shows one cluster because it is still being deleted, but we didn't wait for it.
This PR added one ignored cell, polling wait for the RayCluster being deleted.
I've already rerun the whole jupyter notebook.
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.