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

[Doc] Create a table for YAML and who refers to it #3136

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

nadongjun
Copy link
Contributor

Why are these changes needed?

#3050 This PR adds a reference table for all YAML files used in the KubeRay project. The table clearly shows the path, description, reference documents, branch/tag information, and dependencies for each YAML file.

Related issue number

Closes #3050

Checks

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

@kevin85421
Copy link
Member

Sorry, I wasn't clear enough in #3050. What I meant was to create a table for the YAML files under ray-operator/config/samples and to show which YAML is referenced by the docs on the Ray website.

For example, ray-job.sample.yaml is referenced in rayjob-quick-start.md?

@kevin85421
Copy link
Member

Btw, if you are interested in contributing, you can join our bi-weekly sync. This is the Google calendar: https://calendar.google.com/calendar/u/0?cid=Y19iZWIwYTUxZDQyZTczMTFmZWFmYTY5YjZiOTY1NjAxMTQ3ZTEzOTAxZWE0ZGU5YzA1NjFlZWQ5OTljY2FiOWM4QGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20

@kevin85421 kevin85421 self-assigned this Mar 2, 2025
@nadongjun
Copy link
Contributor Author

@kevin85421 Thanks for the clarification! I'll review it and make the necessary updates. The bi-weekly sync sounds interesting—I’ll join when I can.

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.

Create a table for YAML and who refers to it
2 participants