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

Can't override links to already built-in types

Open
  • Is something wrong?
#90 0 comments 0 reactions 0 assignees View on GitHub

@doralenart is already working on this.

Since Mar 28, 2025.

  • #143 by @doralenart — open

Assessment

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

Research direction

Start with the generator configuration shown in .github/scripts/generate-crd-docs/crd-docs-generator-config.yaml and the linked draft PR #89. Trace how built-in Kubernetes API links are selected versus configured overrides; done means an override for an already built-in type such as Quantity is respected in the generated documentation.

Written by the indexing model from the issue text.

Description

I am trying to override a link to the Quanity type from k8s.io/apimachinery/pkg/api/resource (Link).

But the generator is not respecting my config at all and uses the built-in k8s generated API links.

Seems to me that this is not an issue specific to my type but rather a general issue.

I provided a draft PR to showcase the issue.

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.