chore: adapt apidocs-gen script to use kconf definitions #689
+2,073
−64
Conversation
This file contains 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
czeslavo
added
documentation
czeslavo
force-pushed
the
chore/generate-docs-markdown-from-kconf
branch
4 times, most recently
from
e2d2f75
to
03410f4
Compare
czeslavo
force-pushed
the
chore/generate-docs-markdown-from-kconf
branch
4 times, most recently
from
798ea04
to
37edec5
Compare
czeslavo
force-pushed
the
chore/generate-docs-markdown-from-kconf
branch
from
37edec5
to
6ee6a7c
Compare
pmalek
reviewed
Oct 3, 2024
Comment on lines
+91
to
+92
| - Annotate the CRD and any new type it depends on with the right markers to make sure it will be included | ||
| in the generated documentation. See [available markers][available-markers]. |
There was a problem hiding this comment.
Is there an option crd-ref-docs that would allow us to just add this annotation on a package instead of adding it to every type (which can be error prone)?
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.
What this PR does / why we need it:
It makes the
scripts/apidocs-genscript includekubernetes-configurationtypes that KGO support in the generated markdown reference.From now on, all new types that shall be included in the documentation need to be annotated with the new
+apireference:kgo:include.It depends on Kong/kubernetes-configuration#110.
Which issue this PR fixes
Part of Kong/kubernetes-configuration#105.