From 728fc894a65b538b8e71e80d0a2708520132674f Mon Sep 17 00:00:00 2001 From: Susheel Thapa Date: Sat, 21 Oct 2023 11:24:26 +0545 Subject: [PATCH 1/3] Fix:Typo in multiple files of docs and code folder --- CONTRIBUTING/RELEASING.md | 2 +- code/frameworks/nextjs/README.md | 4 ++-- code/lib/instrumenter/README.md | 2 +- code/lib/postinstall/README.md | 2 +- code/presets/create-react-app/README.md | 2 +- docs/api/main-config-core.md | 2 +- docs/sharing/publish-storybook.md | 2 +- .../angular/my-component-play-function-with-delay.ts.mdx | 2 +- .../common/my-component-play-function-with-delay.js.mdx | 2 +- .../common/my-component-play-function-with-delay.ts-4-9.mdx | 2 +- .../common/my-component-play-function-with-delay.ts.mdx | 2 +- .../my-component-play-function-with-delay.js.mdx | 2 +- .../my-component-play-function-with-delay.ts.mdx | 2 +- 13 files changed, 14 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING/RELEASING.md b/CONTRIBUTING/RELEASING.md index d1c4eecdb849..afc1bc377451 100644 --- a/CONTRIBUTING/RELEASING.md +++ b/CONTRIBUTING/RELEASING.md @@ -476,7 +476,7 @@ No process is defined for this. ### Merges to `main` without versioning -As described in more details in [the Patch Releases section](#patch-releases), there are scenarios where you want to patch [unreleasable](#which-changes-are-considered-releasable-and-what-does-it-mean) content back to `main` without bumping versions or publishing a new release. This happens automatically as long as all the unpicked patch pull requests have unreleasable labels. In that case the prepared patch pull request will change form slighty, to just cherry-picking the patches without bumping the versions. +As described in more details in [the Patch Releases section](#patch-releases), there are scenarios where you want to patch [unreleasable](#which-changes-are-considered-releasable-and-what-does-it-mean) content back to `main` without bumping versions or publishing a new release. This happens automatically as long as all the unpicked patch pull requests have unreleasable labels. In that case the prepared patch pull request will change form slightly, to just cherry-picking the patches without bumping the versions. ## FAQ diff --git a/code/frameworks/nextjs/README.md b/code/frameworks/nextjs/README.md index 01b2efd88862..d2549a159c26 100644 --- a/code/frameworks/nextjs/README.md +++ b/code/frameworks/nextjs/README.md @@ -147,7 +147,7 @@ export default { ### Options -You can be pass an options object for addional configuration if needed. +You can be pass an options object for additional configuration if needed. For example: @@ -864,7 +864,7 @@ Next.js comes with a lot of things for free out of the box like sass support, bu Any webpack modifications desired for Storybook should be made in [.storybook/main.js](https://storybook.js.org/docs/react/builders/webpack#extending-storybooks-webpack-config). -Note: Not all webpack modifications are copy/paste-able between `next.config.js` and `.storybook/main.js`. It is recommended to do your reasearch on how to properly make your modifcation to Storybook's webpack config and on how [webpack works](https://webpack.js.org/concepts/). +Note: Not all webpack modifications are copy/paste-able between `next.config.js` and `.storybook/main.js`. It is recommended to do your research on how to properly make your modification to Storybook's webpack config and on how [webpack works](https://webpack.js.org/concepts/). Below is an example of how to add svgr support to Storybook with this framework. diff --git a/code/lib/instrumenter/README.md b/code/lib/instrumenter/README.md index 6bc121553189..74fe933067d9 100644 --- a/code/lib/instrumenter/README.md +++ b/code/lib/instrumenter/README.md @@ -1,6 +1,6 @@ # Storybook Instrumenter -The Storybook Instrumenter is used to patch a (3rd party) module to track and intercept function invocations for step-through debugging using the Interactions addon. In essense, the Instrumenter traverses a given object, recursively monkey-patching any functions to make them "tracked". +The Storybook Instrumenter is used to patch a (3rd party) module to track and intercept function invocations for step-through debugging using the Interactions addon. In essence, the Instrumenter traverses a given object, recursively monkey-patching any functions to make them "tracked". During normal operation, tracked functions simply call through to their original function, forwarding the return value. As a side-effect, they also emit a `call` event whenever they are invoked. diff --git a/code/lib/postinstall/README.md b/code/lib/postinstall/README.md index 73c776f45db8..44d12ca595b5 100644 --- a/code/lib/postinstall/README.md +++ b/code/lib/postinstall/README.md @@ -1,4 +1,4 @@ -# Storybook Postinstall Utilties +# Storybook Postinstall Utilities A minimal utility library for addons to update project configurations after the addon is installed via the [Storybook CLI](https://github.com/storybookjs/storybook/tree/main/lib/cli), e.g. `sb add docs`. diff --git a/code/presets/create-react-app/README.md b/code/presets/create-react-app/README.md index c4fa437a5db7..c20a9d2e7672 100644 --- a/code/presets/create-react-app/README.md +++ b/code/presets/create-react-app/README.md @@ -87,7 +87,7 @@ module.exports = { ### Custom `react-scripts` packages -In most cases, this preset will find your `react-scripts` package, even if it's a fork of the offical `react-scripts`. +In most cases, this preset will find your `react-scripts` package, even if it's a fork of the official `react-scripts`. In the event that it doesn't, you can set the package's name with `scriptsPackageName`. diff --git a/docs/api/main-config-core.md b/docs/api/main-config-core.md index 56c8cf978208..f2c16bf04913 100644 --- a/docs/api/main-config-core.md +++ b/docs/api/main-config-core.md @@ -204,4 +204,4 @@ Enable crash reports to be sent to Storybook [telemetry](../configure/telemetry. Type: `RendererName` - + diff --git a/docs/sharing/publish-storybook.md b/docs/sharing/publish-storybook.md index 1748a54049b9..96d4a1eaefb6 100644 --- a/docs/sharing/publish-storybook.md +++ b/docs/sharing/publish-storybook.md @@ -166,7 +166,7 @@ Examples: [Netlify](https://www.netlify.com/), [S3](https://aws.amazon.com/en/s3 ## Search engine optimization (SEO) -If your Storybook is publically viewable, you may wish to configure how it is represented in search engine result pages. +If your Storybook is publicly viewable, you may wish to configure how it is represented in search engine result pages. ### Description diff --git a/docs/snippets/angular/my-component-play-function-with-delay.ts.mdx b/docs/snippets/angular/my-component-play-function-with-delay.ts.mdx index 91b835eee7e8..6d5648a642fa 100644 --- a/docs/snippets/angular/my-component-play-function-with-delay.ts.mdx +++ b/docs/snippets/angular/my-component-play-function-with-delay.ts.mdx @@ -24,7 +24,7 @@ export const DelayedStory: Story = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the ammount of milliseconds between characters being typed + // The delay option set the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); diff --git a/docs/snippets/common/my-component-play-function-with-delay.js.mdx b/docs/snippets/common/my-component-play-function-with-delay.js.mdx index ace73e5f0ace..0cf7440c3c2d 100644 --- a/docs/snippets/common/my-component-play-function-with-delay.js.mdx +++ b/docs/snippets/common/my-component-play-function-with-delay.js.mdx @@ -18,7 +18,7 @@ export const DelayedStory = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the ammount of milliseconds between characters being typed + // The delay option set the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); diff --git a/docs/snippets/common/my-component-play-function-with-delay.ts-4-9.mdx b/docs/snippets/common/my-component-play-function-with-delay.ts-4-9.mdx index 690a07110717..38aa23283955 100644 --- a/docs/snippets/common/my-component-play-function-with-delay.ts-4-9.mdx +++ b/docs/snippets/common/my-component-play-function-with-delay.ts-4-9.mdx @@ -24,7 +24,7 @@ export const DelayedStory: Story = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the ammount of milliseconds between characters being typed + // The delay option set the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); diff --git a/docs/snippets/common/my-component-play-function-with-delay.ts.mdx b/docs/snippets/common/my-component-play-function-with-delay.ts.mdx index ac62dd697b9e..5996c79e3210 100644 --- a/docs/snippets/common/my-component-play-function-with-delay.ts.mdx +++ b/docs/snippets/common/my-component-play-function-with-delay.ts.mdx @@ -24,7 +24,7 @@ export const DelayedStory: Story = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the ammount of milliseconds between characters being typed + // The delay option set the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); diff --git a/docs/snippets/web-components/my-component-play-function-with-delay.js.mdx b/docs/snippets/web-components/my-component-play-function-with-delay.js.mdx index 4a5a8c0c03bf..60f9a6e971ff 100644 --- a/docs/snippets/web-components/my-component-play-function-with-delay.js.mdx +++ b/docs/snippets/web-components/my-component-play-function-with-delay.js.mdx @@ -16,7 +16,7 @@ export const DelayedStory = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the ammount of milliseconds between characters being typed + // The delay option set the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); diff --git a/docs/snippets/web-components/my-component-play-function-with-delay.ts.mdx b/docs/snippets/web-components/my-component-play-function-with-delay.ts.mdx index 9c832c572eab..6bc6c863b7a3 100644 --- a/docs/snippets/web-components/my-component-play-function-with-delay.ts.mdx +++ b/docs/snippets/web-components/my-component-play-function-with-delay.ts.mdx @@ -20,7 +20,7 @@ export const DelayedStory: Story = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the ammount of milliseconds between characters being typed + // The delay option set the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); From 7b2167af4796c43f1e8ce4632d102359dbfcdf75 Mon Sep 17 00:00:00 2001 From: Susheel Thapa Date: Thu, 26 Oct 2023 06:36:20 +0545 Subject: [PATCH 2/3] Updated wording --- .../common/my-component-play-function-with-delay.ts.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/snippets/common/my-component-play-function-with-delay.ts.mdx b/docs/snippets/common/my-component-play-function-with-delay.ts.mdx index 5996c79e3210..d23737666c79 100644 --- a/docs/snippets/common/my-component-play-function-with-delay.ts.mdx +++ b/docs/snippets/common/my-component-play-function-with-delay.ts.mdx @@ -24,7 +24,7 @@ export const DelayedStory: Story = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the amount of milliseconds between characters being typed + // The delay option sets the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); From b03f4025c40fc3ed2f6a3d9a35d8d5d958f136b6 Mon Sep 17 00:00:00 2001 From: Susheel Thapa Date: Fri, 27 Oct 2023 07:23:00 +0545 Subject: [PATCH 3/3] fix wording in multiple files --- .../angular/my-component-play-function-with-delay.ts.mdx | 2 +- .../common/my-component-play-function-with-delay.js.mdx | 2 +- .../common/my-component-play-function-with-delay.ts-4-9.mdx | 2 +- .../web-components/my-component-play-function-with-delay.js.mdx | 2 +- .../web-components/my-component-play-function-with-delay.ts.mdx | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/snippets/angular/my-component-play-function-with-delay.ts.mdx b/docs/snippets/angular/my-component-play-function-with-delay.ts.mdx index 6d5648a642fa..1160573a8c8e 100644 --- a/docs/snippets/angular/my-component-play-function-with-delay.ts.mdx +++ b/docs/snippets/angular/my-component-play-function-with-delay.ts.mdx @@ -24,7 +24,7 @@ export const DelayedStory: Story = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the amount of milliseconds between characters being typed + // The delay option sets the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); diff --git a/docs/snippets/common/my-component-play-function-with-delay.js.mdx b/docs/snippets/common/my-component-play-function-with-delay.js.mdx index 0cf7440c3c2d..32a66062e557 100644 --- a/docs/snippets/common/my-component-play-function-with-delay.js.mdx +++ b/docs/snippets/common/my-component-play-function-with-delay.js.mdx @@ -18,7 +18,7 @@ export const DelayedStory = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the amount of milliseconds between characters being typed + // The delay option sets the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); diff --git a/docs/snippets/common/my-component-play-function-with-delay.ts-4-9.mdx b/docs/snippets/common/my-component-play-function-with-delay.ts-4-9.mdx index 38aa23283955..1494692a1793 100644 --- a/docs/snippets/common/my-component-play-function-with-delay.ts-4-9.mdx +++ b/docs/snippets/common/my-component-play-function-with-delay.ts-4-9.mdx @@ -24,7 +24,7 @@ export const DelayedStory: Story = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the amount of milliseconds between characters being typed + // The delay option sets the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); diff --git a/docs/snippets/web-components/my-component-play-function-with-delay.js.mdx b/docs/snippets/web-components/my-component-play-function-with-delay.js.mdx index 60f9a6e971ff..048158d5ab64 100644 --- a/docs/snippets/web-components/my-component-play-function-with-delay.js.mdx +++ b/docs/snippets/web-components/my-component-play-function-with-delay.js.mdx @@ -16,7 +16,7 @@ export const DelayedStory = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the amount of milliseconds between characters being typed + // The delay option sets the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, }); diff --git a/docs/snippets/web-components/my-component-play-function-with-delay.ts.mdx b/docs/snippets/web-components/my-component-play-function-with-delay.ts.mdx index 6bc6c863b7a3..c3ea6b38dc81 100644 --- a/docs/snippets/web-components/my-component-play-function-with-delay.ts.mdx +++ b/docs/snippets/web-components/my-component-play-function-with-delay.ts.mdx @@ -20,7 +20,7 @@ export const DelayedStory: Story = { const exampleElement = canvas.getByLabelText('example-element'); - // The delay option set the amount of milliseconds between characters being typed + // The delay option sets the amount of milliseconds between characters being typed await userEvent.type(exampleElement, 'random string', { delay: 100, });