search

ray-project / kuberay

A toolkit to run Ray applications on Kubernetes
Apache License 2.0
1.13k stars 365 forks source link

[Feature] Add API reference documentation for KubeRay custom resources #2247

Open andrewsykim opened 2 months ago

andrewsykim commented 2 months ago

Search before asking

Description

Right now there is no official documentation or reference to the KubeRay resources. To read the doc strings for a specific resource or API, you need to look at the Go types in the KubeRay repo which is not easily accessible or searchable.

It would be nice if there was online documentation that covered the API reference. See the Kubernetse API reference as one example: https://kubernetes.io/docs/reference/kubernetes-api/

Use case

Easily searchable page that shows API docs for RayCluster, RayJob and RayService.

Related issues

No response

Are you willing to submit a PR?

andrewsykim commented 2 months ago

@kevin85421 thoughts?

kevin85421 commented 2 months ago

https://github.com/ray-project/kuberay/blob/master/docs/reference/api.md?

andrewsykim commented 2 months ago

https://github.com/ray-project/kuberay/blob/master/docs/reference/api.md?

Thanks, I totally forgot about this. What do you think about making this content available in the Ray docs here: https://docs.ray.io/en/latest/cluster/kubernetes/references.html?

Right now docs/reference/api.md is not easily discoverable and doesn't come up in google search

andrewsykim commented 2 months ago

@kevin85421 is https://ray-project.github.io/kuberay/reference/api/ still maintained and updated? I had the impression this doc site was deprecated but it seems up to date.

kevin85421 commented 2 months ago

Add a step in the https://github.com/ray-project/kuberay/blob/master/docs/development/release.md to update the API reference in the Ray website.