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

Docs: Point to styling-webpack addon in styling docs #24348

Merged
merged 3 commits into from
Oct 4, 2023

Conversation

ShaunEvening
Copy link
Contributor

@ShaunEvening ShaunEvening commented Oct 2, 2023

What I did

  • Fix snippets for addon-themes docs
  • Point users to addon-styling-webpack on styling and css page
  • Change snippets of addon-styling to use addon-styling-webpack

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

@ShaunEvening ShaunEvening added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Oct 2, 2023
@ShaunEvening ShaunEvening self-assigned this Oct 2, 2023
@ShaunEvening ShaunEvening changed the title Docs: point to styling-webpack addon in styling docs Docs: Point to styling-webpack addon in styling docs Oct 2, 2023
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@integrayshaun thanks for taking the time to make the adjustments. Appreciate it 🙏 ! All is good on my end. Merge away when able.

@@ -2,7 +2,7 @@
title: 'Styling and CSS'
---

There are many ways to include CSS in a web application, and correspondingly there are many ways to include CSS in Storybook. Usually, it is best to try and replicate what your application does with styling in Storybook’s configuration. To make this easier, we recommend using [`@storybook/addon-styling`](https://github.com/storybookjs/addon-styling).
There are many ways to include CSS in a web application, and correspondingly there are many ways to include CSS in Storybook. Usually, it is best to try and replicate what your application does with styling in Storybook’s configuration. To make this easier, we recommend using [`@storybook/addon-styling-webpack`](https://storybook.js.org/addons/@storybook/addon-styling-webpack/).
Copy link
Contributor

Choose a reason for hiding this comment

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

Worth calling out the type of projects this should (or should not) be used with?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great call out! I've added a few lines about this.

Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Nice!

@ShaunEvening ShaunEvening merged commit abe0d61 into next Oct 4, 2023
15 checks passed
@ShaunEvening ShaunEvening deleted the docs/addon-styling branch October 4, 2023 14:31
@github-actions github-actions bot mentioned this pull request Oct 4, 2023
6 tasks
storybook-bot pushed a commit that referenced this pull request Oct 4, 2023
@github-actions github-actions bot mentioned this pull request Oct 4, 2023
19 tasks
storybook-bot pushed a commit that referenced this pull request Oct 5, 2023
storybook-bot pushed a commit that referenced this pull request Oct 5, 2023
storybook-bot pushed a commit that referenced this pull request Oct 5, 2023
storybook-bot pushed a commit that referenced this pull request Oct 9, 2023
@github-actions github-actions bot mentioned this pull request Oct 9, 2023
24 tasks
storybook-bot pushed a commit that referenced this pull request Oct 13, 2023
@JReinhold JReinhold added the patch:done Patch/release PRs already cherry-picked to main/release branch label Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants