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

docs: Generate enum documentation #3186

Merged
merged 2 commits into from
Apr 15, 2024
Merged

Conversation

liorokman
Copy link
Contributor

What this PR does / why we need it:
This PR updates the version of the crd-ref-docs tool to the latest and updates the documentation template to generate documentation for enum values.

Which issue(s) this PR fixes:
Fixes #3151

Update the template used for crd-ref-tool to generate the enum
documentation.

Signed-off-by: Lior Okman <[email protected]>
@liorokman liorokman requested a review from a team as a code owner April 13, 2024 13:39
@zirain
Copy link
Member

zirain commented Apr 14, 2024

/retest

Copy link
Member

@zirain zirain left a comment

Choose a reason for hiding this comment

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

Thanks, Great work!

Copy link
Contributor

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

Copy link
Contributor

@arkodg arkodg 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 !

@arkodg arkodg merged commit e70bd32 into envoyproxy:main Apr 15, 2024
20 checks passed
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.

API reference documentation should also include enumeration descriptions
4 participants