Publish JobSet API reference

[mimowo]

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]

@mimowo is this auto-generated in Kueue?

[mimowo]

yes, it is done by the generate-apiref goal

[sandipanpanda]

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]

Can this tool be used? https://github.com/ahmetb/gen-crd-api-reference-docs

[danielvegamyhre]

@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]

@sandipanpanda are you still working on this?

[googs1025]

If this issue is free, I will take it. After https://github.com/kubernetes-sigs/jobset/pull/594 merge

[ahg-g]

/assign @googs1025

Thanks!

[googs1025]

/close https://github.com/kubernetes-sigs/jobset/pull/611 fixed this issue

[k8s-ci-robot]

@googs1025: Closing this issue.

In response to this:

/close https://github.com/kubernetes-sigs/jobset/pull/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.