search

kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.37k stars 14.14k forks source link

Enhance `kubectl set image` documentation: Improve summary, add usage scenarios, and compare with `kubectl edit` #46813

Open agowa opened 1 month ago

agowa commented 1 month ago

Hi, currently the documentations only have little information regarding kubectl set image. It would be great if it could be extended with at least a quick summary and a comparison to using kubectl edit (or kubectl apply) in order to modify the image. E.g. upgrade nginx version.

Edit: This page: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_set/kubectl_set_image/

k8s-ci-robot commented 1 month ago

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
dipesh-rawat commented 1 month ago

/retitle Enhance kubectl set image documentation: Improve summary, add usage scenarios, and compare with kubectl edit /language en

dipesh-rawat commented 1 month ago

/kind feature

dipesh-rawat commented 1 month ago

@agowa Could you share the page(s) URL where you'd like to see these improvements added?

tengqm commented 1 month ago

/retitle Enhance kubectl set image documentation: Improve summary, add usage scenarios, and compare with kubectl edit /language en

Why do we keep changing issue/pr titles? Do we have a guideline on how to format the title of an issue or a PR? The revised title is so long. Is this change really needed?

I'm raising this question because I've been driven crazy by this kind of changes lately. When a PR or an issue has a title change, my Outlook email client cannot correctly identify "conversations" of discussion threads after the change. Each single response to the issue/PR then become a new email in my inbox. When the title was not changed, the email client can easily organize the discussions into neat conversations. I can quickly browse throw the so many notifications and kill them in batch.

agowa commented 1 month ago

https://kubernetes.io/docs/reference/kubectl/generated/kubectl_set/kubectl_set_image/