Api reference links are broken

gardener / machine-controller-manager

Declarative way of managing machines for Kubernetes cluster

Apache License 2.0

256 stars 117 forks source link

Api reference links are broken #918

Closed Kostov6 closed 2 months ago

Kostov6 commented 4 months ago

How to categorize this issue?

/area documentation /kind bug /priority 3

What happened: There are a lot of broken links like MachineSpec

What you expected to happen: It should work like https://github.com/gardener/etcd-druid-api/blob/main/docs/api-reference/druid.md

How to reproduce it (as minimally and precisely as possible):

Anything else we need to know?:

Environment:

Kubernetes version (use kubectl version):
Cloud provider or hardware configuration:
Others:

elankath commented 2 months ago

all generated fragment links to types are having double #s in them. Removing the extra # makes them work.

elankath commented 2 months ago

We have identified this as a long-standing bug after the CRD binary was updated and linkForType invocation in Go template wasn't changed. We are fixing this. Thanks for catching this.