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

Documentation: Document @storybook/test package #24263

Merged
merged 8 commits into from
Nov 3, 2023

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Sep 21, 2023

Relates to #23871

What I did

This PR proposes changes to the documentation in Storybook 8, following the requirements of #23871, to:

  • use @storybook/test instead of @storybook/testing-library and @storybook/jest in every setup docs
  • use @storybook/test instead of @storybook/testing-library and @storybook/jest in every code snippet
  • de-emphasize argTypesRegex
  • revamp Addon-actions docs to mention about the explicit fn functions and its connection to actions panel

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

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.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@yannbf yannbf added documentation ci:docs Run the CI jobs for documentation checks only. labels Sep 21, 2023
@cdedreuille cdedreuille changed the base branch from v8 to release-8-0 September 22, 2023 14:27
@kylegach
Copy link
Contributor

kylegach commented Oct 6, 2023

Noting for posterity:

Once this PR is merged, two things need to happen, in this order (ping me to do it):

  1. Configure frontpage's Netlify to build the release-8-0 branch
  2. Merge Hide v8 from VersionSelector menu frontpage#603

@ndelangen
Copy link
Member

@kasperpeulen @yannbf Is this ready?

@yannbf
Copy link
Member Author

yannbf commented Oct 31, 2023

Like we discussed yesterday, there might be the need of writing a migration note, and checking whether the new package clashes with the other packages (sb/testing-lib, sb/jest)

@kasperpeulen can you do that?

@kasperpeulen
Copy link
Contributor

kasperpeulen commented Nov 1, 2023

@kylegach I would like to merge this PR and get it in the docs, if you are okay with that :)

@yannbf I found that the packages don't clash anymore, and can be used together in stories, when migrating.
Shall we make the migration note part of this PR?

I think it would be good already start documenting the test package also in the README of the package as @IanVS suggested.

Copy link
Contributor

@kasperpeulen kasperpeulen left a comment

Choose a reason for hiding this comment

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

LGTM!

@yannbf
Copy link
Member Author

yannbf commented Nov 2, 2023

@yannbf I found that the packages don't clash anymore, and can be used together in stories, when migrating. Shall we make the migration note part of this PR?

I think it would be good already start documenting the test package also in the README of the package as @IanVS suggested.

Yes please, feel free to do that!

@kasperpeulen kasperpeulen force-pushed the yann/storybook-test-docs branch from 629671c to c92f92a Compare November 2, 2023 10:46
@kasperpeulen kasperpeulen merged commit 63762dc into release-8-0 Nov 3, 2023
@kasperpeulen kasperpeulen deleted the yann/storybook-test-docs branch November 3, 2023 08:09
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants