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

Update Compound Timeline microsite #3097

Open
9 tasks done
jpveooys opened this issue Feb 16, 2022 · 1 comment
Open
9 tasks done

Update Compound Timeline microsite #3097

jpveooys opened this issue Feb 16, 2022 · 1 comment
Assignees
Labels
Docs: Component Package: compound-timeline Package/code type Release: Next major Release version Size: Small Assessed as small task

Comments

@jpveooys
Copy link
Contributor

jpveooys commented Feb 16, 2022

Description

The documentation on the Compound Timeline microsite needs updating for v3.

This incudes:

  • updating information about render props
  • updating the TimelineContext example
  • updating the Custom Component Presentation example
  • removing TimelineSide
  • updating the signature of useTimelinePosition to indicate endDate is optional
  • updating the Storybook link
  • updating package names in installation instructions and code samples
  • updating the changelog link
  • updating Royal Navy reference in footer

This is not a comprehensive list; there may be other things that need updating.

@jpveooys jpveooys added Package: compound-timeline Package/code type Release: Next major Release version Size: Small Assessed as small task Docs: Component labels Feb 16, 2022
@ahwcikxz ahwcikxz added this to Candidates for Ready in Tactical Board Feb 16, 2022
@jpveooys jpveooys moved this from Candidates for Ready to Candidates for Ready (v3) in Tactical Board Feb 16, 2022
@thyhjwb6 thyhjwb6 moved this from Candidates for Ready (v3) to Ready in Tactical Board Feb 17, 2022
@jpveooys jpveooys self-assigned this Feb 22, 2022
@jpveooys jpveooys moved this from Ready to In Progress in Tactical Board Feb 22, 2022
@jpveooys
Copy link
Contributor Author

jpveooys commented Feb 23, 2022

Updates have been made to the staging environment for the content changes (except for the TimelineContext example).

Some code changes are also required, I've made a start on this branch:

https://github.com/defencedigital/design-system-docs/compare/feature/timeline-v3?expand=1

(Unfortunately, it seems Storybook is broken at the moment – I've tried to fix it but there still remains some problem related to icons/SVGR. It may be easier to downgrade that loader than try to update to Webpack 5 as I was.)

@jpveooys jpveooys moved this from In Progress to In Review in Tactical Board Mar 1, 2022
@jpveooys jpveooys moved this from In Review to Done in Tactical Board Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs: Component Package: compound-timeline Package/code type Release: Next major Release version Size: Small Assessed as small task
Projects
Development

No branches or pull requests

1 participant