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

docs: add JobSet API reference #611

Merged
merged 2 commits into from
Jul 3, 2024

Conversation

googs1025
Copy link
Member

Fix issue: #566

How to generate documents:

root@VM-0-3-ubuntu:/home/ubuntu# cd jobset
root@VM-0-3-ubuntu:/home/ubuntu/jobset# export PATH=$PATH:/usr/local/bin/go/bin
root@VM-0-3-ubuntu:/home/ubuntu/jobset# make generate-apiref
make: go: Permission denied
cd /home/ubuntu/jobset/hack/genref/ && /home/ubuntu/jobset/bin/genref -o /home/ubuntu/jobset/site/content/en/docs/reference
I0701 10:24:47.111766 1227157 main.go:142] Parsing go packages in sigs.k8s.io/jobset/api/jobset/v1alpha2
I0701 10:24:50.923557 1227157 main.go:325] Output written to /home/ubuntu/jobset/site/content/en/docs/reference/jobset.v1alpha2.md
root@VM-0-3-ubuntu:/home/ubuntu/jobset# Connection to 43.132.121.119 closed by remote host.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 1, 2024
@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jul 1, 2024
Copy link

netlify bot commented Jul 1, 2024

Deploy Preview for kubernetes-sigs-jobset canceled.

Name Link
🔨 Latest commit 4bbf590
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-jobset/deploys/66827c5ad29b060009e9c9ef

hack/genref/markdown/members.tpl Show resolved Hide resolved
@@ -0,0 +1,19 @@
hiddenMemberFields:
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a comment with a link to the documentation for this config file, so we can easily figure out how to update it later if we need to?

Copy link
Member Author

Choose a reason for hiding this comment

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

i add this link,it allows users to query more configuration details

@googs1025
Copy link
Member Author

googs1025 commented Jul 1, 2024

API reference autogenerated based on this project: https://github.com/kubernetes-sigs/reference-docs/tree/master/genref

I do this PR reference from: kubernetes-sigs/kueue#1263

@danielvegamyhre
Copy link
Contributor

@googs1025 I checked out this PR and previewed the output docs locally, is the {#jobset-x-k8s-io-v1alpha2-JobSet} next to the JobSet expected?

image

@googs1025
Copy link
Member Author

googs1025 commented Jul 3, 2024

@danielvegamyhre I checked the API Reference of kueue and got the same result. This is the result of the automatic document generation.
here

image

@danielvegamyhre
Copy link
Contributor

/lgtm
/approve
Thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 3, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: danielvegamyhre, googs1025

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 3, 2024
@k8s-ci-robot k8s-ci-robot merged commit 0105ce5 into kubernetes-sigs:main Jul 3, 2024
13 checks passed
@danielvegamyhre danielvegamyhre mentioned this pull request Aug 19, 2024
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants