generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 565
Open
Labels
kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.Denotes an issue or PR has remained open with no activity and has become stale.
Description
Problem
PR #3697 (commit b69fa43) changed the tool used to generate the CRD reference docs from ahmetb/gen-crd-api-reference-docs to elastic/crd-ref-docs. This had the unintended side effect of breaking links to resources on https://gateway-api.sigs.k8s.io/reference/spec/ because the HTML anchors generated by the two tools are different. For example:
Before: #gateway.networking.k8s.io/v1.HTTPRouteRule
After: #httprouterule
(The latter is missing the group and version. The kind is lowercased.)
Potential solutions
- Update all links across the site to point to the new, updated anchors.
- Configure
elastic/crd-ref-docs
to use a custom template that generates anchors using the previous format. (Seecrd-ref-docs
's--templates
flag.)
xtineskim
Metadata
Metadata
Assignees
Labels
kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.Denotes an issue or PR has remained open with no activity and has become stale.