diff --git a/docs/components/config/samples/config-map-ray-code.yaml b/docs/components/config/samples/config-map-ray-code.yaml new file mode 120000 index 0000000000..ed6972a36b --- /dev/null +++ b/docs/components/config/samples/config-map-ray-code.yaml @@ -0,0 +1 @@ +../../../../ray-operator/config/samples/config-map-ray-code.yaml \ No newline at end of file diff --git a/docs/components/config/samples/ray-cluster.complete.yaml b/docs/components/config/samples/ray-cluster.complete.yaml new file mode 120000 index 0000000000..d39a98d4d8 --- /dev/null +++ b/docs/components/config/samples/ray-cluster.complete.yaml @@ -0,0 +1 @@ +../../../../ray-operator/config/samples/ray-cluster.complete.yaml \ No newline at end of file diff --git a/docs/components/config/samples/ray-cluster.heterogeneous.yaml b/docs/components/config/samples/ray-cluster.heterogeneous.yaml new file mode 120000 index 0000000000..a6d7d2c246 --- /dev/null +++ b/docs/components/config/samples/ray-cluster.heterogeneous.yaml @@ -0,0 +1 @@ +../../../../ray-operator/config/samples/ray-cluster.heterogeneous.yaml \ No newline at end of file diff --git a/docs/components/config/samples/ray-cluster.mini.yaml b/docs/components/config/samples/ray-cluster.mini.yaml new file mode 120000 index 0000000000..664c2862e3 --- /dev/null +++ b/docs/components/config/samples/ray-cluster.mini.yaml @@ -0,0 +1 @@ +../../../../ray-operator/config/samples/ray-cluster.mini.yaml \ No newline at end of file diff --git a/docs/components/media/create-ray-cluster.gif b/docs/components/media/create-ray-cluster.gif new file mode 120000 index 0000000000..72cbdc29bc --- /dev/null +++ b/docs/components/media/create-ray-cluster.gif @@ -0,0 +1 @@ +../../../ray-operator/media/create-ray-cluster.gif \ No newline at end of file diff --git a/docs/components/media/logs-ray-cluster.gif b/docs/components/media/logs-ray-cluster.gif new file mode 120000 index 0000000000..82112986bc --- /dev/null +++ b/docs/components/media/logs-ray-cluster.gif @@ -0,0 +1 @@ +../../../ray-operator/media/logs-ray-cluster.gif \ No newline at end of file diff --git a/docs/components/media/overview.png b/docs/components/media/overview.png new file mode 120000 index 0000000000..d89fabcd39 --- /dev/null +++ b/docs/components/media/overview.png @@ -0,0 +1 @@ +../../../ray-operator/media/overview.png \ No newline at end of file diff --git a/docs/components/media/update-ray-cluster.gif b/docs/components/media/update-ray-cluster.gif new file mode 120000 index 0000000000..4d650244df --- /dev/null +++ b/docs/components/media/update-ray-cluster.gif @@ -0,0 +1 @@ +../../../ray-operator/media/update-ray-cluster.gif \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d4ad3522b5..92fdeba712 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ # Project Information -site_name: KubeRay +site_name: KubeRay Docs site_url: https://ray-project.github.io/kuberay # Repository @@ -36,6 +36,8 @@ nav: - Guidance: troubleshooting.md - Designs: - Core API and Backend Service: design/protobuf-grpc-service.md + - Development: + - Release: release/README.md # Customization extra: diff --git a/ray-operator/README.md b/ray-operator/README.md index ebd9d14354..4fdec91db5 100644 --- a/ray-operator/README.md +++ b/ray-operator/README.md @@ -35,7 +35,7 @@ You can update the number of replicas in a worker goup, and specify which exact ### Ray cluster example code -An example ray code is defined in this [configmap](msft-operator/ray-operator/config/samples/config-map-ray-code.yaml) that is mounted into the ray head-pod. By examining the logs of the head pod, we can see the list of the IP addresses of the nodes that joined the ray cluster: +An example ray code is defined in this [configmap](config/samples/config-map-ray-code.yaml) that is mounted into the ray head-pod. By examining the logs of the head pod, we can see the list of the IP addresses of the nodes that joined the ray cluster: ![](media/logs-ray-cluster.gif)