search

kubernetes / kubectl

Issue tracker and mirror of kubectl code
Apache License 2.0
2.89k stars 924 forks source link

Unclear built-in help for `kubectl set` #1639

Closed Parkofadown closed 3 months ago

Parkofadown commented 3 months ago

Page is automatically generated As of 3:52 PM on 8/7/24 Synopsis states: Configure application resources. These commands help you make changes to existing application resources.

Recommend clarifying what application resources you can configure. Second sentence should be worded as: This command helps you make changes to existing application resources. Recommend adding an example usage field

Thanks, PARKOFADOWN

k8s-ci-robot commented 3 months 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.
steve-hardman commented 3 months ago

Related page for issue: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_set/

/language en

utkarsh-singh1 commented 3 months ago

@Parkofadown, please follow the templated either you are filling issue for bug or feature.

utkarsh-singh1 commented 3 months ago

Currrent description is filed is bit hard to understand.

utkarsh-singh1 commented 3 months ago

@Parkofadown, Can you clarify what changes you want to make changes to this docs.

Related page for issue: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_set/

utkarsh-singh1 commented 3 months ago

/triage needs-information

Parkofadown commented 3 months ago

@Parkofadown, Can you clarify what changes you want to make changes to this docs.

Related page for issue: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_set/

@utkarsh-singh1 You need to state what application resources are being changed. Re-read what I wrote in the original description. Also there is no example how to use this command

sftim commented 3 months ago

/transfer kubectl

sftim commented 3 months ago

/retitle Unclear built-in help for kubectl set

sftim commented 3 months ago

/sig cli docs

ah8ad3 commented 3 months ago

I think we talked about these documents few months ago in the SIG, i can't recall what was the decision. The team will see and triage it.

The doc on the command itself is more clear try: kubectl set -h @Parkofadown

ardaguclu commented 3 months ago

/close

k8s-ci-robot commented 3 months ago

@ardaguclu: Closing this issue.

In response to [this](https://github.com/kubernetes/kubectl/issues/1639#issuecomment-2289219400): >/close 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.