Use crd-ref-docs for API reference documentation generation#563
Merged
Use crd-ref-docs for API reference documentation generation#563
crd-ref-docs for API reference documentation generation#563Conversation
github-actions
bot
added
size/XXL
bug
switch from gen-crd-api-reference-docs to crd-ref-docs as the previous one is not maintained and threw errors when running in osx with go1.25.5 Initially the output changes a lot, but all information is there and the formatting is nice and easy to read.
xkonni
force-pushed
the
bug/fix-make-docs
branch
from
45a5da9 to
fbec708
Compare
Contributor
|
Looks good to me |
afritzler
requested changes
Dec 10, 2025
Member
afritzler
left a comment
afritzler
left a comment
There was a problem hiding this comment.
We should consider removing the configs in the hack folder.
afritzler
changed the title
crd-ref-docs for API reference documentation generation
afritzler
added
enhancement
Member
|
Somehow 
|
Contributor
Author
the config is being used updated to remove field descriptions and removed obsolete templates. |
Contributor
Author
fixed it in the latest commit. |
afritzler
requested changes
Dec 10, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaced outdated
github.com/ahmetb/gen-crd-api-reference-docs(v0.3.0, last updated 2020) withgithub.com/elastic/crd-ref-docs(v0.2.0).The old tool was incompatible with modern Go versions and failed to parse types with embedded
netip.Addr/netip.Prefixfields. The new tool successfully generates API reference documentation.Changes:
ahmetb/gen-crd-api-reference-docs→elastic/crd-ref-docs