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

Ensure VTA panel opens when clicking "run tests" button in warning state #253

Closed
ghengeveld opened this issue Mar 22, 2024 · 5 comments · Fixed by #310
Closed

Ensure VTA panel opens when clicking "run tests" button in warning state #253

ghengeveld opened this issue Mar 22, 2024 · 5 comments · Fixed by #310
Assignees
Labels
bug Classification: Something isn't working sev:S2

Comments

@ghengeveld
Copy link
Member

ghengeveld commented Mar 22, 2024

As discussed below, rather than hiding the "run tests" button when there's an issue, make sure that it opens the Visual Tests panel. Currently this doesn't work when on a docs page, as there is no addons panel in this situation.

@ghengeveld ghengeveld added bug Classification: Something isn't working sev:S3 labels Mar 22, 2024
@shilman
Copy link
Member

shilman commented Mar 28, 2024

I'd argue this is a conversion feature. Possibly annoying to users but good for discoverability.

@ghengeveld ghengeveld self-assigned this Mar 28, 2024
@ghengeveld
Copy link
Member Author

ghengeveld commented May 7, 2024

This is the current state of the button while onboarding:

Screenshot 2024-05-07 at 11 30 13

After logging in:

Screenshot 2024-05-07 at 11 29 16

I agree with @shilman that this is okay for discoverability. The VTA addon is focussed when clicking the button (unless you're on a docs page).

However, I did also encounter this issue, which happens when restarting Storybook after the initial setup in a monorepo:

Screenshot 2024-05-07 at 11 32 58

The configuration file that's generated currently does not automatically include any of the suggested configuration fixes. I think we should fix that, so the autogenerated config file includes those suggestions.

@MichaelArestad
Copy link
Contributor

I am on the fence with this one. I see it as potentially an avenue for discoverability, but we may want to change from a tooltipNote to something this actionable. For example, we could possibly show a full tooltipMessage with a button that either takes the user through the login flow or takes the user to the addon panel project selection.

@shilman
Copy link
Member

shilman commented May 8, 2024

@ghengeveld can you elaborate on the config problem and the fix?

I like this button for discoverability, and I agree with @MichaelArestad that we could make it a better experience for helping users get to the next step.

I only worry about prematurely optimizing this flow, so I'd like to:

  1. Track the click when it's in this state
  2. Do the simplest thing that makes it less frustrating, like possibly what you're suggesting @ghengeveld

Then we can look at the numbers and add the full improvement later if it's worth it. WDYT?

@ghengeveld
Copy link
Member Author

The config issue has been addressed in #306, so this is no longer a problem out of the box.

I'm going to keep the button state as-is, for sake of discoverability. I would hate for the VTA to go unnoticed because it's not configured / the user isn't signed in. The dot isn't obtrusive so even if people leave it like that it doesn't get in the way.

The button already opens the VTA panel, which then contains more details about the problem (or simply prompts for what it needs). I don't think a more elaborate tooltip is worthwhile.

Here's what I'll do (as part of this ticket):

  • Make sure that clicking the button opens the VTA, i.e. switch to the next/first story when on a docs page.
  • Add telemetry for the click.

@ghengeveld ghengeveld changed the title Don't show the sidebar play button until VTA is fully set up. Ensure VTA panel opens when clicking "run tests" button in warning state May 16, 2024
@ghengeveld ghengeveld added this to the post-launch stabilization milestone May 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Classification: Something isn't working sev:S2
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants