fix: Storybookv7 update broken links

MichaelParadis commented 4 months ago

Motivations

Due to use removing the Docs tab we had to update the titles for the Docs page to remove the trailing /Docs and update links to those pages.

One thing to note is that some of our pages now have stories attached to them which adds them to the Sidebar. See screenshot below. The stories were added to the Canvases because we had some extra code snippets needed for them but in Storybook 7 you could no longer do this so we used a <Story/> to work around this. In the future we are revamping storybook and the goal will be to cleanup the organization after the version bump.

Changes

Added

Changed

Updated links to the storybook docs pages to account for the removed Docs tab

Deprecated

Removed

Fixed

fixed ColorSwatches on the Colors section in Storybook

Security

Testing

Verify that the Docs sections render correctly.
Verify that links on docs pages take you to the correct location

Changes can be tested via Pre-release

In Atlantis we use Github's built in pull request reviews.

cloudflare-workers-and-pages[bot] commented 4 months ago

Deploying atlantis with Cloudflare Pages

Latest commit:	`8fae292`
Status:	✅ Deploy successful!
Preview URL:	https://b66f9593.atlantis.pages.dev
Branch Preview URL:	https://mike-storybook-update-links.atlantis.pages.dev

View logs

taylorvnoj commented 4 months ago

In docs/README.md we have broken links in:

Design System section linking to Components/Design/Hooks
Tooling and configuration section linking to EsLint & StyleLint configuration pages
Publishing a failed release to NPM there's a link to the changelog that's broken (although that's currently broken on master, still going to the wrong place)

In docs/CONTRIBUTING.md there's a broken link:

line 199 to Card is broken ACTUALLY - the URL seems to be correct but locally, clicking the link won't work for me? Can you double check that locally?

MichaelParadis commented 4 months ago

@taylorvnoj sure thing. I think I missed the Md files and only updated the MDX files based on your comments. I will update it shortly

MichaelParadis commented 4 months ago

@taylorvnoj RE: Code sandbox, I have found that links to the code tab from our storybook are flakey (even on the main branch). My gut makes me think it is related to this: https://github.com/GetJobber/atlantis/blob/07da251e539be4a8d1c15785ecb6abaaf2a39624/.storybook/manager.js#L32-L56

I can update them to point to the canvas so it works and they can switch the tab manually

taylorvnoj commented 4 months ago

@taylorvnoj RE: Code sandbox, I have found that links to the code tab from our storybook are flakey (even on the main branch). My gut makes me think it is related to this:

Ahhh ok - I'm good with that!

GetJobber / atlantis