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

Product Tour: Dashboard #80516

Open
alexfrancoeur opened this issue Oct 14, 2020 · 8 comments
Open

Product Tour: Dashboard #80516

alexfrancoeur opened this issue Oct 14, 2020 · 8 comments
Labels
Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins.

Comments

@alexfrancoeur
Copy link

As part of #58506 and a follow up from #61549, we'd like to add product tours to some of Kibana's core applications. Dashboard is one of the most heavily utilized applications and it'd be great to provide quick, optional onboarding. Dashboard will be one of the first POC's for a product tour but if successful, we can begin to adopt across Elastic.

image

Steps

  1. Add panel
  2. Add visualization with Lens
  3. Drag and drop fields
  4. Save visualization
  5. Name
  6. Save and return to dashboard

There is descriptive text in the mockups, but we'll need to review text with @gchaps

Requirements

  • These tours should only be viewable to new users
  • The tours should be dismissible
  • If the tour was complete and others are available (like Discover Product Tour: Discover - Step One #80514), we should give them the option to do that next
  • Entry point should not matter. Whether you're coming from the Kibana overview page, file upload, a data tutorial or simply trying out Kibana for the first time - you should be presented with this tour

Product analytics questions

Need to open separate telemetry issue to track

  • How many users complete the tour?
  • How many users ignore the tour?
  • How many users drop out of the tour?
  • Where do they drop out?
  • Is the cluster successfully using Dashboard and Kibana after tours have been completed?

EUI component

https://elastic.github.io/eui/#/display/tour

Mockups and prototype

cc: @AlonaNadler @rayafratkina @ryankeairns

@alexfrancoeur alexfrancoeur added the REASSIGN from Team:Core UI Deprecated label for old Core UI team label Oct 14, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core-ui (Team:Core UI)

@AlonaNadler
Copy link

These tours should only be viewable to new users
While we wait on #17888, we may have to rely on local cache. Which means we should probably only focus on new deployments initially

this can be a good first step while we optimize the tour. In general, the tours should be available for anyone coming from the overview page whether they have data or not. Otherwise, the tour is only available for the first user or Kibana and we are missing out on the onboarding of the end-users in every company

@rayafratkina
Copy link
Contributor

+1 to using local cache initially. I feel like it solves most of the cases anyway.

@alexfrancoeur
Copy link
Author

the tours should be available for anyone coming from the overview page whether they have data or not.

++ I agree. This is probably an implementation detail we'll need to figure out, but let me clarify what I meant with my statement. By "new deployment" I was referring to a new Kibana instance vs. an upgrade. We don't have a concept of persisted user states, would need to rely on local cache and we don't want to only focus tours on clusters that have no data (empty state). Because of this, I'm worried that if a cluster upgrades from the previous version all end users would be hit with this tour. They may have been using Kibana for years or days, we'd have no idea. I'm sure we can get creative here, but that feels like a scenario we'd want to avoid. What do you think?

@ryankeairns
Copy link
Contributor

Until we have true user profile support, we could consider treating it like the newsfeed. In other words, provide a Kibana config to disable product tours that is also whitelisted for use by Cloud admins.

The obvious downside is that this would disable tours for new users on these instances, going forward. I don't love this approach, but it would provide an escape hatch for customers who find the recurrence of tour prompts to be problematic. It's an intermediate solution until user profiles exist.

@ryankeairns ryankeairns added the Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins. label Jan 19, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-design (Team:Kibana-Design)

@ryankeairns ryankeairns removed the REASSIGN from Team:Core UI Deprecated label for old Core UI team label Jan 19, 2021
@ryankeairns
Copy link
Contributor

Not specific to this issue, but @liza-mae provided some quick thoughts on how this might be implemented (or what to consider in a proof of concept). In particular, whomever goes first (i.e. takes on the PoC) should consider the possibility of this being a separate plugin which provides a way to manage tours from a central location as opposed to sprinkling EuiTour wrappers throughout numerous application files.

@ryankeairns
Copy link
Contributor

On hold until we have a broader plan for tours across Analytics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins.
Projects
None yet
Development

No branches or pull requests

5 participants