kubernetes / website

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

`kubectl explain` page has JSONPath identifier incorrectly generated #47080

Open Juneezee opened 5 days ago

Juneezee commented 5 days ago

In the Synopsis section of the auto-generated kubectl explain page (https://kubernetes.io/docs/reference/kubectl/generated/kubectl_explain/#synopsis), the JSONPath identifier is generated as

<type>.<fieldName>[.<fieldName>]

image

The expected JSONPath identifier should be the same as the one in the Kubectl Reference Docs (https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#explain)

<type>.<fieldName>[.<fieldName>]

image

k8s-ci-robot commented 5 days 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 5 days ago

looks like a legit issue to me. Not sure how to go about the fix. Will let others give any hint ot suggestion.

steve-hardman commented 5 days ago

/language en

Ritikaa96 commented 4 days ago

/kind bug /sig docs