Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

kubectl explain page has JSONPath identifier incorrectly generated #47080

Open
Juneezee opened this issue Jul 3, 2024 · 4 comments
Open

kubectl explain page has JSONPath identifier incorrectly generated #47080

Juneezee opened this issue Jul 3, 2024 · 4 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/docs Categorizes an issue or PR as relevant to SIG Docs.

Comments

@Juneezee
Copy link

Juneezee commented Jul 3, 2024 •
edited

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 k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jul 3, 2024
@k8s-ci-robot
Copy link
Contributor

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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@steve-hardman
Copy link
Contributor

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
Copy link
Contributor

/language en

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Jul 3, 2024
@Ritikaa96
Copy link
Contributor

/kind bug
/sig docs

@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jul 4, 2024
@DhruvBundheliya DhruvBundheliya mentioned this issue Jul 4, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/bug Categorizes issue or PR as related to a bug. language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/docs Categorizes an issue or PR as relevant to SIG Docs.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@Juneezee @k8s-ci-robot @Ritikaa96 @steve-hardman