crd-ref-docs icon indicating copy to clipboard operation
crd-ref-docs copied to clipboard

Generated link to Kubernetes API is wrong

Open wmuizelaar opened this issue 3 years ago • 1 comments

Hi,

I'm rendering an API resource with the following piece in it:

	RoleRef rbacv1.RoleRef `json:"roleRef"`

which references to upstream's Role Reference as used in the ClusterRoleBinding resource. That all works pretty neat, except for 1 detail:

the generated page creates this deeplink:

__link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#roleref-v1-rbac[$$RoleRef$$]__

Where it actually should have linked to this URL:

__link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#roleref-v1-rbac-authorization-k8s-io[$$RoleRef$$]__

So the anchor in there is actually the fully qualified API name, in stead of the short one.

Am I doing something wrong here, or is this a bug in the tool?

wmuizelaar avatar Nov 28 '22 13:11 wmuizelaar

had similar issue, resolved via explicitly set kubernetesVersion in configuration:

render:
  kubernetesVersion: 1.31

cornbuddy avatar Apr 08 '25 03:04 cornbuddy