elastic / elastic/crd-ref-docs

[Feature Request]: Incorrect links to multi-version CRDs

Open
#60 7 comments 2 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
173
Forks
81
PR merge metrics
No merged PRs in 30d

Description

I used crd-ref-docs to generate API documentation for a multi-version CRD.

```markdown
# API Reference

## Packages
- [example.dev/v1](#exampledevv1)
- [example.dev/v2](#exampledevv2)

## example.dev/v1

### Resource Types
- [Foo](#foo)
- [FooList](#foolist)

#### Foo
<- Jump to here

## example.dev/v2

### Resource Types
- [Foo](#foo) <- Click this
- [FooList](#foolist)

#### Foo
<- Expect to jump to here
```

Clicking on the v2 version of Foo redirects to the v1 version of Foo

Refer to the implementation of [Kubernetes Docs](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#objectmeta-v1-meta)

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.