elastic/crd-ref-docs

View on GitHub

Generates Kubernetes CRD API reference documentation

Stars: 173
Forks: 81
Open beginner issues: 2
Indexed issues: 25

Dominant language: Go
License: Apache-2.0
Last GitHub push: Jun 11, 2026
Latest indexed: Sep 15, 2026
Contributing guide: Contributing guide
Code of conduct: No code of conduct
Beginner labels: No beginner labels indexed
PR merge metrics: No merged PRs in 30d

Beginner friendly Everything

Open All

The generated 'Validation' column end up with duplicated values for fields having multiple "required" markers flavors Open

Difficulty 2/5 1-3 hours Newbie friendliness 68/100

elastic/crd-ref-docs#204 · Opened Sep 7, 2026
Support for +kubebuilder:validation:Required and omitempty Open

Difficulty 2/5 1-3 hours Newbie friendliness 65/100

elastic/crd-ref-docs#198 · 1 reaction · Opened May 15, 2026
[Feature request] JSON output Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

elastic/crd-ref-docs#191 · Opened Nov 27, 2025
Indention in the fields's comments is not preserved in the generated document Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

elastic/crd-ref-docs#188 · 2 comments · Opened Nov 19, 2025
Option to not "quote" xref/links Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

elastic/crd-ref-docs#182 · Opened Sep 12, 2025
Do not add double dollars Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

elastic/crd-ref-docs#181 · Opened Sep 12, 2025
Code blocks in the descriptions are not properly rendered Open

Difficulty 3/5 1-2 days Newbie friendliness 42/100

elastic/crd-ref-docs#168 · Opened Aug 7, 2025
Docs generated in output-mode "group" are missing versions for multiversioned APIs Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

elastic/crd-ref-docs#167 · Opened Aug 7, 2025
Support for expanding embedded structs Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

elastic/crd-ref-docs#158 · 1 comment · Opened Jun 6, 2025
Allow custom markers with values Open

Difficulty 4/5 3-5 days Newbie friendliness 42/100

elastic/crd-ref-docs#124 · Opened Jan 16, 2025
Support custom markers for packages out of `api/` Open

Difficulty 4/5 3-5 days Newbie friendliness 42/100

elastic/crd-ref-docs#106 · Opened Oct 14, 2024
Support for outputting a file per kind Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

elastic/crd-ref-docs#103 · 6 reactions · Opened Oct 7, 2024
Dependency Dashboard Open

Difficulty 4/5 3-5 days Newbie friendliness 15/100

elastic/crd-ref-docs#98 · Opened Oct 4, 2024
Adding `fieldPath` to CRD validation rules removes the whole API group doc Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

elastic/crd-ref-docs#94 · 3 comments · Opened Sep 19, 2024
Supporting standard `---` convention for comments to not be included in public APIs Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 38/100

elastic/crd-ref-docs#93 · Opened Aug 23, 2024
Can't override links to already built-in types Open

Difficulty 3/5 1-2 days Newbie friendliness 38/100

elastic/crd-ref-docs#90 · Opened Aug 5, 2024
Major.minor versions that end with 0 like 1.30 are truncated like floats Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

elastic/crd-ref-docs#88 · Opened Jul 29, 2024
Ignore a type but still document its fields when embedded Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

elastic/crd-ref-docs#75 · 1 reaction · Opened Mar 18, 2024
[Feature Request]: Incorrect links to multi-version CRDs Open

Difficulty 3/5 1-2 days Newbie friendliness 30/100

elastic/crd-ref-docs#60 · 7 comments · 2 reactions · Opened Dec 7, 2023
Add flag for reading binary version Open

enhancement

Difficulty 2/5 1-3 hours Newbie friendliness 55/100

elastic/crd-ref-docs#57 · Opened Nov 22, 2023
Move Kubernetes API types to the top Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

elastic/crd-ref-docs#56 · 1 comment · 2 reactions · Opened Oct 27, 2023
Generate example definitions Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

elastic/crd-ref-docs#44 · Opened Jun 20, 2023
Generated link to Kubernetes API is wrong Open

Difficulty 3/5 1-2 days Newbie friendliness 42/100

elastic/crd-ref-docs#36 · 1 comment · 1 reaction · Opened Nov 28, 2022
Support for multiple source paths Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 45/100

elastic/crd-ref-docs#34 · Opened Sep 14, 2022
Generate unique type headers Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

elastic/crd-ref-docs#30 · 1 comment · 1 reaction · Opened Jul 12, 2022

elastic/crd-ref-docs

Get new issues in your inbox