Improved Explanation of Labels and Annotations #43178
Conversation
k8s-ci-robot
added
the
cncf-cla: no
|
Welcome @khubaibalam2000! |
k8s-ci-robot
added
the
size/XS
k8s-ci-robot
added
language/en
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
k8s-ci-robot
added
cncf-cla: yes
There was a problem hiding this comment.
@khubaibalam2000 Thank you for your contribution!
It appears that this PR includes changes to files across multiple languages ('en', 'zh'). However, docs follows different processes for each localization, and and we typically don't accept pull requests that impact multiple languages simultaneously. I would recommend modify only the primary website content (which means only English content) initially with this PR. After the merge of the English content, we could create separate pull request for the remaining languages. I hope this suggestion is helpful.
|
Yes, as you said, I have only made changes in the primary website content i.e. English content. |
|
@aj11anuj Thank you for pointing out this. In the new commit, I have revert it back to the original one. |
|
/remove-language zh |
| @@ -17,7 +17,8 @@ objects. Labels can be used to select objects and to find | |||
| collections of objects that satisfy certain conditions. In contrast, annotations | |||
| are not used to identify and select objects. The metadata | |||
| in an annotation can be small or large, structured or unstructured, and can | |||
| include characters not permitted by labels. | |||
| include characters not permitted by labels. It is also possible to use labels with | |||
| annotations to attach metadata to Kubernetes objects | |||
There was a problem hiding this comment.
- Missing period for the sentence.
- What do you mean by "use labels with annotations"?
There was a problem hiding this comment.
@tengqm Thank you for pointing out the mistake. I have added missing period for the sentence. Moreover, I have made the sentence more clearer in the latest commit. As mentioned in the issue #42524, we can use labels as well as annotations in metadata of same object. Therefore, I added a clearer sentence in the end of the paragraph.
|
/label tide/merge-method-squash |
k8s-ci-robot
added
the
tide/merge-method-squash
| @@ -17,7 +17,8 @@ objects. Labels can be used to select objects and to find | |||
| collections of objects that satisfy certain conditions. In contrast, annotations | |||
| are not used to identify and select objects. The metadata | |||
| in an annotation can be small or large, structured or unstructured, and can | |||
| include characters not permitted by labels. | |||
| include characters not permitted by labels. It is also possible to use labels as | |||
| well as annotations in metadata of same object. | |||
There was a problem hiding this comment.
| well as annotations in metadata of same object. | |
| well as annotations in the metadata of the same object. |
content/en/docs/concepts/overview/working-with-objects/annotations.md
Outdated
Show resolved
Hide resolved
|
@tengqm Thank You for your guidance. In the latest commit, I fixed those mistakes. You can review now. |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 251d76efacc80e7380d37f120056bdd20c561086
|
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sftim 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 |
k8s-ci-robot
added
the
approved
This Pull Request resolved the issue mentioned in #42524. I have added explanation and it makes clear that both labels and annotations can be used together.