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

Publish JobSet API reference #566

Closed
mimowo opened this issue May 9, 2024 · 10 comments
Closed

Publish JobSet API reference #566

mimowo opened this issue May 9, 2024 · 10 comments
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@mimowo
Copy link
Contributor

mimowo commented May 9, 2024

What would you like to be added:

API reference for the JobSet API. Similarly as for Kueue: https://kueue.sigs.k8s.io/docs/reference/kueue.v1beta1/

Why is this needed:

So that we can easily reference JobSet API from the Kueue project.

@danielvegamyhre danielvegamyhre added documentation Improvements or additions to documentation good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. and removed documentation Improvements or additions to documentation labels May 12, 2024
@danielvegamyhre
Copy link
Contributor

@mimowo is this auto-generated in Kueue?

@mimowo
Copy link
Contributor Author

mimowo commented May 13, 2024

yes, it is done by the generate-apiref goal

@sandipanpanda
Copy link
Member

Hi, I am interested in working on this to familiarize myself with this sub-project. As this is a good first issue, can you provide some context and the recommended solution?

/assign

@sandipanpanda
Copy link
Member

@danielvegamyhre
Copy link
Contributor

@sandipanpanda Sure, it would be great if you want to work on this. As a starting point, take a look at how Kueue generates api reference here and see if we can do the same thing in JobSet.

@danielvegamyhre
Copy link
Contributor

@sandipanpanda are you still working on this?

@googs1025
Copy link
Member

If this issue is free, I will take it. After #594 merge

@ahg-g
Copy link
Contributor

ahg-g commented Jun 30, 2024

/assign @googs1025

Thanks!

@googs1025
Copy link
Member

/close
#611 fixed this issue

@k8s-ci-robot
Copy link
Contributor

@googs1025: Closing this issue.

In response to this:

/close
#611 fixed this issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Development

No branches or pull requests

6 participants