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 tooltips with contextual help for application, ping and metric fields #293

Closed
wlach opened this issue Dec 22, 2020 · 1 comment
Closed
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone

Comments

@wlach
Copy link
Contributor

wlach commented Dec 22, 2020

One trick we've been using with internal dashboards is to have help icons which, on hover, pop up contextual help to give people an idea of what the field means. See for example, the desktop funnel dashboard:

image

We should do something similar in the Glean dictionary. For example on the metrics page, we could put a help icon beside each of these fields:

image
https://glean-dictionary-dev.netlify.app/apps/burnham/metrics/mission-status

Many of the metric parameters are defined in the Glean documentation. For example, metric parameters are defined here:

https://mozilla.github.io/glean/book/user/metric-parameters.html

I think we can probably just lift the definitions and put them in here verbatim. It may be good idea to also link to their definition in the glean documentation, which people could visit for further reference (the old glean dictionary attempts to do this, although it is incorrect in some places). You can look at the code here:

https://github.com/mozilla/probe-dictionary/blob/glean-only/src/components/GleanProbeDetails.svelte#L105

For rendering the tooltip, we can probably just use a library like sveltejs-tippy -- maybe best to define our own component based on it and create a story, as usual.

@wlach wlach added the help wanted Extra attention is needed label Dec 22, 2020
@wlach wlach added this to the Phase 1 - MVP milestone Dec 22, 2020
@wlach wlach added the enhancement New feature or request label Dec 22, 2020
@nfebe
Copy link
Contributor

nfebe commented Dec 27, 2020

Picking this up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants