-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
ui: document each metrics on UI page #28379
Comments
@jseldess I think this one's for you. |
Thanks, @jess-edwards. @Amruta-Ranade is really the right person here. Our current admin UI docs claim:
If this isn't accurate anymore, and users do need to look at these dashboards, we should both add tooltips and add explicit pages. @Amruta-Ranade, @robert-s-lee, thoughts? |
I agree. If users need to look at these dashboards, we should add tooltips and docs for them. Will take this up next week (post-Docs 2.1 week), if that's okay. |
CockroachDB customers tend to be sophisticated. Performance, Scalability, Troubleshooting can be aided by understanding how to interpret these metrics. Post doc 2.1 would be good to re-visit and determine the next steps. |
Definitely. I am working on a similar project - will put something on the calendar to discuss the next steps. |
We have marked this issue as stale because it has been inactive for |
Follow up from #28377
@piyush-singh consistency checker does not have the information icon that provides a context of how to interpret this metric. Any thought on providing context based on this and other related issues to provide general guidance.
@jess-edwards Any thoughts on how to structure document of these metrics one by one organically. This will be important to enable self-service diagnostics and scale the adoption.
The text was updated successfully, but these errors were encountered: