-
Notifications
You must be signed in to change notification settings - Fork 440
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] Update release docs #1621
Conversation
@@ -35,7 +35,7 @@ You can validate the charts as follows: | |||
# Install charts | |||
helm install kuberay-operator kuberay/kuberay-operator | |||
helm install kuberay-apiserver kuberay/kuberay-apiserver | |||
helm install ray-cluster kuberay/ray-cluster | |||
helm install raycluster kuberay/ray-cluster |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Almost all KubeRay docs use helm install raycluster
instead of helm install ray-cluster
.
@@ -77,24 +77,24 @@ You will be prompted for a commit reference and an image tag. The commit referen | |||
* The [image release CI pipeline](https://github.com/ray-project/kuberay/blob/master/.github/workflows/image-release.yaml) also publishes the `github.com/ray-project/kuberay/[email protected]` Go module. KubeRay has supported Go modules since v0.6.0. Follow these instructions to verify the Go module installation. | |||
```sh | |||
# Install the module. This step is highly possible to fail because the module is not available in the proxy server. | |||
go install github.com/ray-project/kuberay/ray-operator@v0.5.0-rc.0 | |||
go install github.com/ray-project/kuberay/ray-operator@v1.0.0-rc.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is weird that we say "KubeRay has supported Go modules since v0.6.0", but use v0.5.0-rc.0 as an example.
``` | ||
|
||
* Release rc0 Helm charts following the [instructions](../release/helm-chart.md). | ||
|
||
* Open a PR into the Ray repo updating the operator version used in the autoscaler integration test. Make any adjustments necessary for the test to pass ([example](https://github.com/ray-project/ray/pull/33987)). Make sure the test labelled [kubernetes-operator](https://buildkite.com/ray-project/oss-ci-build-pr/builds/17146#01873a69-5ccf-4c71-b06c-ae3a4dd9aecb) passes before merging. | ||
* Open a PR into the Ray repo updating the operator version used in the autoscaler integration test. Make any adjustments necessary for the test to pass ([example](https://github.com/ray-project/ray/pull/40918)). Make sure the test labelled [kubernetes-operator](https://buildkite.com/ray-project/oss-ci-build-pr/builds/17146#01873a69-5ccf-4c71-b06c-ae3a4dd9aecb) passes before merging. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is one more place in the Ray repo that needs to be updated, so I updated the reference link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, appreciate the explanations!
Why are these changes needed?
Related issue number
Checks