Use crd-ref-docs for API reference documentation generation
#246
Conversation
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
github-actions
bot
added
size/XXL
documentation
afritzler
changed the title
crd-ref-docs for API reference documentation generation
hardikdr
approved these changes
Dec 10, 2025
similar to PR#563 for metal-operator this replaces outdated [`github.com/ahmetb/gen-crd-api-reference-docs`](https://github.com/ahmetb/gen-crd-api-reference-docs) (v0.3.0, last updated 2020) with [`github.com/elastic/crd-ref-docs`](https://github.com/elastic/crd-ref-docs) (v0.2.0). also removes obsolete templates, changes config format to yaml.
xkonni
force-pushed
the
feat/use-crd-ref-docs
branch
from
d54556d to
10f1288
Compare
Contributor
Author
of course. done. |
hardikdr
approved these changes
Dec 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
similar to PR#563 for metal-operator this replaces the outdated
github.com/ahmetb/gen-crd-api-reference-docs(v0.3.0, last updated 2020) withgithub.com/elastic/crd-ref-docs(v0.2.0).also removes obsolete templates, changes config format to yaml.