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

feat: adds storybook #956

Merged
merged 1 commit into from
Nov 24, 2023
Merged

Conversation

jkilzi
Copy link
Member

@jkilzi jkilzi commented Nov 21, 2023

FLPATH-701

This PR adds Storybook. A playground for testing and developing UI components in isolation.

Usage

Two new top-level scripts where added: start:storybook and build:storybook, the later builds a static website which is useful for showcasing Storybook's stories.

yarn --cwd storybook install
yarn start:storybook [plugins/<frontend-plugin-name>]

Notes:

  1. If no plugins/<plugin-name> is passed, the process will scan for stories inside each plugin workspace.
  2. To make a build of Storybook use: yarn build:storybook [plugins/<frontend-plugin-name>].
    This command produces a directory called packages/storybook/storybook-static. This directory can be then rendered
    using a static web server.

Resources

@jkilzi jkilzi requested review from a team as code owners November 21, 2023 06:50
@invincibleJai
Copy link
Member

@tumido FYI ^^

@jkilzi jkilzi force-pushed the tasks/upstream/FLPATH-701 branch from e9578ed to fb23c21 Compare November 21, 2023 13:42
@jkilzi jkilzi force-pushed the tasks/upstream/FLPATH-701 branch 4 times, most recently from 183177c to c5285df Compare November 22, 2023 06:33
FLPATH-701

chore: address PR issues

Changes:
1. Removes the examples directory and related code.
2. Removes @storybook/addon-onboarding
3. Updates deps: @testing-library/jest-dom": "^5.17.0, @backstage/test-utils": "^1.4.4
4. Removes custom prettier config inside the storybook package
5. Fixes code-style issues

docs: updates Storybook's README file

chore: ignore .idea/ folder
@jkilzi jkilzi force-pushed the tasks/upstream/FLPATH-701 branch from c5285df to 9804f58 Compare November 22, 2023 09:46
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@jkilzi
Copy link
Member Author

jkilzi commented Nov 22, 2023

@invincibleJai I'd like to mark the conversation as resolved, do you have anything to add?

@invincibleJai
Copy link
Member

invincibleJai commented Nov 22, 2023

@invincibleJai I'd like to mark the conversation as resolved, do you have anything to add?

HI @jkilzi, I have looked at it and will try it. Would be nice to have some components as part of the story book as a starting point and I would like some more eyes on this as this would be used by any other plugins to contribute in the future. currently team is a bit occupied so expect some delays

cc @tumido @jerolimov @gashcrumb

@jkilzi
Copy link
Member Author

jkilzi commented Nov 22, 2023

@invincibleJai I'd like to mark the conversation as resolved, do you have anything to add?

HI @jkilzi, I have looked at it and will try it. Would be nice to have some components as part of the story book as a starting point and I would like some more eyes on this as this would be used by any other plugins to contribute in the future. currently team is a bit occupied so expect some delays

cc @tumido @jerolimov @gashcrumb

You can also see it in action in this PR caponetto#24, I implemented a story for the Orchestrator plugin there

Copy link
Member

@tumido tumido left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@tumido
Copy link
Member

tumido commented Nov 23, 2023

@invincibleJai do you want any more 👀 on this or are we fine to merge it? 🙂 I've resolved the conversations above, the justification provided by @jkilzi makes sense to me. I don't want to hold the team hostage by our release more than necessary and the code looks good to me. 🙂

@invincibleJai
Copy link
Member

/lgtm

@invincibleJai invincibleJai merged commit 4dda929 into janus-idp:main Nov 24, 2023
6 checks passed
@jkilzi jkilzi deleted the tasks/upstream/FLPATH-701 branch November 27, 2023 09:41
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.

3 participants