-
Notifications
You must be signed in to change notification settings - Fork 14.1k
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
Missing links to generated kubeadm pages #24542
Comments
Thanks /sig cluster-lifecycle |
We could instead use Docsy's automatic list generation, and add descriptions to each page (eg, to the front matter of |
the graduation and missing
the rest are indeed missing.
i don't know how Docsy works, but would appreciate ideas around this as manually maintaining the subcommands is not ideal. |
Hmm, looking at this a bit more just setting a There are a few different ways to combine these. It sounds like extending the generator could help there - that could be a separate feature request against the generator code, eg to warn if a subcommand isn't documented as expected. |
i think we could do the following:
EDIT: and if the kubeadm commands lack sufficient information it should be added in the source code of kubeadm. would navigating around /generated pages sound like a good idea? |
@neolit123 that sounds like a plan. BTW, if the generator has the smarts to add metadata into generated Markdown (eg: a YAML list of subcommands, in front matter) then we can implement a Hugo layout that automatically processes that metadata into HTML. I can probably help with this approach, if selected. So you have options: more code in the docs generator, or less docs generator code but then more work for the Go templating. |
given the subcommand relation is already described by the filenames:
can Hugo just process that instead of requiring the metadata to be part of the markdown?
i think i'm leaning towards the first option, but that is because i don't know much about Hugo. if the docs team and @tengqm prefer the second option, we should go for that. |
I'd rather not hard-code in a full path into the layout code, because I think that could be fragile when it doesn't need to be. If we can set some marker eg |
Let's fix it by following the current practices. We can file a new issue to track the improvement/automation. |
This is a Bug Report
Problem:
The following pages under
docs/reference/setup-tools/kubeadm/
are currently manually maintained.It is expected that each generated page under
docs/reference/setup-tools/kubeadm/generated/
has at least one link to it from these files, otherwise it becomes orphaned.The following pages are orphaned:
Proposed Solution:
Add links to these generated pages.
The text was updated successfully, but these errors were encountered: