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

cli: svelte stories homogenization #10704

Merged
merged 1 commit into from
May 11, 2020
Merged

cli: svelte stories homogenization #10704

merged 1 commit into from
May 11, 2020

Conversation

tooppaaa
Copy link
Contributor

@tooppaaa tooppaaa commented May 9, 2020

Issue:

We need similar stories after generation to run e2e against

Part of #10702

Copy link
Member

@gaetanmaisse gaetanmaisse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM ✅

Some of the framework apps have Welcome and Button components, used in template stories, in @storybook/FRAMEWORK/demo, and some others define these components in CLI templates directly. I think it could be great to pick a way and be consistent across all apps. Personally I vote for components in @storybook/FRAMEWORK/demo. What's your opinion on that?

@yannbf
Copy link
Member

yannbf commented May 10, 2020

LGTM ✅

Some of the framework apps have Welcome and Button components, used in template stories, in @storybook/FRAMEWORK/demo, and some others define these components in CLI templates directly. I think it could be great to pick a way and be consistent across all apps. Personally I vote for components in @storybook/FRAMEWORK/demo. What's your opinion on that?

I agree with that. We should be as consistent as possible across all frameworks. Shipping example components might be helpful for beginners but might also be considered noise which people would delete right away. I especially like that with the Welcome example shipped I can just change the text or use it as inspiration for a Welcome component, which might be nice for newcomers in my project to see as they open storybook.

But I guess I'd go for @storybook/FRAMEWORK/demo so we keep consistency and make maintenance simpler

@shilman @ndelangen which way do you think should be the way to go?

Edit: Moving this discussion to #10723 please respond there 🚀


<main>
<h1>Welcome to storybook</h1>
<p>This is a UI component dev environment for your app.</p>
Copy link
Member

@yannbf yannbf May 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we keep consistency on the content of the Welcome component? There is useful info in other components that I don't see here, such as telling users about hot module reloading, a link to storybook repo and explanation over the webpack config file.

Edit: Moving this discussion to #10723 please respond there 🚀

@yannbf
Copy link
Member

yannbf commented May 10, 2020

Also about keeping things in sync, some templates generate stories under /src/stories and others under /stories

Edit: Moving this discussion to #10723 please respond there 🚀

@yannbf yannbf mentioned this pull request May 10, 2020
2 tasks
@tooppaaa tooppaaa merged commit 37968d6 into next May 11, 2020
@tooppaaa tooppaaa deleted the generator_svelte branch May 11, 2020 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli maintenance User-facing maintenance tasks svelte
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants