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

Docs2: Extract doc blocks into a separate package #18587

Merged
merged 11 commits into from
Jun 29, 2022

Conversation

shilman
Copy link
Member

@shilman shilman commented Jun 28, 2022

Issue: N/A

What I did

Joint work with @okonet. This replaces #18429 which got somehow very tangled in git despite being a set of relatively simple changes.

  • Created a @storybook/blocks package
  • Created an examples/doc-blocks storybook
  • Pulled components out of @storybook/components
  • Lightly refactored some other packages to use @storybook/blocks where appropriate

How to test

  • CI passes

Also:

yarn bootstrap --core
cd examples/doc-blocks
yarn storybook

@nx-cloud
Copy link

nx-cloud bot commented Jun 28, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 36027e1. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@shilman shilman requested a review from tmeasday June 28, 2022 16:21
@shilman shilman added maintenance User-facing maintenance tasks addon: docs labels Jun 28, 2022
@tmeasday
Copy link
Member

@shilman do you want to pull @lifeiscontent's changes from #18478 too?

Comment on lines 37 to 46
"@storybook/addons": "7.0.0-alpha.6",
"@storybook/api": "7.0.0-alpha.6",
"@storybook/client-logger": "7.0.0-alpha.6",
"@storybook/components": "7.0.0-alpha.6",
"@storybook/core-events": "7.0.0-alpha.6",
"@storybook/csf": "0.0.2--canary.7c6c115.0",
"@storybook/docs-tools": "7.0.0-alpha.6",
"@storybook/preview-web": "7.0.0-alpha.6",
"@storybook/store": "7.0.0-alpha.6",
"@storybook/theming": "7.0.0-alpha.6",
Copy link
Member

Choose a reason for hiding this comment

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

How are we thinking about the dependencies of this package? We might need to discuss @shilman. In particular I am interested in the thinking behind pulling some but not all of the dependencies from @storybook/components into this package.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ideally this doesn't pull anything form @storybook/components, but I think we'll need to tackle that later on.

@ndelangen ndelangen self-assigned this Jun 29, 2022
…drewluca/18323

# Conflicts:
#	.circleci/config.yml
#	SECURITY.md
#	addons/a11y/src/components/VisionSimulator.test.tsx
#	app/vue/src/client/preview/config.ts
#	app/vue3/src/client/preview/config.ts
#	docs/addons/writing-addons.md
#	docs/api/cli-options.md
#	docs/builders/webpack.md
#	docs/configure/css-troubleshooting/angular.mdx
#	docs/contribute/code.md
#	docs/contribute/new-snippets.md
#	docs/essentials/interactions.md
#	docs/essentials/introduction.md
#	docs/faq.md
#	docs/get-started/install.md
#	docs/sharing/publish-storybook.md
#	docs/snippets/common/button-story-project-args-theme.js.mdx
#	docs/snippets/common/storybook-main-enable-transcludemarkdown.js.mdx
#	docs/snippets/common/storybook-main-with-single-static-dir.js.mdx
#	docs/snippets/common/storybook-test-runner-install.npm.js.mdx
#	docs/snippets/common/storybook-test-runner-install.yarn.js.mdx
#	docs/snippets/common/storybook-vite-builder-aliasing.js.mdx
#	docs/writing-stories/build-pages-with-storybook.md
#	docs/writing-stories/play-function.md
#	docs/writing-tests/snapshot-testing.md
#	docs/writing-tests/visual-testing.md
#	examples/vue-3-cli/.storybook/main.js
#	examples/vue-cli/.storybook/main.js
#	examples/vue-kitchen-sink/.storybook/main.js
#	examples/vue-kitchen-sink/.storybook/preview.js
#	examples/vue-kitchen-sink/src/App.vue
#	examples/vue-kitchen-sink/src/stories/__snapshots__/core.stories.storyshot
#	examples/vue-kitchen-sink/src/stories/__snapshots__/custom-decorators.stories.storyshot
#	examples/vue-kitchen-sink/src/stories/core.stories.js
#	lib/cli/src/generators/ANGULAR/angular-helpers.ts
#	lib/cli/src/generators/ANGULAR/index.ts
#	lib/components/package.json
#	lib/components/src/blocks/ArgsTable/ArgsTable.tsx
#	lib/components/src/blocks/Source.tsx
#	lib/components/src/spaced/Spaced.tsx
#	lib/components/src/tabs/tabs.tsx
#	lib/core-server/package.json
#	lib/preview-web/src/Preview.tsx
#	lib/preview-web/src/PreviewWeb.integration.test.ts
#	lib/preview-web/src/PreviewWeb.mockdata.ts
#	lib/preview-web/src/PreviewWeb.test.ts
#	lib/preview-web/src/PreviewWeb.tsx
#	lib/ui/src/index.tsx
#	yarn.lock
# Conflicts:
#	addons/controls/package.json
#	addons/docs/package.json
#	yarn.lock
@ndelangen ndelangen merged commit eff9366 into future/base Jun 29, 2022
@ndelangen ndelangen deleted the future/doc-blocks-take2 branch June 29, 2022 13:14
@shilman shilman mentioned this pull request Jul 14, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants