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

Some Storybook components do not render correctly after migration #12594

Open
wants to merge 36 commits into
base: master
Choose a base branch
from

Conversation

cnotv
Copy link
Contributor

@cnotv cnotv commented Nov 13, 2024

Summary

Fixes #11707

Occurred changes and/or fixed issues

  • Fixed all the rendering issues
  • Set Welcome as homepage
  • Added Rancher Icon iframe as part of the showcase
  • Added ToC to documentation

Technical notes summary

  • Updated Storybook to 8.3
  • Defined new setup for Storybook and Vue CLI by using @storybook/vue3-webpack5
  • Migrated all the components, now split in *.story.ts (markup and logic) and .mdx (documentation, if none this is automatically generated)
  • Changed start script to avoid installation
  • Configuration adjustment round
  • Update theme configuration
  • Enabled stories to use routing with storybook-vue3-router decorator
  • Moved xterm SCSS dependency import

Note: Many components had some extra logic out of the box. This goes diametrically opposite to the style guide concept, as it should just demonstrate functionalities and use cases, not writing code. Features should work in standalone and out of the box.

Areas or cases that should be tested

Run yarn storybook after installing the packages

Areas which could experience regressions

Screenshot/Video

Screenshot 2024-11-13 at 18 45 55

Kapture.2024-11-13.at.18.47.39.mp4

Checklist

  • The PR is linked to an issue and the linked issue has a Milestone, or no issue is needed
  • The PR has a Milestone
  • The PR template has been filled out
  • The PR has been self reviewed
  • The PR has a reviewer assigned
  • The PR has automated tests or clear instructions for manual tests and the linked issue has appropriate QA labels, or tests are not needed
  • The PR has reviewed with UX and tested in light and dark mode, or there are no UX changes

@cnotv cnotv added the ci/skip-e2e Forcibly skip E2E tests in the CI label Nov 13, 2024
@rancher-ui-project-bot rancher-ui-project-bot bot added this to the v2.11.0 milestone Nov 13, 2024
@cnotv cnotv changed the title Feature/12139 storybook rendering fix Some Storybook components do not render correctly after migration Nov 13, 2024
@cnotv cnotv force-pushed the feature/12139-storybook-rendering-fix branch 3 times, most recently from 91672b5 to d7cc50a Compare November 14, 2024 21:50
@cnotv cnotv marked this pull request as ready for review November 27, 2024 10:49
@cnotv cnotv force-pushed the feature/12139-storybook-rendering-fix branch from e9a1618 to a33e24b Compare November 27, 2024 11:01
@cnotv
Copy link
Contributor Author

cnotv commented Nov 27, 2024

@rak-phillip given that I've spent way too much time on a temporary fix, I'd rather keep it as it is for the plugin resolutions.
Here's another issue for it #12687

@cnotv cnotv removed the ci/skip-e2e Forcibly skip E2E tests in the CI label Nov 27, 2024
@cnotv cnotv force-pushed the feature/12139-storybook-rendering-fix branch from 9be4f4b to 268ce49 Compare November 27, 2024 16:23
@cnotv cnotv requested a review from torchiaf November 27, 2024 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Some Storybook components do not render correctly after migration
1 participant