-
Notifications
You must be signed in to change notification settings - Fork 202
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
Re-add Storybook #4841
Re-add Storybook #4841
Conversation
9eef2ac
to
06a1744
Compare
Full-stack documentation: https://docs.openverse.org/_preview/4841 Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again. You can check the GitHub pages deployment action list to see the current status of the deployments. |
Based on the medium urgency of this PR, the following reviewers are being gently reminded to review this PR: @zackkrida Excluding weekend1 days, this PR was ready for review 4 day(s) ago. PRs labelled with medium urgency are expected to be reviewed within 4 weekday(s)2. @obulat, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! I was able to run Storybook and poke around.
However I have reservations against using an unstable version of Storybook as they have a very lax versioning policy in my mind. But that does not warrant blocking this PR.
Additionally we need to add --no-open
because running Storybook inside ov
crashes with this error:
Error: spawn xdg-open ENOENT
at ChildProcess._handle.onexit (node:internal/child_process:286:19)
at onErrorNT (node:internal/child_process:484:16)
at process.processTicksAndRejections (node:internal/process/task_queues:82:21)
Emitted 'error' event on ChildProcess instance at:
at ChildProcess._handle.onexit (node:internal/child_process:292:12)
at onErrorNT (node:internal/child_process:484:16)
at process.processTicksAndRejections (node:internal/process/task_queues:82:21) {
errno: -2,
code: 'ENOENT',
syscall: 'spawn xdg-open',
path: 'xdg-open',
spawnargs: [ 'http://localhost:54000/' ]
1e1f4b6
to
8239c5f
Compare
I added the |
47d7c02
to
b3c6545
Compare
5a74694
to
f66a345
Compare
Fixes
Fixes #4728 by @obulat
Description
This PR adds the nightly version of Storybook to the app.
While it is not ideal to use a nightly version, especially with still existing issues, having Storybook is very important for the development of the interface features such as the Dark mode.
Existing issues in Nuxt storybook module:
Other notable changes
VButton
story, we also have avariants
prop for the Variants stories that does not exist in theVButton
component), I left the component in JS because of difficulties with typingh => ()
render functions instead of thetemplate
string because of the Storybook module error (no vue compiler available, TODO: Add the error message)VButton
Testing Instructions
ov just install
and run storybookov just frontend/run storybook
.Checklist
Update index.md
).main
) or a parent feature branch.ov just catalog/generate-docs
for catalogPRs) or the media properties generator (
ov just catalog/generate-docs media-props
for the catalog or
ov just api/generate-docs
for the API) where applicable.Developer Certificate of Origin
Developer Certificate of Origin