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

Move Kubernetes API types to the top

Open
  • Is something wrong?
#56 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Reproduce the generated reference documentation with Kubernetes custom resource types that include unrelated Go helper types, then compare the heading order with the behavior described from gen-crd-api-reference-docs. Trace how the generator orders referenced types; done means API types appear before unrelated helper types rather than solely in alphabetical order.

Written by the indexing model from the issue text.

Description

Something I'm observing from my https://github.com/ahmetb/gen-crd-api-reference-docs tool that's not ported here is that this tool is showing headings for various Go types referred in my Kubernetes custom resource types on top of the page because they're alphabetically first.

I think users would much rather prefer to scan API types first, and then see some unrelated Go helper type in the page.

Is this by design, or is there room for improvement here.

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.