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.

Sign up for GitHub

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

Jump to bottom

[docs] Generate API docs. #1263

Merged
merged 3 commits into from
Oct 27, 2023
Merged

[docs] Generate API docs. #1263

merged 3 commits into from
Oct 27, 2023

Conversation

trasc
Copy link
Contributor

@trasc trasc commented Oct 26, 2023 •
edited by alculquicondor
Loading

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Generate and publish API reference documentation for Kueue.

Which issue(s) this PR fixes:

Fixes #1249

Special notes for your reviewer:

There is a PR

that will improve the output for map types.

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 26, 2023
@k8s-ci-robot k8s-ci-robot requested a review from ahg-g October 26, 2023 08:07
@netlify
Copy link

netlify bot commented Oct 26, 2023 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit ed69983
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/653ba5179ac0a30008cb11e0
😎 Deploy Preview https://deploy-preview-1263--kubernetes-sigs-kueue.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@k8s-ci-robot k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Oct 26, 2023
alculquicondor
alculquicondor reviewed Oct 26, 2023
View reviewed changes
Copy link
Contributor

@alculquicondor alculquicondor left a comment •
edited
Loading

Choose a reason for hiding this comment

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

It looks like the site generation failed, but it might be a fluke. Maybe amend or add a commit?

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
site/static/ref/kueue.v1beta1.md Outdated Show resolved Hide resolved
@alculquicondor
Copy link
Contributor

/lgtm
/approve
/cherry-pick website

@k8s-infra-cherrypick-robot
Copy link
Contributor

@alculquicondor: once the present PR merges, I will cherry-pick it on top of website in a new PR and assign it to you.

In response to this:

/lgtm
/approve
/cherry-pick website

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/test-infra repository.

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

LGTM label has been added.

Git tree hash: 19221adb58f7a85d75dd022548508d1cf94b1c78

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alculquicondor, trasc

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 Oct 27, 2023
@k8s-ci-robot k8s-ci-robot merged commit 32d15ec into kubernetes-sigs:main Oct 27, 2023
3 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v0.6 milestone Oct 27, 2023
@k8s-infra-cherrypick-robot
Copy link
Contributor

@alculquicondor: new pull request created: #1280

In response to this:

/lgtm
/approve
/cherry-pick website

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/test-infra repository.

@k8s-infra-cherrypick-robot k8s-infra-cherrypick-robot mentioned this pull request Oct 27, 2023
Merged
@trasc trasc deleted the gen-api-ref branch October 31, 2023 10:08
@googs1025 googs1025 mentioned this pull request Jul 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alculquicondor alculquicondor alculquicondor left review comments

@ahg-g ahg-g Awaiting requested review from ahg-g

@ArangoGutierrez ArangoGutierrez Awaiting requested review from ArangoGutierrez

Assignees

@alculquicondor alculquicondor

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. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
v0.6
Development

Successfully merging this pull request may close these issues.

Add pages with automatically generated API documentation
4 participants
@trasc @alculquicondor @k8s-infra-cherrypick-robot @k8s-ci-robot