Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
  • Is something wrong?
#60 7 comments 2 reactions 0 assignees View on GitHub

@antonincms is already working on this.

Since Nov 27, 2024.

  • #118 by @antonincms — open

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
go, kubernetes
Domain
documentation

Research direction

No source file or test is named in issue #60. Start by locating the generator logic that creates Markdown anchors and links for versioned CRD resource types, and compare its expected behavior with the linked Kubernetes Docs example. Done means v2 Foo and FooList links jump to their v2 headings rather than the v1 headings.

Written by the indexing model from the issue text.

Description

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

# 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

Dominant language
Go
Stars
174
Forks
81
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from elastic/crd-ref-docs

All issues in elastic/crd-ref-docs

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.