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

Move to Histoire #2924

Closed
5 tasks
asvae opened this issue Feb 6, 2023 · 1 comment
Closed
5 tasks

Move to Histoire #2924

asvae opened this issue Feb 6, 2023 · 1 comment
Assignees
Labels
d3: medium No cheats. Monsters a bit faster. epic Feature that is too big to fit in one issue implementation Requires implementation storybook Relates to storybook tests Refers to testing v4: must have This is something really user want to have

Comments

@asvae
Copy link
Member

asvae commented Feb 6, 2023

Right now component demos play important role by ensuring high component quality. We use vue-book for that.

The problem with vue-book is that it's not well supported. Fortunately, modern alternative exists, which is pretty much the same functionally. It's called Histoire and it ships with native Vite support.

I reviewed it and I think it's a good fit for us.

This effort is useful for developers as well as @asvae, who'll have a talk on stories.

So here's the plan:

  • Play with Histoire for a couple of weeks, every developer could create a couple of demos and see if it works for them. Here's a couple of things we should probably pay attention to:
    • Is performance all right (Histoire uses iframes by default)?
    • Is it ok to debug?
    • and any other suspicion you may think of.
  • If it doesn't work - we just rollback to vue-book. Dead end 👺.
  • If it works we replace vue-book with Histoire.
    • .demo.vue files could be renamed to .story.vue.
    • Stories should be wrapped in <story> according to Histoire syntax. Stories should work without errors. Use script setup.
    • Remove vue-cli and anything vue-book related from ui package (files, scripts, deps).
    • Add information about histoire to contribution docs.
    • book staging should become histoire staging (modify docker file accordingly)

Next steps

  • Experiment with story/variant docs
  • Add figma link, similarly to storybook
  • Visual and e2e tests
  • Onboarding guide should have detailed readme on how to work with storybook on conceptual level
@asvae asvae added the epic Feature that is too big to fit in one issue label Feb 6, 2023
@asvae asvae self-assigned this Feb 6, 2023
@asvae asvae added tests Refers to testing team discussion Feedback wanted labels Feb 6, 2023
@asvae asvae changed the title Move to histoire Move to Histoire Feb 6, 2023
@asvae asvae added implementation Requires implementation and removed team discussion Feedback wanted labels Feb 9, 2023
@rustem-nasyrov rustem-nasyrov mentioned this issue Mar 23, 2023
4 tasks
@asvae asvae added d3: medium No cheats. Monsters a bit faster. v4: must have This is something really user want to have labels Apr 3, 2023
@asvae asvae assigned m0ksem and unassigned asvae Apr 4, 2023
@asvae
Copy link
Member Author

asvae commented Aug 9, 2023

Moved remainders into

#3673
#3674
#3675
#3676

@asvae asvae closed this as completed Aug 9, 2023
@asvae asvae added the storybook Relates to storybook label Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
d3: medium No cheats. Monsters a bit faster. epic Feature that is too big to fit in one issue implementation Requires implementation storybook Relates to storybook tests Refers to testing v4: must have This is something really user want to have
Projects
None yet
Development

No branches or pull requests

2 participants