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

Document CR with all the options #671

Closed
pavolloffay opened this issue Sep 24, 2019 · 2 comments · Fixed by #1736
Closed

Document CR with all the options #671

pavolloffay opened this issue Sep 24, 2019 · 2 comments · Fixed by #1736
Labels
documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@pavolloffay
Copy link
Member

Users often don't know what are all the options exposed in Jaeger CR, or alternativelly they don't know how to format nested nodes in the CR.

I think we should generate and publish CR with all the options. The values could be just empty or default.

We could make this automatic during the build process. The generate yaml file could contain godoc comments on the fields and nodes.

Related to #668 (comment)

@objectiser
Copy link
Contributor

Would this include the freeformat options? Would it expand (for example) all of the storage options?

It would be great if we could have tabs or some checkbox/menu approach that only shows the CR parts relevant for selected strategy and storage.

@pavolloffay
Copy link
Member Author

Would this include the freeformat options? Would it expand (for example) all of the storage options?

It values would be empty and default ones. For the options it means an empty map. The goal is to not provide an example of working CR - just render all possible nodes with the correct indentation.

It would be great if we could have tabs or some checkbox/menu approach that only shows the CR parts relevant for selected strategy and storage.

This would be great, but I guess hard to develop/maintain in the UI.

@jpkrohling jpkrohling added needs-triage New issues, in need of classification and removed needs-triage New issues, in need of classification labels Dec 16, 2019
@jpkrohling jpkrohling added documentation enhancement New feature or request help wanted Extra attention is needed labels Mar 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants