Added watch to glossary #47067

Ritikaa96 · 2024-07-02T12:47:35Z

Fixes: #47015
Added watch to glossary.

Signed-off-by: Ritikaa96 <[email protected]>

k8s-ci-robot · 2024-07-02T12:47:40Z

[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 princesso 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:

content/en/docs/OWNERS

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

Ritikaa96 · 2024-07-02T12:49:05Z

/kind feature
/wg api-expression

Ritikaa96 · 2024-07-02T12:49:31Z

I'll add the Usage in the second commit to keep the changes seperate.

netlify · 2024-07-02T12:50:23Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`530c394`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6686b3e84d5a9900087e0703
😎 Deploy Preview	https://deploy-preview-47067--kubernetes-io-main-staging.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.

sftim

Thanks. Watches are however not objects.

sftim · 2024-07-03T06:49:37Z

content/en/docs/reference/glossary/watch.md

+
+aka:
+tags:
+- core-object


Suggested change

- core-object

Watches are verbs, not objects.

Ah! yes . thanks for the correction.

sftim · 2024-07-03T06:49:39Z

content/en/docs/reference/glossary/watch.md

+
+<!--more-->
+
+A verb that is used to track changes to an object in Kubernetes as a stream. It is used for the excellent detection of changes when this request is made to Kubernetes API or when HTTP GET request is made with watch query.


(optionally)

Suggested change

A verb that is used to track changes to an object in Kubernetes as a stream. It is used for the excellent detection of changes when this request is made to Kubernetes API or when HTTP GET request is made with watch query.

A verb that is used to track changes to an object in Kubernetes as a stream. Watches allow

efficient detection of changes; for example, a

{{< glossary_tooltip term_id="controller" text="controller">}} that needs to know whenever a

ConfigMap has changed can use a watch rather than polling.

I guess an example will be beneficial. Thanks , I'll incorporate the changes.

sftim · 2024-07-03T06:50:44Z

Feel free to add another commit that makes an example use of this term.

Ritikaa96 · 2024-07-04T03:47:38Z

Feel free to add another commit that makes an example use of this term.

The most i have seen watch being used as a term in sentences is in API-Concepts page. In others it is in code-blocks etc. Just wanted to know is there any other page i need to make an edit with the glossary tooltip usage?

Ritikaa96 · 2024-07-04T14:33:27Z

Hi @sftim PTAL i added some changes and the examples for using it also.

Signed-off-by: Ritikaa96 <[email protected]>

Ritikaa96 · 2024-07-04T14:40:29Z

I have added the example use for the first occurrence of watch in every page. Hope that this help.

sftim

/lgtm

Definitely OK to merge as-is.
I have tweaks to suggest.

sftim · 2024-07-04T16:44:21Z

content/en/docs/reference/access-authn-authz/authorization.md

@@ -61,7 +61,7 @@ Kubernetes reviews only the following API request attributes:
 * **extra** - A map of arbitrary string keys to string values, provided by the authentication layer.
 * **API** - Indicates whether the request is for an API resource.
 * **Request path** - Path to miscellaneous non-resource endpoints like `/api` or `/healthz`.
- * **API request verb** - API verbs like `get`, `list`, `create`, `update`, `patch`, `watch`, `delete`, and `deletecollection` are used for resource requests. To determine the request verb for a resource API endpoint, see [request verbs and authorization](/docs/reference/access-authn-authz/authorization/#determine-the-request-verb).
+ * **API request verb** - API verbs like `get`, `list`, `create`, `update`, `patch`, `{{< glossary_tooltip text="watch" term_id="watch" >}}`, `delete`, and `deletecollection` are used for resource requests. To determine the request verb for a resource API endpoint, see [request verbs and authorization](/docs/reference/access-authn-authz/authorization/#determine-the-request-verb).


I wouldn't use the tooltip here.

Noted. Thanks for the review.

sftim · 2024-07-04T16:44:21Z

content/en/docs/concepts/workloads/controllers/deployment.md

@@ -813,7 +813,7 @@ apply multiple fixes in between pausing and resuming without triggering unnecess
  ```
  deployment.apps/nginx-deployment resumed
  ```
-* Watch the status of the rollout until it's done.
+* {{< glossary_tooltip text="Watch" term_id="watch" >}} the status of the rollout until it's done.
  ```shell
  kubectl get rs -w


(nit / optional extra)

Suggested change

kubectl get rs -w

kubectl get rs --watch

sftim · 2024-07-04T16:46:26Z

content/en/docs/reference/using-api/api-concepts.md

@@ -19,7 +19,7 @@ fine grained authorization (such as separate views for Pod details and
 log retrievals), and can accept and serve those resources in different
 representations for convenience or efficiency.

-Kubernetes supports efficient change notifications on resources via *watches*.
+Kubernetes supports efficient change notifications on resources via *{{< glossary_tooltip text="watches" term_id="watch" >}}*.


You can use the glossary definition here:

Suggested change

Kubernetes supports efficient change notifications on resources via *{{< glossary_tooltip text="watches" term_id="watch" >}}*.

Kubernetes supports efficient change notifications on resources via

_watches_:

{{< glossary_definition prepend="in the Kubernetes API, watch is an" term_id="watch" length="short" >}}

Alright. I'll add this.

sftim · 2024-07-04T16:46:40Z

content/en/docs/reference/access-authn-authz/certificate-signing-requests.md

@@ -406,7 +406,7 @@ the bundle with their own arbitrary but stable ordering.
 ClusterTrustBundle objects should be considered world-readable within the
 cluster. If your cluster uses [RBAC](/docs/reference/access-authn-authz/rbac/)
 authorization, all ServiceAccounts have a default grant that allows them to
-**get**, **list**, and **watch** all ClusterTrustBundle objects.
+**get**, **list**, and **{{< glossary_tooltip text="watch" term_id="watch" >}}** all ClusterTrustBundle objects.


I wouldn't use the tooltip here; it will make the verb look different from others and that may confuse readers more than it helps.

Ah.. ok . Noted

sftim · 2024-07-04T16:47:33Z

content/en/docs/concepts/overview/working-with-objects/labels.md

@@ -201,7 +201,7 @@ For example: `partition in (customerA, customerB),environment!=qa`.

 ### LIST and WATCH filtering

-LIST and WATCH operations may specify label selectors to filter the sets of objects
+LIST and {{< glossary_tooltip text="WATCH" term_id="watch" >}} operations may specify label selectors to filter the sets of objects


Suggested change

LIST and {{< glossary_tooltip text="WATCH" term_id="watch" >}} operations may specify label selectors to filter the sets of objects

For **list** and **watch** operations, you can specify label selectors to filter the sets of objects

ok . I'll remove the glossary tooltip from here as well.

sftim · 2024-07-04T16:48:55Z

content/en/docs/concepts/overview/working-with-objects/labels.md

@@ -201,7 +201,7 @@ For example: `partition in (customerA, customerB),environment!=qa`.

 ### LIST and WATCH filtering

-LIST and WATCH operations may specify label selectors to filter the sets of objects
+LIST and {{< glossary_tooltip text="WATCH" term_id="watch" >}} operations may specify label selectors to filter the sets of objects
 returned using a query parameter. Both requirements are permitted


Suggested change

returned using a query parameter. Both requirements are permitted

returned; you specify the filter using a query parameter.

(To learn in detail about watches in Kubernetes, read

[efficient detection of changes](/docs/reference/using-api/api-concepts/#efficient-detection-of-changes)).

Both kinds of requirement are permitted

k8s-ci-robot · 2024-07-04T16:51:07Z

LGTM label has been added.

Git tree hash: dc3b6ba8c8845275e4bbfb41590b976cd8756143

added watch to glossary

edafc07

Signed-off-by: Ritikaa96 <[email protected]>

k8s-ci-robot requested a review from dipesh-rawat July 2, 2024 12:47

k8s-ci-robot added the language/en Issues or PRs related to English language label Jul 2, 2024

k8s-ci-robot requested a review from nate-double-u July 2, 2024 12:47

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 2, 2024

Ritikaa96 mentioned this pull request Jul 2, 2024

Add “watch” to glossary #47015

Open

k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. wg/api-expression Categorizes an issue or PR as relevant to WG API Expression. labels Jul 2, 2024

sftim reviewed Jul 3, 2024

View reviewed changes

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 4, 2024

Adding glossary tooltip for watch in k/docs

530c394

Signed-off-by: Ritikaa96 <[email protected]>

Ritikaa96 force-pushed the glossary-add-watch branch from 848e148 to 530c394 Compare July 4, 2024 14:38

sftim reviewed Jul 4, 2024

View reviewed changes

k8s-ci-robot assigned sftim Jul 4, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added watch to glossary #47067

Added watch to glossary #47067

Ritikaa96 commented Jul 2, 2024

k8s-ci-robot commented Jul 2, 2024

Ritikaa96 commented Jul 2, 2024

Ritikaa96 commented Jul 2, 2024

netlify bot commented Jul 2, 2024 •

edited

Loading

sftim left a comment

sftim Jul 3, 2024

Ritikaa96 Jul 4, 2024

sftim Jul 3, 2024

Ritikaa96 Jul 4, 2024

sftim commented Jul 3, 2024

Ritikaa96 commented Jul 4, 2024

Ritikaa96 commented Jul 4, 2024

Ritikaa96 commented Jul 4, 2024

sftim left a comment

sftim Jul 4, 2024

Ritikaa96 Jul 5, 2024

sftim Jul 4, 2024

sftim Jul 4, 2024

Ritikaa96 Jul 5, 2024

sftim Jul 4, 2024

Ritikaa96 Jul 5, 2024

sftim Jul 4, 2024

Ritikaa96 Jul 5, 2024

sftim Jul 4, 2024

k8s-ci-robot commented Jul 4, 2024


		<!--more-->

		A verb that is used to track changes to an object in Kubernetes as a stream. It is used for the excellent detection of changes when this request is made to Kubernetes API or when HTTP GET request is made with watch query.

-A verb that is used to track changes to an object in Kubernetes as a stream. It is used for the excellent detection of changes when this request is made to Kubernetes API or when HTTP GET request is made with watch query.
+A verb that is used to track changes to an object in Kubernetes as a stream. Watches allow
+efficient detection of changes; for example, a
+{{< glossary_tooltip term_id="controller" text="controller">}} that needs to know whenever a
+ConfigMap has changed can use a watch rather than polling.

	LIST and {{< glossary_tooltip text="WATCH" term_id="watch" >}} operations may specify label selectors to filter the sets of objects
	For list and watch operations, you can specify label selectors to filter the sets of objects

-returned using a query parameter. Both requirements are permitted
+returned; you specify the filter using a query parameter.
+(To learn in detail about watches in Kubernetes, read
+[efficient detection of changes](/docs/reference/using-api/api-concepts/#efficient-detection-of-changes)).
+Both kinds of requirement are permitted

Added watch to glossary #47067

Are you sure you want to change the base?

Added watch to glossary #47067

Conversation

Ritikaa96 commented Jul 2, 2024

k8s-ci-robot commented Jul 2, 2024

Ritikaa96 commented Jul 2, 2024

Ritikaa96 commented Jul 2, 2024

netlify bot commented Jul 2, 2024 • edited Loading

✅ Pull request preview available for checking

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim commented Jul 3, 2024

Ritikaa96 commented Jul 4, 2024

Ritikaa96 commented Jul 4, 2024

Ritikaa96 commented Jul 4, 2024

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jul 4, 2024

netlify bot commented Jul 2, 2024 •

edited

Loading