dead links in k8s.io/docs/reference/setup-tools/kubeadm/kubeadm-join/

[smirnov-mi]

This is a Bug Report

Problem:
Dead links on the "kubeadm join" page:

kubeadm - kubeadm: easily bootstrap a secure Kubernetes cluster
kubeadm join phase - Use this command to invoke single phase of the join workflow

Proposed Solution:
fix them

[neolit123]

/help
/sig cluster-lifecycle
/kind bug

thanks for logging the issue

[neolit123]

/assign

[neolit123]

/remove-help

[neolit123]

/unassign
/remove-sig cluster-lifecycle
/sig docs

/assign @tengqm @jimangel

it seems this generated file contains invalid links at the bottom under "see also":
https://github.com/kubernetes/website/blob/master/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md

preview:
https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-join/#options-inherited-from-parent-commands

EDIT: looks like the same problem happens for other generated files such as:
https://github.com/kubernetes/website/blob/master/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md

[k8s-ci-robot]

@neolit123: Those labels are not set on the issue: sig/cluster-lifecycle

In response to this:

/unassign
/remove-sig cluster-lifecycle
/sig docs

/assign @tengqm @jimangel

it seems this generated file contains invalid links at the bottom under "see also":
https://github.com/kubernetes/website/blob/master/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md

preview:
https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-join/#options-inherited-from-parent-commands

EDIT: looks like the same problem happens for other generated files such as:
https://github.com/kubernetes/website/blob/master/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md

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.

[aimeeu]

The links in the markdown files point to other markdown files in github.

In https://github.com/kubernetes/website/blob/master/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md, L224-225:

* [kubeadm](kubeadm.md)	 - kubeadm: easily bootstrap a secure Kubernetes cluster
* [kubeadm join phase](kubeadm_join_phase.md)	 - Use this command to invoke single phase of the join workflow

The links should point to GitHub files.

But in https://kubernetes.io/docs/reference/setup-tools/kubeadm/kubeadm-join/#options-inherited-from-parent-commands:

<p>SEE ALSO</p>
<ul>
<li><a href=kubeadm.md target=_blank>kubeadm</a> - kubeadm: easily bootstrap a secure Kubernetes cluster</li>
<li><a href=kubeadm_join_phase.md target=_blank>kubeadm join phase</a> - Use this command to invoke single phase of the join workflow</li>
</ul>

So Hugo is translating the link to be relative to kubernetes.io. Is the fix for this to change [kubeadm](kubeadm.md) to [kubeadm](https://github.com/kubernetes/website/blob/master/content/en/docs/reference/setup-tools/kubeadm/generated/kubeadm.md) in the upstream kubeadm docs?

[aimeeu]

@tengqm, @jimangel any thoughts on how to fix this issue?

[kbhawkey]

@neolit123 , Since there are static links in the What's next section on each kubeadm command page, is the generated See Also section needed?

[neolit123]

I don't think it's needed. Ideally we should remove it.

[kbhawkey]

I don't think it's needed. Ideally we should remove it.

OK. Then the link errors would be resolved, correct?
If no one is working on this, feel free to assign to me.

[tengqm]

I'm trapped by some company projects recently. Would try allocate some time for code review though.