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.

Sign up for GitHub

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: Fix Discord links and GH discussions #24713

Closed
wants to merge 5 commits into from
Closed

Docs: Fix Discord links and GH discussions #24713

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b70264e
Docs: Fix Discord links and GH discussions
jonniebigodes Nov 3, 2023
b8febe8
Merge branch 'next' into docs_update_discord_refs
jonniebigodes Nov 3, 2023
73d8397
Merge branch 'next' into docs_update_discord_refs
jonniebigodes Nov 21, 2023
629d497
Merge branch 'next' into docs_update_discord_refs
jonniebigodes Nov 22, 2023
574d824
Update addon-migration-guide.md
joevaugh4n Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion code/addons/controls/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
2 changes: 1 addition & 1 deletion docs/addons/addon-migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/addons/integration-catalog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@integrayshaun can you follow up with me on this and let me know of any feedback? The idea here is two-fold:

  • If there's an interest from the community in seeing a specific recipe for a use case scenario, they can reach out to us.
  • If the community has one already that fits into our narrative, we can coordinate with them and get it added

Copy link
Contributor

Choose a reason for hiding this comment

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

That's a great idea, @jonniebigodes

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Appreciate the follow up on this @integrayshaun and glad you're onboard with this.

Copy link
Contributor

Choose a reason for hiding this comment

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

A bit of a tangent, but currently the template for "ideas" have these labels: needs triage and feature requests. Do they still make sense? I wonder if the recipe requests should have their own label.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm okay with having its own label @vanessayuenn , @integrayshaun are you ok with this as well? If so, we can create it, and I'll adjust the documentation accordingly. Let me know and we'll go from there.


## Learn more about the Storybook addon ecosystem

Expand Down
2 changes: 1 addition & 1 deletion docs/builders/builder-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Hey @jonniebigodes. This second sentence has gotten kinda long. Could we simplify it by breaking it up into two sentences, like so:

"If you are interested in creating a builder, you can learn more about implementing a builder in Storybook by checking the source code for Vite, Webpack, or Modern Web's dev-server-storybook. When you're ready, open an RFC to discuss your proposal with the Storybook community and maintainers."

(with the links in, as before)


#### Learn more about builders

Expand Down
2 changes: 1 addition & 1 deletion docs/configure/frameworks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo in final sentence, and we can simplify it too. Could change to:

'If you're working with one of them and you want to continue supporting them, visit the dedicated Storybook End-of-Life repository. To learn more about the sunsetting process and view instructions on how to contribute, read our documentation."


### Learn about configuring Storybook

Expand Down
2 changes: 1 addition & 1 deletion docs/configure/typescript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@joevaugh4n and @vanessayuenn It seems that we still have those channels available despite being archived, and we should retask them as a means to engage with maintainers and have a communication pipeline to address features such as this one.

Let me know, and we'll take it from there.

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think the working group channels are archived, though not super active. However, I think the working group channels should be for existing and potential contributors to discuss domain specific things, and not for offering support. This section is under "troubleshooting" so directing folks to "help" in discussion is more appropriate. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@vanessayuenn I left the mention to those channels as it's the only place where we can follow up with anyone willing to help us with this issue/integration and have a faster point of contact to follow up with the maintainers.
If you don't mind, I'll wait for @joevaugh4n 's input, and we see where we go from there. Sounds good?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hey, @jonniebigodes! Yes, to clarify, those channels aren't archived. They're still available under the 'working groups' category but are relatively inactive. Like Vanessa says, imo we should refer anyone with Angular support requests to discussions, as those wg channels are mostly for maintainer/contributor usage. Sound good?

Copy link
Contributor

Choose a reason for hiding this comment

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

With my comment in mind, change last sentence to:

"If you encounter this issue, please open up a support request on GitHub Discussions."


### The TypeScript auto-completion is not working on my editor

Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/framework.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/how-to-contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
1 change: 0 additions & 1 deletion docs/migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions docs/writing-docs/autodocs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -283,7 +283,7 @@ Additionally, if you're developing using TypeScript, you may need to update Stor

<!-- prettier-ignore-end -->

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)).
Copy link
Contributor

Choose a reason for hiding this comment

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

imo, change 'reaching out to the maintainers' to 'reaching out to the community'


#### Learn more about Storybook documentation

Expand Down
4 changes: 2 additions & 2 deletions docs/writing-docs/mdx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
Loading