chore: annotate KGO supported types #110
Merged
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
force-pushed
the
chore/annotate-kgo-supported
branch
from
ea628e8 to
eb35872
Compare
pmalek
reviewed
Oct 3, 2024
pmalek
reviewed
Oct 3, 2024
pmalek
approved these changes
Oct 3, 2024
czeslavo
force-pushed
the
chore/annotate-kgo-supported
branch
2 times, most recently
from
626a760 to
a689394
Compare
czeslavo
force-pushed
the
chore/annotate-kgo-supported
branch
from
a689394 to
c5dbd7d
Compare
2 tasks
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:
Annotates all the types that should be included in the KGO docs with the new
+apireference:kgo:includemarker. Also, annotates fields that are not supported by KGO and should not be included in the docs with+apireference:kgo:exclude. The markers will be used to determine whether a type/field should be included in KGO's CRDs reference.Kong/gateway-operator#689 uses the markers.
Which issue this PR fixes
Part of #105.