The Wayback Machine - https://web.archive.org/web/20211020090932/https://github.com/storybookjs/storybook/issues/16166
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

Jump to bottom

Docs: broken links in README related to community storybooks #16166

Closed
yannbf opened this issue Sep 27, 2021 · 13 comments
Closed

Docs: broken links in README related to community storybooks #16166

yannbf opened this issue Sep 27, 2021 · 13 comments
Labels
documentation good first issue needs triage

Comments

@yannbf
Copy link
Member

@yannbf yannbf commented Sep 27, 2021

Describe the bug

Some community Storybooks were moved out of the monorepo some time ago. In the README file, the links which refer to them are broken.

To Reproduce

Broken link Correct Link
https://github.com/storybookjs/storybook/blob/next/app/rax https://github.com/storybookjs/rax
https://github.com/storybookjs/storybook/blob/next/app/riot https://github.com/storybookjs/riot
https://github.com/storybookjs/storybook/blob/next/app/marko https://github.com/storybookjs/marko
https://github.com/storybookjs/storybook/blob/next/app/mithril https://github.com/storybookjs/mithril
https://github.com/storybookjs/storybook/blob/next/app/marionette https://github.com/storybookjs/marionette

Additional context

1 - There could be other places referencing the storybooks which might have a broken link as well, good to check that
2 - Storybook provides demos on Netlify as can be seen here. Some of them are also broken, given that in the monorepo's pipeline, some storybooks are now not built and deployed anymore. (this could be done in a separate issue though)
@Jayita10
Copy link
Contributor

@Jayita10 Jayita10 commented Sep 27, 2021

Can I work on this issue?
@jonniebigodes
Copy link
Contributor

@jonniebigodes jonniebigodes commented Sep 27, 2021

@Jayita10 by all means please do. Feel free to reach out to us with any further questions about this issue, or when the pull request is up let me know and we'll go from there.

Stay safe
@Jayita10 Jayita10 mentioned this issue Sep 27, 2021
Merged
@Jayita10
Copy link
Contributor

@Jayita10 Jayita10 commented Sep 27, 2021 •
edited

@Jayita10 by all means please do. Feel free to reach out to us with any further questions about this issue, or when the pull request is up let me know and we'll go from there.

Stay safe

I have opened a PR, Please review :) @jonniebigodes
@Jayita10
Copy link
Contributor

@Jayita10 Jayita10 commented Sep 28, 2021

Deprecated Addons info and notes links are also broken. What would be the appropriate link for those?
@yannbf
Copy link
Member Author

@yannbf yannbf commented Sep 28, 2021

Deprecated Addons info and notes links are also broken. What would be the appropriate link for those?

Great question! IIRC they were removed, so it's best to use their npm links (cc @jonniebigodes):

https://www.npmjs.com/package/@storybook/addon-notes

https://www.npmjs.com/package/@storybook/addon-info
@jonniebigodes
Copy link
Contributor

@jonniebigodes jonniebigodes commented Sep 28, 2021

@yannbf thanks for that, I was about to make the same comment as you did 🙂! @Jayita10 if you could adjust the pr accordingly I'll take a look at it. Let me know once the changes are in the pull request and we'll go from there.

Stay safe
@shilman
Copy link
Member

@shilman shilman commented Sep 29, 2021

What if we just remove those links? The addons are unmaintained and no longer work with modern versions of Storybook.
@jonniebigodes
Copy link
Contributor

@jonniebigodes jonniebigodes commented Sep 29, 2021

@shilman you raise a valuable point. Thanks for that, and I agree with it. @Jayita10 would you be kind to adjust your pr and remove them and let me know once it's updated and I'll take a look at it?
@Jayita10
Copy link
Contributor

@Jayita10 Jayita10 commented Sep 30, 2021 •
edited

@shilman you raise a valuable point. Thanks for that, and I agree with it. @Jayita10 would you be kind to adjust your pr and remove them and let me know once it's updated and I'll take a look at it?

@jonniebigodes Will I remove both the addons from the list or just the links of those addons?
@jonniebigodes
Copy link
Contributor

@jonniebigodes jonniebigodes commented Oct 1, 2021

@Jayita10 remove the links if you don't mind and let me know once the pull request is updated if don't mind.
@Jayita10
Copy link
Contributor

@Jayita10 Jayita10 commented Oct 1, 2021

@Jayita10 remove the links if you don't mind and let me know once the pull request is updated if don't mind.

I have updated my PR 😃, Please review
@Mohit-1909
Copy link

@Mohit-1909 Mohit-1909 commented Oct 19, 2021

Can I work on this issue??
@yannbf
Copy link
Member Author

@yannbf yannbf commented Oct 19, 2021

Hey @Mohit-1909 I'm sorry, but this issue has been solved already actually! I will be closing it to not make confusion.

However! In case you're looking to contribute you're most welcome to do so, there are good first issues open, or feel free to check any other open issues. Thanks a lot for your interest!
@yannbf yannbf closed this Oct 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue needs triage
5 participants
@shilman @yannbf @jonniebigodes @Jayita10 @Mohit-1909