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 documention link in readme #247

Merged
merged 2 commits into from
May 5, 2022

Conversation

simon-mo
Copy link
Collaborator

@simon-mo simon-mo commented May 5, 2022

Why are these changes needed?

Add the documentation link from repo readme, otherwise it is really hard to find it.

Related issue number

Checks

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

README.md Outdated
@@ -15,6 +15,10 @@ KubeRay provides several tools to improve running and managing Ray's experience
- Kubernetes event dumper for ray clusters/pod/services (future work)
- Operator Integration with Kubernetes node problem detector (future work)

## Documentation

You can view detailed documentation and guides at [https://github.com/ray-project/kuberay](https://github.com/ray-project/kuberay)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do you like to link to https://ray-project.github.io/kuberay/? or just github home page?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

opps nice catch!

@Jeffwan Jeffwan merged commit c146d25 into ray-project:master May 5, 2022
lowang-bh pushed a commit to lowang-bh/kuberay that referenced this pull request Sep 24, 2023
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.

2 participants