docs: update generated CRD reference - #347
Merged
Merged
Conversation
cmoscofian
reviewed
Jul 30, 2026
cmoscofian
left a comment
cmoscofian
left a comment
Contributor
There was a problem hiding this comment.
As I was looking at this, I can see that the duplicated fields issue is something that is already present in the other references. Would be nice to adjust everything, since we are fixing docs.
Refresh the generated CRD documentation to include AccountSigningKey and signing key reference fields. Signed-off-by: Thobias Karlsson <thobias.karlsson@gmail.com>
choufraise
force-pushed
the
docs/update-crd-reference
branch
from
July 30, 2026 13:00
16a8a01 to
19cf96f
Compare
Ignore embedded Kubernetes TypeMeta fields when generating the CRD reference. This removes duplicate apiVersion and kind rows while keeping the concise constant-value rows for each resource. Signed-off-by: Thobias Karlsson <thobias.karlsson@gmail.com>
Render CRD reference validation markers through a local crd-ref-docs markdown template override so generator artifacts stay reproducible.
The upstream markdown renderer prints kubebuilder presence markers verbatim as Optional: {} and Required: {}, which makes the validation column noisy and hard to scan. Hide Optional because optionality is not a validation constraint, render Required as a plain label, and de-duplicate repeated marker output while keeping real validations such as Enum, Pattern, MinLength, and MaxItems.
Signed-off-by: Thobias Karlsson <thobias.karlsson@gmail.com>
choufraise
force-pushed
the
docs/update-crd-reference
branch
from
July 30, 2026 13:11
19cf96f to
646ff8a
Compare
cmoscofian
approved these changes
Jul 30, 2026
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
2 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.
Refresh the generated CRD documentation to include AccountSigningKey and signing key reference fields.