feat: parse markers by tenstad · Pull Request #55 · elastic/crd-ref-docs · GitHub
Skip to content

feat: parse markers#55

Merged
thbkrkr merged 2 commits into
elastic:masterfrom
tenstad:feat-markers
Oct 18, 2023
Merged

feat: parse markers#55
thbkrkr merged 2 commits into
elastic:masterfrom
tenstad:feat-markers

Conversation

@tenstad

@tenstad tenstad commented Oct 9, 2023

Copy link
Copy Markdown
Contributor

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

tenstad commented Oct 18, 2023

Copy link
Copy Markdown
Contributor Author

@thbkrkr

thbkrkr commented Oct 18, 2023

Copy link
Copy Markdown
Contributor

@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.

@thbkrkr thbkrkr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, thanks!

@mowies

mowies commented Oct 23, 2023

Copy link
Copy Markdown

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

@thbkrkr

thbkrkr commented Oct 23, 2023

Copy link
Copy Markdown
Contributor

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

@mowies

mowies commented Oct 23, 2023

Copy link
Copy Markdown

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