website icon indicating copy to clipboard operation
website copied to clipboard

KEP-4049: Add StorageCapacityScoring feature gate documents

Open cupnes opened this issue 9 months ago • 12 comments

Description

This PR updates existing documentation to include the addition of the StorageCapacityScoring feature gate of KEP-4049 as an alpha version.

Issue

  • https://github.com/kubernetes/enhancements/issues/4049

cupnes avatar Feb 17 '25 01:02 cupnes

Deploy Preview for kubernetes-io-vnext-staging processing.

Name Link
Latest commit 9ef3b682386b662d9d6d22f0156821d58c260ae8
Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/67f330b97ae557000902a35b

netlify[bot] avatar Feb 17 '25 01:02 netlify[bot]

I will add a commit about this comment. So, I created this PR as a draft.

cupnes avatar Feb 17 '25 01:02 cupnes

Pull request preview available for checking

Built without sensitive environment variables

Name Link
Latest commit 9ef3b682386b662d9d6d22f0156821d58c260ae8
Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67f330b99cc8c50008401d14
Deploy Preview https://deploy-preview-49801--kubernetes-io-main-staging.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.

netlify[bot] avatar Feb 17 '25 01:02 netlify[bot]

@sftim I understood. I will add the explanation.

cupnes avatar Mar 19 '25 00:03 cupnes

@cupnes I assume this doc PR is ready to review? Can you please remove "Draft" status? Thanks.

xing-yang avatar Mar 24 '25 15:03 xing-yang

