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 usage documentation for Monitor tab UI #553

Closed
albertteoh opened this issue Mar 2, 2022 · 2 comments · Fixed by #556
Closed

Add usage documentation for Monitor tab UI #553

albertteoh opened this issue Mar 2, 2022 · 2 comments · Fixed by #556

Comments

@albertteoh
Copy link
Contributor

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

Relates to: jaegertracing/jaeger#2954

Write documentation for the ATM feature in Jaeger including:

  • Configuration for both backend and frontend components
  • Architecture
  • API specification
  • UI features and usage

Any open questions to address

  • I propose to mark the ATM feature as experimental to give it some time to stabilise as users test it.

  • Should all documentation reside in a single page, similar to the Jaeger Operator docs, or should they be spread out amongst the respective Frontend/UI (how to enable the Monitor tab, its features and usage), Architecture (the required components to make it work) and APIs (API specification) pages?

    It's worth noting that ATM-related docs already exist in CLI Flags.

@yurishkuro
Copy link
Member

Discussed this at project call, it seems it's worth doing a single feature-oriented docs page for this, but also duplicate some info where necessary, e.g. in the UI config sections.

@albertteoh
Copy link
Contributor Author

Great, thanks for raising it on the call and for the update, @yurishkuro! 🙏🏼

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