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

Add docs for the UI #183

Open
tiffon opened this issue Nov 28, 2018 · 1 comment
Open

Add docs for the UI #183

tiffon opened this issue Nov 28, 2018 · 1 comment

Comments

@tiffon
Copy link
Member

tiffon commented Nov 28, 2018

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

The UI is not documented anywhere. (Aside from the configuration options.)

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

Currently, the UI code is the only place that will inform users how the UI works, aside from the UI configurtaion.

For instance, if a user wanted to understand the search in the trace detail page, checking the code or PR is the only way they would learn it's case-insensitive and prefacing a term with a hyphen, e.g. -stacktrace, will exclude keys containing the term from the tags or log fields checked.

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

Create a top-level section in the docs for the UI. The reason I suggest a top-level section is because it doesn't seem to fit within the existing sections.

Any open questions to address

Mainly if this is a good idea or not.


cc @aljesusg who is preparing docs for a new feature.

@141AQUA-xzy
Copy link
Contributor

I can add that,but the content need to more clarified.......I mean ### what exactly do I need to document,so I would need help with that ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants