Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: parse markers #55

Merged
merged 2 commits into from
Oct 18, 2023
Merged

feat: parse markers #55

merged 2 commits into from
Oct 18, 2023

Conversation

tenstad
Copy link
Contributor

@tenstad tenstad commented Oct 9, 2023

Parses all CRD markers so that e.g. default and validation markers may be used to generate doc.

The markers are not used for anything right now, but can be seen by adding {{ $type.Markers}} and {{ .Markers }} in type.tpl, which results in:

#### Guestbook
map[kubebuilder:object:root:[true] kubebuilder:subresource:status:[{}]]
#### Rating
map[kubebuilder:validation:Maximum:[5] kubebuilder:validation:Minimum:[1]]
| `page` _integer_ | Page indicates the page number | map[kubebuilder:default:[{1}]]
| `a` _[Underlying1](#underlying1)_ |  | map[kubebuilder:default:[{b}]]

@tenstad
Copy link
Contributor Author

tenstad commented Oct 18, 2023

@thbkrkr to keep it clean, I think we should merge this one as is, without doing anything with the markers just yet. WDYT?

@thbkrkr
Copy link
Contributor

thbkrkr commented Oct 18, 2023

@thbkrkr to keep it clean, I think we should merge this one as is, without doing anything with the markers just yet. WDYT?

Yes, that sounds good to me.

Copy link
Contributor

@thbkrkr thbkrkr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@thbkrkr thbkrkr merged commit 9a3105b into elastic:master Oct 18, 2023
1 check passed
@mowies
Copy link

mowies commented Oct 23, 2023

@thbkrkr @tenstad any plans on when this will be released? Really looking forward to it! 🎉

@thbkrkr
Copy link
Contributor

thbkrkr commented Oct 23, 2023

@mowies It's released: https://github.com/elastic/crd-ref-docs/releases/tag/v0.0.10.

@mowies
Copy link

mowies commented Oct 23, 2023

Thanks! 🙌🏼

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants