From b70264e997d7f47ffbc935bfd9b1d87bee14ea19 Mon Sep 17 00:00:00 2001 From: jonniebigodes Date: Fri, 3 Nov 2023 20:11:50 +0000 Subject: [PATCH 1/2] Docs: Fix Discord links and GH discussions --- code/addons/controls/README.md | 2 +- docs/addons/addon-migration-guide.md | 2 +- docs/addons/integration-catalog.md | 2 +- docs/builders/builder-api.md | 2 +- docs/configure/frameworks.md | 2 +- docs/configure/typescript.md | 2 +- docs/contribute/framework.md | 2 +- docs/contribute/how-to-contribute.md | 2 +- docs/migration-guide.md | 1 - docs/writing-docs/autodocs.md | 4 ++-- docs/writing-docs/mdx.md | 4 ++-- 11 files changed, 12 insertions(+), 13 deletions(-) diff --git a/code/addons/controls/README.md b/code/addons/controls/README.md index cb37957a0766..21bc1f2db367 100644 --- a/code/addons/controls/README.md +++ b/code/addons/controls/README.md @@ -44,7 +44,7 @@ Addon-knobs is one of Storybook's most popular addons with over 1M weekly downlo Therefore, rather than deprecating addon-knobs immediately, we will continue to release knobs with the Storybook core distribution until 7.0. This will give us time to improve Controls based on user feedback, and also give knobs users ample time to migrate. -If you are somehow tied to knobs or prefer the knobs interface, we are happy to take on maintainers for the knobs project. If this interests you, hop on our [Discord](https://discord.gg/storybook). +If you are somehow tied to knobs or prefer the knobs interface, we are happy to take on maintainers for the knobs project. If this interests you, please get in touch with us in the [`#contributing`](https://discord.com/channels/486522875931656193/839297503446695956) Discord channel. ### How do I migrate from addon-knobs? diff --git a/docs/addons/addon-migration-guide.md b/docs/addons/addon-migration-guide.md index f3e8b78a4812..8f71956c62d4 100644 --- a/docs/addons/addon-migration-guide.md +++ b/docs/addons/addon-migration-guide.md @@ -75,4 +75,4 @@ We also recommend releasing your own addon using the `next` tag to test it out i ## Support -If you’ve followed this guide and your addon is still not working, please reach out on the [Storybook Discord](https://discord.gg/storybook) in the `#addons` channel and we’ll help you get to the bottom of it and upgrade the guide accordingly. +If you're still having issues with your addon after following this guide, please open [new discussion](https://github.com/storybookjs/storybook/discussions/new?category=help) in our GitHub repository. We will assist you in resolving the issue and update this guide accordingly. diff --git a/docs/addons/integration-catalog.md b/docs/addons/integration-catalog.md index e2d1215c0a93..c94160498d3c 100644 --- a/docs/addons/integration-catalog.md +++ b/docs/addons/integration-catalog.md @@ -100,7 +100,7 @@ Not finding the recipe that you want? If it's popular in the community, our docs ### Request a recipe -If you'd like to request a recipe, head over to the [#maintenance channel](https://discord.com/channels/486522875931656193/490070912448724992) of our community Discord and ask. +If you'd like to request a recipe, open a [new discussion](https://github.com/storybookjs/storybook/discussions/new?category=ideas) in our GitHub repo. We'll review your request, and if it's popular, we'll add it to our backlog and prioritize it. ## Learn more about the Storybook addon ecosystem diff --git a/docs/builders/builder-api.md b/docs/builders/builder-api.md index 056a96144a78..04dd91e6710b 100644 --- a/docs/builders/builder-api.md +++ b/docs/builders/builder-api.md @@ -155,7 +155,7 @@ While running in development mode, the builder's development server must be able ### More information -This area is under rapid development, so the documented is still in progress and subject to change. If you are interested in writing your builder, we encourage you to check [webpack](https://github.com/storybookjs/storybook/tree/next/code/builders/builder-webpack5), [Vite](https://github.com/storybookjs/storybook/tree/next/code/builders/builder-vite), and Modern Web's [dev-server-storybook](https://github.com/modernweb-dev/web/blob/master/packages/dev-server-storybook/src/serve/storybookPlugin.ts) source code. In addition, we have a wonderful contributor community on [Storybook Discord](https://discord.gg/storybook) if you have questions. Ping us in the [#contributing](https://discord.com/channels/486522875931656193/839297503446695956) channel. +This area is under rapid development, and the associated documentation is still in progress and subject to change. If you are interested in writing your builder, we encourage you to take a look at the source code for [Webpack](https://github.com/storybookjs/storybook/tree/next/code/builders/builder-webpack5), [Vite](https://github.com/storybookjs/storybook/tree/next/code/builders/builder-vite). Modern Web's [dev-server-storybook](https://github.com/modernweb-dev/web/blob/master/packages/dev-server-storybook/src/serve/storybookPlugin.ts) to get a better understanding of how to implement a builder for Storybook, when you are ready open a [RFC](../contribute/RFC.md) to discuss your proposal with the community and the maintainers. #### Learn more about builders diff --git a/docs/configure/frameworks.md b/docs/configure/frameworks.md index fc9010251423..3b7e93008bdd 100644 --- a/docs/configure/frameworks.md +++ b/docs/configure/frameworks.md @@ -64,7 +64,7 @@ Storybook is a framework-agnostic tool. It can be used with any framework. Howev ### Legacy framework support -We're deprecating support for several frameworks, including [Aurelia](https://github.com/aurelia/framework), [Marionette](https://github.com/marionettejs/backbone.marionette), [Mithril](https://github.com/MithrilJS/mithril.js), [Rax](https://github.com/alibaba/rax), and [Riot](https://github.com/riot/riot). Nevertheless, we're always looking for help maintaining these frameworks. If you're working with one of them and you want to continue supporting them, visit the dedicated [Storybook End-of-Life repository](https://github.com/storybook-eol) to learn more about the sunsetting process and for instructions on how to contribute visit our [Discord server](https://discord.gg/storybook). +We're deprecating support for several frameworks, including [Aurelia](https://github.com/aurelia/framework), [Marionette](https://github.com/marionettejs/backbone.marionette), [Mithril](https://github.com/MithrilJS/mithril.js), [Rax](https://github.com/alibaba/rax), and [Riot](https://github.com/riot/riot). Nevertheless, we're always looking for help maintaining these frameworks. If you're working with one of them and you want to continue supporting them, visit the dedicated [Storybook End-of-Life repository](https://github.com/storybook-eol) to learn more about the sunsetting process and for instructions on how to contribute read our [documentation](https://storybook.js.org/docs/react/contribute/how-to-contribute). ### Learn about configuring Storybook diff --git a/docs/configure/typescript.md b/docs/configure/typescript.md index ba89ad2dcca4..45c93a41ed52 100644 --- a/docs/configure/typescript.md +++ b/docs/configure/typescript.md @@ -90,7 +90,7 @@ Now, when you define a story or update an existing one, you'll automatically get ### The `satisfies` operator is not working as expected -Out of the box, Storybook supports the `satisfies` operator for almost every framework already using TypeScript version 4.9 or higher. However, due to the constraints of the Angular and Web Components framework, you might run into issues when applying this operator for additional type safety. This is primarily due to how both frameworks are currently implemented, making it almost impossible for Storybook to determine if the component property is required. If you encounter this issue, we recommend reaching out to the maintainers using the default communication channels (e.g., [Discord server](https://discord.com/channels/486522875931656193/570426522528382976), [GitHub discussion](https://github.com/storybookjs/storybook/discussions/20988)). +Out of the box, Storybook supports the `satisfies` operator for almost every framework already using TypeScript version 4.9 or higher. However, due to the constraints of the Angular and Web Components framework, you might run into issues when applying this operator for additional type safety. This is primarily due to how both frameworks are currently implemented, making it almost impossible for Storybook to determine if the component property is required. If you encounter this issue, we recommend reaching out to the maintainers using the default communication channels (e.g., [Discord's Angular Working Group channel](https://discord.com/channels/486522875931656193/855364585632038913), [Web Components Working Group channel](https://discord.com/channels/486522875931656193/855354327854350346), [GitHub discussions](https://github.com/storybookjs/storybook/discussions/20988)). ### The TypeScript auto-completion is not working on my editor diff --git a/docs/contribute/framework.md b/docs/contribute/framework.md index f3125080a4b9..1e091522a142 100644 --- a/docs/contribute/framework.md +++ b/docs/contribute/framework.md @@ -142,7 +142,7 @@ Test it in a fresh project using a Storybook set up as close as possible to your ### 6. Let us know! -Once it's fully tested and released, please let us know about your framework by either announcing it in the `#showcase` channel of the [Storybook Discord](https://discord.gg/storybook) or tweeting it and mentioning `@storybookjs`. It's our hope that well-made community frameworks can eventually move into the Storybook codebase and be considered "officially" supported. +Once it's fully tested and released, please let us know about your framework by either announcing it in the [`#showcase`](https://discord.com/channels/486522875931656193/1048740936953376859) Discord channel or tweeting it and mentioning `@storybookjs`. It's our hope that well-made community frameworks can eventually move into the Storybook codebase and be considered "officially" supported. ## Learn more about contributing to Storybook diff --git a/docs/contribute/how-to-contribute.md b/docs/contribute/how-to-contribute.md index 35faaa534d55..31f0655cd791 100644 --- a/docs/contribute/how-to-contribute.md +++ b/docs/contribute/how-to-contribute.md @@ -19,6 +19,6 @@ In the interest of fostering an open and welcoming environment, we as contributo ## Not sure how to get started? -- [Chat in Discord #contributing](https://discord.gg/storybook) +- [Chat in Discord `#contributing`](https://discord.com/channels/486522875931656193/839297503446695956) - [Browse "good first issues" to fix](https://github.com/storybookjs/storybook/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - [Submit a bug report or feature request](https://github.com/storybookjs/storybook/issues) diff --git a/docs/migration-guide.md b/docs/migration-guide.md index ddd2d8faeab0..722736c78c42 100644 --- a/docs/migration-guide.md +++ b/docs/migration-guide.md @@ -145,7 +145,6 @@ The automatic upgrade should get your Storybook into a working state. If you enc 2. Check [the full migration notes](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#from-version-65x-to-700), which contains an exhaustive list of noteworthy changes in Storybook 7. Many of these are already handled by automigrations when you upgrade, but not all are. It’s also possible that you’re experiencing a corner case that we’re not aware of. 3. Search [Storybook issues on GitHub](https://github.com/storybookjs/storybook/issues). If you’re seeing a problem, there’s a good chance other people are too. If so, upvote the issue, try out any workarounds described in the comments, and comment back if you have useful info to contribute. 4. If there’s no existing issue, you can [file one](https://github.com/storybookjs/storybook/issues/new/choose), ideally with a reproduction attached. We’ll be on top of Storybook 7 issues as we’re stabilizing the release. -5. If you prefer a more interactive medium, try out the `#prerelease` forum in the [Storybook Discord](https://discord.gg/storybook). We have Storybook maintainers and a large community of users who should be able to give you a hand. If you prefer to debug yourself, here are a few useful things you can do to help narrow down the problem: diff --git a/docs/writing-docs/autodocs.md b/docs/writing-docs/autodocs.md index 10e2c730d076..0dc0042f6f7a 100644 --- a/docs/writing-docs/autodocs.md +++ b/docs/writing-docs/autodocs.md @@ -237,7 +237,7 @@ Out of the box, Storybook has a set of components that you can use to customize ### The table of contents doesn't render as expected -When using Autodocs's table of contents, you may encounter situations where it appears differently than expected. To help you resolve these problems, we have compiled a list of possible scenarios that may cause issues. If you've run into any of the items listed below and you're interested in helping us improve the support for this feature, we encourage you to reach out to the maintainers using the default communication channels (e.g., [Discord server](https://discord.com/channels/486522875931656193/570426522528382976), [GitHub issues](https://github.com/storybookjs/storybook/issues)). +When using Autodocs's table of contents, you may encounter situations where it appears differently than expected. To help you resolve these problems, we have compiled a list of possible scenarios that may cause issues. #### With simple documentation pages @@ -283,7 +283,7 @@ Additionally, if you're developing using TypeScript, you may need to update Stor -If you're still encountering issues, we recommend reaching out to the maintainers using the default communication channels (e.g., [Discord server](https://discord.com/channels/486522875931656193/570426522528382976), [GitHub issues](https://github.com/storybookjs/storybook/issues)). +If you're still encountering issues, we recommend reaching out to the maintainers using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)). #### Learn more about Storybook documentation diff --git a/docs/writing-docs/mdx.md b/docs/writing-docs/mdx.md index 00142cc29d3c..bc1a1c9ed025 100644 --- a/docs/writing-docs/mdx.md +++ b/docs/writing-docs/mdx.md @@ -208,7 +208,7 @@ paths={[ ### Automigration -To help you transition to the new version, we've created a migration helper in our CLI. We recommend using it and reaching out to the maintainers using the default communication channels (e.g., [Discord server](https://discord.com/channels/486522875931656193/570426522528382976), [GitHub issues](https://github.com/storybookjs/storybook/issues)) for problems you encounter. +To help you transition to the new version, we've created a migration helper in our CLI. We recommend using it and reaching out to the maintainers using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)) for problems you encounter. ```shell npx storybook@latest automigrate mdx1to2 @@ -449,7 +449,7 @@ Additionally, if you're working with VSCode, you can add the [MDX extension](htt } ``` -If you're still encountering issues, we recommend reaching out to the maintainers using the default communication channels (e.g., [Discord server](https://discord.com/channels/486522875931656193/570426522528382976), [GitHub issues](https://github.com/storybookjs/storybook/issues)). +If you're still encountering issues, we recommend reaching out to the maintainers using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)). #### Learn more about Storybook documentation From 574d82421b92186cdfba2fbad3bb696ac498b03b Mon Sep 17 00:00:00 2001 From: Joe Vaughan <122215197+joevaugh4n@users.noreply.github.com> Date: Wed, 22 Nov 2023 14:56:49 +0000 Subject: [PATCH 2/2] Update addon-migration-guide.md Edited final line --- docs/addons/addon-migration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/addons/addon-migration-guide.md b/docs/addons/addon-migration-guide.md index 70d39b320c5d..b4547353b98f 100644 --- a/docs/addons/addon-migration-guide.md +++ b/docs/addons/addon-migration-guide.md @@ -75,4 +75,4 @@ We also recommend releasing your own addon using the `next` tag to test it out i ## Support -If you're still having issues with your addon after following this guide, please open [new discussion](https://github.com/storybookjs/storybook/discussions/new?category=help) in our GitHub repository. We will assist you in resolving the issue and update this guide accordingly. +If you're still having issues with your addon after following this guide, please open a [new discussion](https://github.com/storybookjs/storybook/discussions/new?category=help) in our GitHub repository.