Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc][KubeRay] Update RayJob doc #42790

Merged
merged 2 commits into from
Jan 30, 2024

Conversation

kevin85421
Copy link
Member

@kevin85421 kevin85421 commented Jan 29, 2024

Why are these changes needed?

Update the documentation for the KubeRay v1.1.0 release. Additionally, this PR adds a new section to demonstrate how the KubeRay operator cleans up computing resources after the Ray job finishes.

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Kai-Hsun Chen <[email protected]>
Copy link
Contributor

@architkulkarni architkulkarni left a comment

Choose a reason for hiding this comment

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

Nice! Can you add a brief PR description?

Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

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

Nice use of active voice and removing extraneous words like "please"!
I had some additional nits. Let me know if you have questions.

@angelinalg
Copy link
Contributor

One general comment: I find the terms RayJob and Ray job to be confusing. In addition, in the observability docs, we have the convention of capitalize Ray Job to distinguish it from the more common term of job. In this case, capitalizing Ray Job would add to the confusion. At some point, we should think about names that are less similar to reduce confusion for our readers.

Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
@architkulkarni architkulkarni merged commit c1aaaa3 into ray-project:master Jan 30, 2024
9 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.

3 participants