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

generate structured helm values reference docs rather than table-style #247

Open
ilackarms opened this issue Jun 2, 2021 · 0 comments
Open

Comments

@ilackarms
Copy link
Member

we currently generate reference docs for our helm values apis (eg in gloo-mesh charts) in table format. this can quickly get become unreadable as the values schema represents a type schema which can have many layers of nesting as well as repetition of types.

for readability purposes, we should be generating the same kind of api reference for our helm values the same way we generate for our CRDs - structured object documentation like we do for our CRD apis

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

No branches or pull requests

1 participant