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

chore(repo): add addon-docs, remove addon-info and storybook-readme #2414

Merged
merged 22 commits into from
Jun 29, 2021

Conversation

kevinsperrine
Copy link
Collaborator

@kevinsperrine kevinsperrine commented Jun 15, 2021

Closes #963
Closes #2418

Blocked until #2359 and #2336 are merged.

Summary

  • removes @storybook/addon-info
  • removed storybook-readme
  • replaces them with @storybook/addon-docs
  • renames all existing MD files to MDX, and uses them as the basis for the new docs tab.
  • sets a resolution for webpack 4, because of an incompatibility with an old webpack 4.28 version in the lockfile. 4.41 works fine.

Change List (commits, features, bugs, etc)
Component w/ stories using storybook-readme that were updated

  • ListBuilder
  • MapCard
  • MenuButton
  • MultSelect
  • OverflowMenu
  • Table

Acceptance Test (how to verify the PR)

  • Clicking the new "Docs" tab (beside "Canvas" at the top left of the main storybook window) for any of the stories above should show their current docs
  • The "Readme" tab should do longer appear

Regression Test (how to make sure this PR doesn't break old functionality)

  • All stories should still function as expected

@netlify
Copy link

netlify bot commented Jun 15, 2021

✔️ Deploy Preview for ai-apps-pal-angular ready!

🔨 Explore the source changes: 0778f98

🔍 Inspect the deploy log: https://app.netlify.com/sites/ai-apps-pal-angular/deploys/60da0f237101ae0008730605

😎 Browse the preview: https://deploy-preview-2414--ai-apps-pal-angular.netlify.app/iframe

@netlify
Copy link

netlify bot commented Jun 15, 2021

✔️ Deploy Preview for carbon-addons-iot-react ready!

🔨 Explore the source changes: 0778f98

🔍 Inspect the deploy log: https://app.netlify.com/sites/carbon-addons-iot-react/deploys/60da0f236cb43300073a7362

😎 Browse the preview: https://deploy-preview-2414--carbon-addons-iot-react.netlify.app/iframe

package.json Outdated Show resolved Hide resolved
Copy link
Contributor

@bjornalm bjornalm left a comment

Choose a reason for hiding this comment

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

Nice work, a small changes needed and there were some questions about dependencies

package.json Show resolved Hide resolved
packages/react/package.json Show resolved Hide resolved
packages/react/src/components/MapCard/MapCard.mdx Outdated Show resolved Hide resolved
@bjornalm
Copy link
Contributor

We have a problem with the new docs and modals:
image
image

@kevinsperrine
Copy link
Collaborator Author

We have a problem with the new docs and modals:
image
image

nice catch! I'll copy the MDX file from Carbon to prevent it and give better docs--this probably something we'll need to do eventually anyway, I assume. We were hoping carbon would bundle the MDX and we could just use then, but I don't know if that's going to happen or not.

.github/README.MD Outdated Show resolved Hide resolved
@bjornalm
Copy link
Contributor

We have a problem with the new docs and modals:
...
nice catch! I'll copy the MDX file from Carbon to prevent it and give better docs--this probably something we'll need to do eventually anyway, I assume. We were hoping carbon would bundle the MDX and we could just use then, but I don't know if that's going to happen or not.

It is not just the modal, but all stories that use the modal as well :-)

Copy link
Contributor

@bjornalm bjornalm left a comment

Choose a reason for hiding this comment

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

Nice work!

@kodiakhq kodiakhq bot merged commit 4c45440 into next Jun 29, 2021
@kodiakhq kodiakhq bot deleted the 963-addon-docs branch June 29, 2021 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants