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 doc for ServiceNodePortStaticSubrange #39850

Merged
merged 1 commit into from
Mar 22, 2023

Conversation

xuzhenglun
Copy link
Contributor

@xuzhenglun xuzhenglun commented Mar 8, 2023

add doc for KEP 3668 kubernetes/enhancements#3668

add doc in service concepts page to describes the behavior of the new Feature ServiceNodePortStaticSubrange, and the problems it solves

@k8s-ci-robot k8s-ci-robot added this to the 1.27 milestone Mar 8, 2023
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 8, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Mar 8, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: xuzhenglun / name: Reficul (808ee08)

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 8, 2023
@k8s-ci-robot k8s-ci-robot requested a review from kinzhi March 8, 2023 02:53
@k8s-ci-robot k8s-ci-robot added the area/blog Issues or PRs related to the Kubernetes Blog subproject label Mar 8, 2023
@k8s-ci-robot k8s-ci-robot requested a review from sftim March 8, 2023 02:53
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language language/zh Issues or PRs related to Chinese language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Mar 8, 2023
@xuzhenglun xuzhenglun force-pushed the dev-1.27 branch 2 times, most recently from 56e08cf to 808ee08 Compare March 8, 2023 02:55
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 8, 2023
@windsonsea
Copy link
Member

/remove-language zh

@k8s-ci-robot k8s-ci-robot removed the language/zh Issues or PRs related to Chinese language label Mar 16, 2023
@mickeyboxell
Copy link
Contributor

@xuzhenglun It looks like this is marked as a Blog rather than a Docs PR. Could you rename the PR?

When you're ready, populate your placeholder PR with feature documentation and change the state of the PR from draft to ready for review. The official Docs deadline for PRs to be ready for review is tomorrow, March 21st. All docs PRs must be reviewed and ready to merge by April 4th. To mark a pull request as ready for review, navigate to the merge box and click Ready for review.

Regarding the content of your documentation, do your best to describe your feature and how to use it. If you need help structuring your documentation, ask in the #sig-docs Slack channel. For more information, please take a look at Documenting for a release to familiarize yourself with the documentation requirements for the release.

@xuzhenglun xuzhenglun force-pushed the dev-1.27 branch 3 times, most recently from d764298 to 4d8c9fe Compare March 21, 2023 18:48
@xuzhenglun xuzhenglun changed the title WIP blog post for KEP 3668: Reserve Nodeport Ranges For Dynamic And Static Port Allocation add blog post for ServiceNodePortStaticSubrange Mar 21, 2023
@xuzhenglun xuzhenglun marked this pull request as ready for review March 21, 2023 18:52
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 21, 2023
@k8s-ci-robot k8s-ci-robot removed the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 21, 2023
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 21, 2023
@xuzhenglun xuzhenglun force-pushed the dev-1.27 branch 2 times, most recently from c738b75 to 547e2be Compare March 21, 2023 18:59
@xuzhenglun xuzhenglun changed the title add blog post for ServiceNodePortStaticSubrange add doc and blog post for ServiceNodePortStaticSubrange Mar 21, 2023
@xuzhenglun
Copy link
Contributor Author

xuzhenglun commented Mar 21, 2023

@xuzhenglun It looks like this is marked as a Blog rather than a Docs PR. Could you rename the PR?

When you're ready, populate your placeholder PR with feature documentation and change the state of the PR from draft to ready for review. The official Docs deadline for PRs to be ready for review is tomorrow, March 21st. All docs PRs must be reviewed and ready to merge by April 4th. To mark a pull request as ready for review, navigate to the merge box and click Ready for review.

Regarding the content of your documentation, do your best to describe your feature and how to use it. If you need help structuring your documentation, ask in the #sig-docs Slack channel. For more information, please take a look at Documenting for a release to familiarize yourself with the documentation requirements for the release.

Thanks for replying! @mickeyboxell

Now that the title has been changed, I've added a new section to the Service concepts page to describe the feature and add an additional blog post to describe the details of the feature. But there are two things I'm not so sure about.

  1. whether the documentation is detailed enough for you, please let me know if there are any prombems.
  2. does the blog post require a separate PR to be turned on, or is this sufficient for now?

@mickeyboxell
Copy link
Contributor

@xuzhenglun typically docs PRs are separate from blog PRs and involve a separate set of reviewers (with some overlap). SIG Docs and reviewers from your SIG can help determine whether or not the docs are detailed enough.

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 22, 2023
@xuzhenglun
Copy link
Contributor Author

add blog and doc for KEP 3668 kubernetes/enhancements#3668

  1. add blog describes the behavior of the new Feature ServiceNodePortStaticSubrange, and the problems it solves, and shows some examples

thanks for your explanation, I have separated the blog into another PR #40204. Now, this PR should contain docs only.

@xuzhenglun xuzhenglun changed the title add doc and blog post for ServiceNodePortStaticSubrange add doc for ServiceNodePortStaticSubrange Mar 22, 2023
@xuzhenglun
Copy link
Contributor Author

/remove-area blog

@k8s-ci-robot k8s-ci-robot removed the area/blog Issues or PRs related to the Kubernetes Blog subproject label Mar 22, 2023
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 22, 2023
@tengqm
Copy link
Contributor

tengqm commented Mar 22, 2023

/approve

@k8s-ci-robot
Copy link
Contributor

[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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 22, 2023
@aojea
Copy link
Member

aojea commented Mar 22, 2023

/lgtm

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

LGTM label has been added.

Git tree hash: 801c7bafb0cdc691f18d4223cc8d5dd821b0a9f6

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
Status: Published
Development

Successfully merging this pull request may close these issues.

6 participants