elastic / elastic/crd-ref-docs

Generated link to Kubernetes API is wrong

Open
#36 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
Go
Stars
173
Forks
81
PR merge metrics
No merged PRs in 30d

Description

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?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.