Skip to content

Add FairsharingStatus API documentation to Cohort and ClusterQueue #4708

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
Merged
merged 1 commit into from
Mar 24, 2025
Merged

Add FairsharingStatus API documentation to Cohort and ClusterQueue #4708

merged 1 commit into from
Mar 24, 2025
+43 −18

Conversation

tenzen-y
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it:

I added FairSharingStatus API documentation to Cohort and ClusterQueue APsI.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

@tenzen-y
Add FairsharingStatus API documentation to Cohort and ClusterQueue

Verified

This commit was signed with the committer’s verified signature.
Josh-Cena Joshua Chen
GPG key ID: C37145B818BDB68F
Verified
Learn about vigilant mode
Loading
Loading status checks…
e95f6d6 
Signed-off-by: Yuki Iwai <yuki.iwai.tz@gmail.com>
@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. labels Mar 20, 2025
@k8s-ci-robot k8s-ci-robot requested review from kannon92 and mimowo March 20, 2025 11:12
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 20, 2025
@tenzen-y
Copy link
Member Author

/assign @gabesaba
/hold
until v0.11.0

@netlify Netlify
Copy link

netlify bot commented Mar 20, 2025 •
edited
Loading

✅ Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit e95f6d6
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/67dbf7fd61c4810008e65738
😎 Deploy Preview https://deploy-preview-4708--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 do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 20, 2025
@mimowo
Copy link
Contributor

mimowo commented Mar 20, 2025

/milestone v0.12

@k8s-ci-robot k8s-ci-robot added this to the v0.12 milestone Mar 20, 2025
@gabesaba
Copy link
Contributor

We need to revise #4612 then

I wonder if there is a way to configure ^, so that it will also generate this documentation..

@tenzen-y
Copy link
Member Author

We need to revise #4612 then

I wonder if there is a way to configure ^, so that it will also generate this documentation..

The problem is currently, no description...
Screenshot 2025-03-21 at 0 08 20

@tenzen-y
Copy link
Member Author

We need to revise #4612 then
I wonder if there is a way to configure ^, so that it will also generate this documentation..

The problem is currently, no description... Screenshot 2025-03-21 at 0 08 20

@gabesaba Do you have alternative solutions? Currently, API comments in typed are not displayed in the API documentation.
Additionally, the above typed link does not work.

So, if we do not have alternative solutions, we want to add them to each field.

@mimowo
Copy link
Contributor

mimowo commented Mar 24, 2025

/unhold
the release is out

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 24, 2025
@mimowo
Copy link
Contributor

mimowo commented Mar 24, 2025

/lgtm
/approve
/cherry-pick website

@k8s-infra-cherrypick-robot
Copy link
Contributor

@mimowo: 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-sigs/prow repository.

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mimowo, tenzen-y

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
Copy link
Contributor

LGTM label has been added.

Git tree hash: 9468f34b5053baa701060eb05ddb9037693f4fc6

@mimowo
Copy link
Contributor

mimowo commented Mar 24, 2025

We can address #4708 (comment) in a follow up if we have a better idea.

@k8s-ci-robot k8s-ci-robot merged commit 5b47872 into kubernetes-sigs:main Mar 24, 2025
19 of 21 checks passed
@k8s-infra-cherrypick-robot
Copy link
Contributor

@mimowo: new pull request created: #4764

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-sigs/prow repository.

@k8s-infra-cherrypick-robot k8s-infra-cherrypick-robot mentioned this pull request Mar 24, 2025
Merged
@tenzen-y tenzen-y deleted the add-cohort-status-api-documentation branch March 24, 2025 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kannon92 kannon92

@mimowo mimowo

Assignees

@mimowo mimowo

@gabesaba gabesaba

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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v0.12
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@tenzen-y @mimowo @gabesaba @k8s-infra-cherrypick-robot @k8s-ci-robot