Add more clarify on how reclaimWithinCohort interacts with fair sharing

[avrittrohwer]

What type of PR is this?

/kind documentation

What this PR does / why we need it:

1. Clarifies API docs for reclaimWithinCohort 'if the pending Workload fits within the nominal quota' wording.
2. Makes it more obvious in concept docs that fair sharing works in addition to the preemption policies set.

Which issue(s) this PR fixes:

Fixes #3286

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

[k8s-ci-robot]

Welcome @avrittrohwer!

It looks like this is your first PR to kubernetes-sigs/kueue 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kueue has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @avrittrohwer. 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.

Details

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.

[netlify]

✅ Deploy Preview for kubernetes-sigs-kueue ready!

Name	Link
🔨 Latest commit	d7cb3f2
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/67183efd4ee5340008c25c07
😎 Deploy Preview	https://deploy-preview-3287--kubernetes-sigs-kueue.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[alculquicondor]

/ok-to-test

[mimowo]

Thanks!
/lgtm
/approve

[k8s-ci-robot]

LGTM label has been added.

Details

Git tree hash: 086360139f6d83a4b8844e178561f49bc249d8a8

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: avrittrohwer, mimowo

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [mimowo]

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

[mimowo]

/cherry-pick website
As it might be useful for some users before 0.9 is released.

[k8s-infra-cherrypick-robot]

@mimowo: #3287 failed to apply on top of branch "website":

Applying: Add more clarify on how reclaimWithinCohort interacts with fair sharing
Applying: replace running with admitted
Applying: Update site/content/en/docs/reference/kueue.v1beta1.md
Applying: Update comments in clusterqueue_types.go, regenerate docs
Using index info to reconstruct a base tree...
M	apis/kueue/v1beta1/clusterqueue_types.go
M	charts/kueue/templates/crd/kueue.x-k8s.io_clusterqueues.yaml
M	config/components/crd/bases/kueue.x-k8s.io_clusterqueues.yaml
M	site/content/en/docs/reference/kueue.v1beta1.md
Falling back to patching base and 3-way merge...
Auto-merging site/content/en/docs/reference/kueue.v1beta1.md
CONFLICT (content): Merge conflict in site/content/en/docs/reference/kueue.v1beta1.md
Auto-merging config/components/crd/bases/kueue.x-k8s.io_clusterqueues.yaml
Auto-merging charts/kueue/templates/crd/kueue.x-k8s.io_clusterqueues.yaml
Auto-merging apis/kueue/v1beta1/clusterqueue_types.go
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0004 Update comments in clusterqueue_types.go, regenerate docs

Details

In response to this:

/cherry-pick website
As it might be useful for some users before 0.9 is released.

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.

[mimowo]

@avrittrohwer could you check if the conflicts are easily fixable, if so, then feel free to create the cherry-pick manually. You can use the script: ./hack/cherry_pick_pull.sh for that.

[avrittrohwer]

@avrittrohwer could you check if the conflicts are easily fixable, if so, then feel free to create the cherry-pick manually. You can use the script: ./hack/cherry_pick_pull.sh for that.

#3294