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.

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

Typo in auto-generated "kubeadm Configuration (v1beta4)" reference page #45602

Closed
msrajanadar opened this issue Mar 19, 2024 · 10 comments · Fixed by #45709
Closed

Typo in auto-generated "kubeadm Configuration (v1beta4)" reference page #45602

msrajanadar opened this issue Mar 19, 2024 · 10 comments · Fixed by #45709
Labels
language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. sig/docs Categorizes an issue or PR as relevant to SIG Docs.

Comments

@msrajanadar
Copy link

found typo "ontrolPlaneEndpoint" in the below
typo ontrolPlaneEndpoint

There is a typo "ontrolPlaneEndpoint" in the localAPIEndpoint description it should be "controlPlaneEndpoint"
https://kubernetes.io/docs/reference/config-api/kubeadm-config.v1beta4/#kubeadm-k8s-io-v1beta4-InitConfiguration

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Mar 19, 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/test-infra repository.

@dipesh-rawat
Copy link
Member

Page related to issue: https://kubernetes.io/docs/reference/config-api/kubeadm-config.v1beta4
/language en

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Mar 19, 2024
@dipesh-rawat
Copy link
Member

/retitle Typo in auto-generated "kubeadm Configuration (v1beta4)" reference page

@k8s-ci-robot k8s-ci-robot changed the title typo("ontrolPlaneEndpoint") in kubeadm Configuration (v1beta4) Typo in auto-generated "kubeadm Configuration (v1beta4)" reference page Mar 19, 2024
@dipesh-rawat
Copy link
Member

The mentioned reference page for "kubeadm Configuration (v1beta4)" is automatically generated. The page is generated from the upstream source code kubernetes/kubernetes.

As the page is generated from the upstream source code, any fixes would need to be addressed there. For those interested in contributing to resolve this issue, please refer to the upstream contribution guidelines outlined at: https://kubernetes.io/docs/contribute/generate-ref-docs/contribute-upstream

@pranav-pandey0804
Copy link
Contributor

/sig docs

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Mar 19, 2024
@neolit123
Copy link
Member

this is not a typo in the code files
https://github.com/kubernetes/kubernetes/blob/master/cmd/kubeadm/app/apis/kubeadm/v1beta4/types.go#L51
https://github.com/kubernetes/kubernetes/blob/master/cmd/kubeadm/app/apis/kubeadm/v1beta3/types.go#L47

and also in my browser it's shown as controlPlaneEndpoint, so maybe it's a rendering issue.

Screenshot 2024-03-25 125359

cc @tengqm

@neolit123
Copy link
Member

neolit123 commented Mar 25, 2024

Screenshot 2024-03-25 125359

the image is for v1beta3, but v1beta4 does have the problem as the OP shows.
but again, there are no typos in the code / go docs.

also NOTE that v1beta4 is WIP API that should not be used yet by users.

@a-mccarthy
Copy link
Contributor

the c in controlPlaneEndpoint is also dropped in another place on that page, screenshot below. I'm not familiar with the autogeneration for these pages, is there some processing on the word that is dropping letters when converting from the original? Looks like in the source file its written with a capital and in the generated file its with a lower case. Not sure why it would only so it sometimes though.

We should check to see if this is happening on other pages.

/priority awaiting-more-evidence

Screenshot 2024-03-27 at 9 44 26 AM

@k8s-ci-robot k8s-ci-robot added the priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. label Mar 27, 2024
@stmcginnis
Copy link
Contributor

Another interesting observation looking at the Code Search instances of this - it appears to only happen on the v1beta4 version of the docs, not the previous versions.

Looks like it was modified with 7451649.

@stmcginnis
Copy link
Contributor

Put up a fix in #45709. It looks like this wasn't from an autogeneration error and just a simple typo when the docs were updated for v1beta4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/awaiting-more-evidence Lowest priority. Possibly useful, but not yet enough support to actually get it done. sig/docs Categorizes an issue or PR as relevant to SIG Docs.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants