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

Add RayJob docs and development docs #404

Merged
merged 2 commits into from
Jul 25, 2022

Conversation

Jeffwan
Copy link
Collaborator

@Jeffwan Jeffwan commented Jul 24, 2022

part of #349

Why are these changes needed?

  • Add RayJob and development docs
  • make index doc cleaner and move to corresponding sections.

Testing

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Open localhost:8000

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests
    • This PR is not tested :(

@Jeffwan Jeffwan requested review from wilsonwang371, scarlet25151 and DmitriGekhtman and removed request for wilsonwang371 July 24, 2022 04:51
README.md Outdated Show resolved Hide resolved
docs/guidance/rayjob.md Outdated Show resolved Hide resolved

A RayService manages 2 things:
* RayCluster: Manages resources in kubernetes cluster.
* Ray Serve Deployment Graph: Manages users' serve deployment graph.
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should probably link to the Ray docs to explain what a Ray Serve Deployment Graph is.
cc @simon-mo @brucez-anyscale

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I originally copy some contents and structure from RayService and forget to clean them up. Now it's in good shape

@@ -0,0 +1,129 @@
## Ray Job (alpha)
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should explain what the operational difference is between a Ray Service and a Ray Job.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Add some details. The cluster can be deleted by RayJob controller once it succeed or failed

@DmitriGekhtman
Copy link
Collaborator

cc @harryge00

Copy link
Collaborator

@wilsonwang371 wilsonwang371 left a comment

Choose a reason for hiding this comment

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

lgtm

@Jeffwan
Copy link
Collaborator Author

Jeffwan commented Jul 25, 2022

@DmitriGekhtman @harryge00 Please have another check. it just have RayJob content now

@harryge00
Copy link
Contributor

lgtm

@Jeffwan Jeffwan merged commit de0b21c into ray-project:master Jul 25, 2022
@Jeffwan Jeffwan deleted the jiaxin/doc_update branch July 25, 2022 17:35
lowang-bh pushed a commit to lowang-bh/kuberay that referenced this pull request Sep 24, 2023
* Add RayJob docs and development docs

* Address code review feedbacks
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.

None yet

6 participants