@xing-yang I will address the comments from tengqm and sftim. Additionally, I will replace VolumeCapacityPriority with StorageCapacityScoring in the command documentation, such as kubelet.md, located at content/en/docs/reference/command-line-tools-reference/. (I'm currently working on this according to this document.) Therefore, I cannot remove the "Draft" status yet.

cupnes avatar Mar 25 '25 00:03 cupnes

@sftim I have updated the content to include your suggested points. Could you please review it again?

cupnes avatar Mar 25 '25 05:03 cupnes

@sftim @dipesh-rawat @tengqm @xing-yang I would like to replace the feature gate name VolumeCapacityPriority with StorageCapacityScoring in the following documents. These documents are automatically generated, and I believe the update procedure is described in this documentation. Is this correct? If so, the procedure in the documentation requires checking out a release tag from the kubernetes/kubernetes repository, but there is no v1.33.0 tag in kubernetes/kubernetes yet. Could you tell me what I should do?

  • https://github.com/kubernetes/website/blob/e63cc33fb676d06e9c71a4fc9d2ef9eb2c137f72/content/en/docs/reference/command-line-tools-reference/kube-apiserver.md?plain=1#L641C8715-L641C8725
  • https://github.com/kubernetes/website/blob/e63cc33fb676d06e9c71a4fc9d2ef9eb2c137f72/content/en/docs/reference/command-line-tools-reference/kube-controller-manager.md?plain=1#L505C8715-L505C8725
  • https://github.com/kubernetes/website/blob/e63cc33fb676d06e9c71a4fc9d2ef9eb2c137f72/content/en/docs/reference/command-line-tools-reference/kube-proxy.md?plain=1#L161C7830-L161C7840
  • https://github.com/kubernetes/website/blob/e63cc33fb676d06e9c71a4fc9d2ef9eb2c137f72/content/en/docs/reference/command-line-tools-reference/kube-scheduler.md?plain=1#L176C8715-L176C8725
  • https://github.com/kubernetes/website/blob/e63cc33fb676d06e9c71a4fc9d2ef9eb2c137f72/content/en/docs/reference/command-line-tools-reference/kubelet.md?plain=1#L492C0-L492C10

Additionally, I would like to reflect the changes I made in my kubernetes/kubernetes PR to the following documents. How should I proceed with this?

  • https://github.com/kubernetes-sigs/reference-docs/blob/096a94d6e7d0d04e41356f21233498c3c4e31699/genref/output/html/kube-scheduler-config.v1.html#L1629-L1641
  • https://github.com/kubernetes-sigs/reference-docs/blob/096a94d6e7d0d04e41356f21233498c3c4e31699/genref/output/html/kube-scheduler-config.v1beta2.html#L1126-L1138
  • https://github.com/kubernetes-sigs/reference-docs/blob/096a94d6e7d0d04e41356f21233498c3c4e31699/genref/output/html/kube-scheduler-config.v1beta3.html#L1066-L1078
  • https://github.com/kubernetes-sigs/reference-docs/blob/096a94d6e7d0d04e41356f21233498c3c4e31699/genref/output/md/kube-scheduler-config.v1.md#L554-L566
  • https://github.com/kubernetes/website/blob/ee29ab7ec88bf0b2df7734a0601293b4e28330b1/content/en/docs/reference/config-api/kube-scheduler-config.v1.md#L554-L566

cupnes avatar Mar 25 '25 05:03 cupnes

Hello @cupnes :wave: please take a look at Documenting for a release - PR Ready for Review to get your PR ready for review before Tuesday 25th March 2025 18:00 PDT. Thank you!

rayandas avatar Mar 25 '25 05:03 rayandas

@rayandas I understand. Since this PR has already received review comments, I have removed the Draft status.

cupnes avatar Mar 25 '25 05:03 cupnes

@sftim @dipesh-rawat @tengqm @xing-yang

After looking at the PR that updated documentation for VolumeCapacityPriority (KEP-1845), I noticed that it did not update the files I mentioned in my comment. I understand now that these files do not need to be updated by the KEP author. If so, please ignore my comment from two days ago.

I have already updated this PR based on the reviewers' feedback, so please continue with the review.

cupnes avatar Mar 27 '25 00:03 cupnes

@sftim @dipesh-rawat @tengqm @xing-yang How is the review going? If there are no problems, could you please remove the hold label and add the approved and lgtm labels?

cupnes avatar Apr 02 '25 08:04 cupnes

Hello @cupnes :wave:! I'm reaching out from the Docs team. Just checking in as we approach Docs Freeze on 8th April, 2025 18:00 PDT. This documentation appears to still be under review. To meet the Docs Freeze, this PR must have a technical review as well as lgtm and approve labels applied, without any unaddressed comments or concerns from SIG Docs. The status of this enhancement is marked as at risk for docs freeze. Thank you!

Urvashi0109 avatar Apr 03 '25 11:04 Urvashi0109

@sftim @dipesh-rawat @tengqm @xing-yang The Docs Freeze deadline is approaching, so please review this. If looks good, please remove the hold label and add the approved and lgtm labels. I probably won't be able to work from 4/4 9:00UTC to 4/7 0:00UTC.

cupnes avatar Apr 04 '25 00:04 cupnes

@tengqm The suggested changes were applied. This could another review. Thanks!

rayandas avatar Apr 07 '25 08:04 rayandas

/lgtm

tengqm avatar Apr 07 '25 10:04 tengqm

LGTM label has been added.

Git tree hash: 0438cc30765e7dff818ec6e6f2d72a3360f6361e

k8s-ci-robot avatar Apr 07 '25 10:04 k8s-ci-robot

This PR also requires a technical review. @xing-yang PTAL.

rayandas avatar Apr 07 '25 11:04 rayandas

/lgtm

xing-yang avatar Apr 07 '25 16:04 xing-yang

@tengqm @xing-yang Could you please also add the approved label? And could you remove the do-not-merge/hold label?

cupnes avatar Apr 08 '25 00:04 cupnes

Treating https://github.com/kubernetes/website/pull/49801#issuecomment-2783962422 as a tech lgtm, /approve

tengqm avatar Apr 08 '25 00:04 tengqm

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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 avatar Apr 08 '25 00:04 k8s-ci-robot

@tengqm @xing-yang Since you have added the approved and lgtm labels, I remove the do-not-merge/hold label. Thank you! /unhold

cupnes avatar Apr 08 '25 00:04 cupnes