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.

Sign up for GitHub

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

Jump to bottom

feat(PPDSC-2500): add storybook urls to component pages #449

Merged
merged 21 commits into from
Nov 10, 2022
Merged

feat(PPDSC-2500): add storybook urls to component pages #449

merged 21 commits into from
Nov 10, 2022

Conversation

mstuartf
Copy link
Contributor

@mstuartf mstuartf commented Nov 2, 2022 •
edited
Loading

PPDSC-2500

What

  1. Background - why this is needed
  2. What did you do
  • Build stories.json in storybook build (contains ids used in all story urls)
  • Make build_storybook a dependency of docsite e2e tests in pipeline
  • Add a docsite cypress test to extract all storybook urls from the build and check that they are valid using stories.json
  • Add storybook button to all component docsite pages
  • Correct default story names and override component page story id if component has no default
  1. What does the reviewers should expect

I have done:

  • Written unit tests against changes
  • Written functional tests against the component and/or NewsKit site
  • Updated relevant documentation

I have tested manually:

  • The feature's functionality is working as expected on Chrome, Firefox, Safari and Edge
  • The screen reader reads and flows through the elements as expected.
  • There are no new errors in the browser console coming from this PR.
  • When visual test is not added, it renders correctly on different browsers and mobile viewports (Safari, Firefox, small mobile viewport, tablet)
  • The Playground feature is working as expected

Before:

After:

Who should review this PR:

How to test:

@mstuartf
feat(PPDSC-2500): check all storybook urls are valid
87b3b66 
- Build stories.json in storybook build (contains ids used in all story urls)
- Make build_storybook a dependency of docsite e2e tests in pipeline
- Add a docsite cypress test to extract all storybook urls from the build and check that they are valid using stories.json
@mstuartf mstuartf added draft This is a draft PR and not intended for formal review yet feature This change contains a new feature labels Nov 2, 2022
@newskit-engineering
Copy link
Collaborator

You can preview these changes on:
Documentation Site: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2500-storybook-links
Storybook: http://ncu-newskit-docs.s3-website-eu-west-1.amazonaws.com/ppdsc-2500-storybook-links/storybook

@mstuartf mstuartf changed the title feat(PPDSC-2500): check all storybook urls are valid feat(PPDSC-2500): add storybook urls to component pages Nov 3, 2022
@mstuartf mstuartf added ready for review Please assist in getting this reviewed and removed draft This is a draft PR and not intended for formal review yet labels Nov 3, 2022
@evgenitsn
Copy link
Contributor

Is it just me or the storybook icon does not load correctly?
image

evgenitsn
evgenitsn previously approved these changes Nov 7, 2022
View reviewed changes
mutebg
mutebg previously approved these changes Nov 8, 2022
View reviewed changes
@mstuartf mstuartf dismissed stale reviews from mutebg and evgenitsn via 776bf49 November 9, 2022 14:34
@mstuartf mstuartf merged commit fbf1529 into main Nov 10, 2022
@mstuartf mstuartf deleted the feat/PPDSC-2500-storybook-links branch November 10, 2022 10:02
@mstuartf mstuartf mentioned this pull request Nov 10, 2022
Merged
8 tasks
@Xin00163 Xin00163 mentioned this pull request Nov 10, 2022
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Xin00163 Xin00163 Xin00163 approved these changes

@evgenitsn evgenitsn evgenitsn approved these changes

@mutebg mutebg mutebg approved these changes

@jps jps Awaiting requested review from jps

@pdimova pdimova Awaiting requested review from pdimova

@baburay23 baburay23 Awaiting requested review from baburay23

@Vanals Vanals Awaiting requested review from Vanals

@Srinivasan-Ramasamy Srinivasan-Ramasamy Awaiting requested review from Srinivasan-Ramasamy

Assignees
No one assigned
Labels
feature This change contains a new feature ready for review Please assist in getting this reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@mstuartf @newskit-engineering @evgenitsn @mutebg @Xin00163