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

Refactor CLI documentation #541

Open
albertteoh opened this issue Dec 3, 2021 · 0 comments
Open

Refactor CLI documentation #541

albertteoh opened this issue Dec 3, 2021 · 0 comments

Comments

@albertteoh
Copy link
Contributor

Requirement - what kind of business use case are you trying to solve?

Context: #539 (comment)

Problem - what in Jaeger blocks you from solving the requirement?

In https://www.jaegertracing.io/docs/latest/cli/, common CLI flags are duplicated for each "tool" (e.g. jaeger-query, jaeger-collector, etc.) and each component type such as storage (cassandra, elasticsearch, etc.), making the page very large and difficult to navigate.

Proposal - what do you suggest to solve the problem or improve the existing situation?

Refactor the page to group common flags under one section and each specific storage type to have their own specific flags.
Also consider having a page menu on the right, much like: https://www.jaegertracing.io/docs/latest/frontend-ui/.

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