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.

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

WIP: Document KEP 3157 (watch-list) for milestone 1.30 #45283

Closed
wants to merge 1 commit into from
Closed

WIP: Document KEP 3157 (watch-list) for milestone 1.30 #45283

wants to merge 1 commit into from

Conversation

p0lyn0mial
Copy link

@p0lyn0mial p0lyn0mial commented Feb 22, 2024 •
edited

TODO: Document WatchListClient as well.

@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 Feb 22, 2024
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 22, 2024
@netlify Netlify
Copy link

netlify bot commented Feb 22, 2024 •
edited

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 4c986ed
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/65d747d49ad89e0008617b2e
😎 Deploy Preview https://deploy-preview-45283--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.

@p0lyn0mial p0lyn0mial mentioned this pull request Feb 22, 2024
Open
8 tasks
p0lyn0mial
p0lyn0mial commented Feb 22, 2024
View reviewed changes
content/en/docs/reference/command-line-tools-reference/feature-gates/watch-list.md
---
Enable support for [streaming initial state of objects in watch requests](/docs/reference/using-api/api-concepts/#streaming-lists).
Enable support for [streaming initial state of objects in watch requests](/content/en/docs/reference/using-api/api-concepts.md/#streaming-lists).
Copy link
Author

Choose a reason for hiding this comment

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

the link was broken.

@p0lyn0mial p0lyn0mial changed the base branch from main to dev-1.30 February 22, 2024 13:06
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 22, 2024
@p0lyn0mial p0lyn0mial changed the base branch from dev-1.30 to main February 22, 2024 13:07
@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 Feb 22, 2024
@k8s-ci-robot k8s-ci-robot added area/blog Issues or PRs related to the Kubernetes Blog subproject language/hi Issues or PRs related to Hindi language language/zh Issues or PRs related to Chinese language labels Feb 22, 2024
@p0lyn0mial p0lyn0mial changed the base branch from main to dev-1.30 February 22, 2024 13:10
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 22, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign divya-mohan0209 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 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 Feb 22, 2024
@netlify Netlify
Copy link

netlify bot commented Feb 22, 2024

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

Name Link
🔨 Latest commit db02e3a
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/65d748a481c8e900088e077e

dipesh-rawat
dipesh-rawat reviewed Feb 23, 2024
View reviewed changes
content/en/docs/reference/command-line-tools-reference/feature-gates/watch-list.md
---
Enable support for [streaming initial state of objects in watch requests](/docs/reference/using-api/api-concepts/#streaming-lists).
Enable support for [streaming initial state of objects in watch requests](/content/en/docs/reference/using-api/api-concepts.md/#streaming-lists).
Copy link
Member

Choose a reason for hiding this comment

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

The suggested link update seems unnecessary and incorrect. The existing link works as expected when rendered on the website. I'm not sure if this update is needed.
Please check it out here: https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/ (check "WatchList" under the "List of feature gates" section).

The final redirection location is https://kubernetes.io/docs/reference/using-api/api-concepts/#streaming-lists.

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Enable support for [streaming initial state of objects in watch requests](/content/en/docs/reference/using-api/api-concepts.md/#streaming-lists).
Enable support for [streaming initial state of objects in watch requests](/docs/reference/using-api/api-concepts/#streaming-lists).

@dipesh-rawat
Copy link
Member

/remove-language zh
/remove-language hi

@k8s-ci-robot k8s-ci-robot removed language/zh Issues or PRs related to Chinese language language/hi Issues or PRs related to Hindi language labels Feb 23, 2024
sftim
sftim reviewed Feb 25, 2024
View reviewed changes
content/en/docs/reference/command-line-tools-reference/feature-gates/watch-list.md
@@ -9,5 +9,8 @@ stages:
- stage: alpha
defaultValue: false
fromVersion: "1.27"
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
fromVersion: "1.27"
fromVersion: "1.27"
toVersion: "1.29"

The website does not work out toVersion for you, you need to be explicit.

@Princesso
Copy link
Contributor

Hello @p0lyn0mial 👋 please take a look at Documenting for a release - PR Ready for Review to get your PR ready for review before Tuesday March 12th 2024 18:00 PST. Thank you!

@sftim
Copy link
Contributor

sftim commented Mar 14, 2024

/hold
pending assignment of publication date

/sig api-machinery

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. labels Mar 14, 2024
@p0lyn0mial
Copy link
Author

The streaming feature didn't make it to 1.30. Hopefully, the feature will be completed in the next release, and I will be able to update this PR.

@sftim
Copy link
Contributor

sftim commented Apr 8, 2024

/remove-area blog

I'll close the pull request. You are very welcome to open a new PR against the development branch for a future release (and to reuse the work you did here).

/close

@k8s-ci-robot k8s-ci-robot removed the area/blog Issues or PRs related to the Kubernetes Blog subproject label Apr 8, 2024
@k8s-ci-robot
Copy link
Contributor

@sftim: Closed this PR.

In response to this:

/remove-area blog

I'll close the pull request. You are very welcome to open a new PR against the development branch for a future release (and to reuse the work you did here).

/close

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/test-infra repository.

@drewhagen
Copy link
Member

Heads up that dev-1.31 branch is created now, if you choose to reopen this for the new release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dipesh-rawat dipesh-rawat dipesh-rawat left review comments

@sftim sftim sftim left review comments

@divya-mohan0209 divya-mohan0209 Awaiting requested review from divya-mohan0209

@shannonxtreme shannonxtreme Awaiting requested review from shannonxtreme

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. language/en Issues or PRs related to English language sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
1.30 Enhancements Tracking
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@p0lyn0mial @k8s-ci-robot @dipesh-rawat @Princesso @sftim @drewhagen