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

Addon Onboarding: New design and flow based on Save from Controls #28327

Merged
merged 13 commits into from
Jun 28, 2024

Conversation

ghengeveld
Copy link
Member

For #28181

What I did

This is a major overhaul of addon-onboarding. It includes a new splash screen (welcome modal), and updated guided tour. The code was refactored and logic was updated to make steps reactive to the actual state of Storybook (e.g. whether "save from controls" is visible).

The new onboarding no longer includes a "copy and paste" workflow to create a new story. Instead we leverage Save from Controls to create a new story without writing any code. This also avoids the need for framework-specific code snippets, making the new onboarding framework agnostic.

Screen.Recording.2024-06-21.at.00.30.45.mov
Screen.Recording.2024-06-19.at.21.34.21.mov

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@ghengeveld ghengeveld added feature request ci:merged Run the CI jobs that normally run when merged. addon: onboarding labels Jun 24, 2024
@ghengeveld ghengeveld changed the title Onboarding v2 Addon: Onboarding v2 Jun 24, 2024
@ghengeveld ghengeveld changed the title Addon: Onboarding v2 Addon Onboarding: New onboarding design and flow based on Save from Controls Jun 24, 2024
@ghengeveld ghengeveld changed the title Addon Onboarding: New onboarding design and flow based on Save from Controls Addon Onboarding: New design and flow based on Save from Controls Jun 24, 2024
Copy link

nx-cloud bot commented Jun 24, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 963ce3f. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@valentinpalkovic
Copy link
Contributor

Can we get rid of the SyntaxHighlighter component? I think it is not needed anymore: https://635781f3500dd2c49e189caf-xengiqztsz.chromatic.com/?path=/story/addons-onboarding-components-syntaxhighlighter--default&globals=theme:dark

@ghengeveld ghengeveld merged commit 5e33c61 into next Jun 28, 2024
67 checks passed
@ghengeveld ghengeveld deleted the onboarding-v2 branch June 28, 2024 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: onboarding ci:merged Run the CI jobs that normally run when merged. feature request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants