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

Add user documentation for KEP-2937 to website #3175

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dgrove-oss
Copy link
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Adds user-facing documentation on configurable resource transformations (KEP-2937) to website

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

I'm putting NONE for the release note, because #3026 which is the implementation PR contains the release note text.

Written under the assumption that we'll be merge 3026 in time to make 0.9.

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 1, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: dgrove-oss
Once this PR has been reviewed and has the lgtm label, please assign moficodes for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 1, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @dgrove-oss. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

Copy link

netlify bot commented Oct 1, 2024

Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit 89b087e
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/671299865b1a5f000704592c
😎 Deploy Preview https://deploy-preview-3175--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/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 1, 2024
@mbobrovskyi
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 3, 2024
@kannon92
Copy link
Contributor

Waiting on #3026.

/hold

Doc looks good to me though.

@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 Oct 14, 2024
@tenzen-y
Copy link
Member

/cc

@mimowo
Copy link
Contributor

mimowo commented Oct 18, 2024

/hold cancel
the impl is merged

@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 Oct 18, 2024
Copy link
Contributor

@mimowo mimowo left a comment

Choose a reason for hiding this comment

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

Please also explain the role of the WorkloadResourceRequestsSummary, and I would suggest it as a recommendation to provide visibility into the summary of the resources.

@dgrove-oss
Copy link
Contributor Author

dgrove-oss commented Oct 18, 2024

I expanded the example of troubleshooting a pending Job to show resourceRequests.

I thought about showing two yaml blocks; one with the feature enabled and one without (ie, what was there before), but it seemed like overkill. I could easily change it if that is preferred though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. 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
Development

Successfully merging this pull request may close these issues.

6 participants