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

Move gatsby docs to Storybook #2488

Merged
merged 5 commits into from
Jul 12, 2023
Merged

Move gatsby docs to Storybook #2488

merged 5 commits into from
Jul 12, 2023

Conversation

langermank
Copy link
Contributor

@langermank langermank commented Jul 12, 2023

What are you trying to accomplish?

This is part 1 of moving all Gatsby content to Storybook to support the new docs IA. Part 2 includes upgrading Storybook to improve the markdown docs experience, and removing Gatsby completely.

I had to break this into two PRs because Gatsby doesn't like the Storybook 7 upgrade and I've wasted days trying to fix it. Once this PR is merged, I'll set up redirects to the Storybook markdown doc pages so we can safely delete Gatsby in the followup.

What approach did you choose and why?

  • Copy code examples and markdown from Gatsby
  • Bare minimum Storybook config. Docs are not working as expected but this will be solved with the upgrade to SB7
  • Only write stories for components that do not exist in PVC

What should reviewers focus on?

  • Check the Storybook deploy and make sure you can access the written docs content

Can these changes ship as is?

  • Yes, this PR does not depend on additional changes. 🚢

@changeset-bot
Copy link

changeset-bot bot commented Jul 12, 2023

⚠️ No Changeset found

Latest commit: 1ada626

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@langermank langermank temporarily deployed to github-pages July 12, 2023 03:56 — with GitHub Actions Inactive
@github-actions github-actions bot temporarily deployed to Storybook Preview July 12, 2023 03:56 Inactive
@langermank langermank temporarily deployed to github-pages July 12, 2023 14:47 — with GitHub Actions Inactive
@github-actions github-actions bot temporarily deployed to Storybook Preview July 12, 2023 14:48 Inactive
@github-actions github-actions bot temporarily deployed to Storybook Preview July 12, 2023 15:13 Inactive
@langermank langermank marked this pull request as ready for review July 12, 2023 15:20
@langermank langermank requested a review from a team as a code owner July 12, 2023 15:20
@langermank langermank requested a review from jonrohan July 12, 2023 15:20
@langermank langermank merged commit acc29de into main Jul 12, 2023
12 checks passed
@langermank langermank deleted the move-gatsby-docs-storybook branch July 12, 2023 15:28
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.

2 participants