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

Update Docs for monorepo #912

Closed
burabure opened this issue Apr 17, 2017 · 7 comments
Closed

Update Docs for monorepo #912

burabure opened this issue Apr 17, 2017 · 7 comments
Assignees
Milestone

Comments

@burabure
Copy link

The current docs here https://getstorybook.io/docs have a lot of misleading information about how to setup addons, testing and such. All links to these go to the deprecated packages repos instead of the new ones.

This was very confusing and made it difficult to get started with storybook.

@ndelangen
Copy link
Member

Hey @burabure This is certainly true, we're sorry for the inconvenience! We're transitioning to the monorepo, and have yet to publish new releases or documentation. This is high on our issue-list!

@ndelangen ndelangen added this to the v3.0.0 milestone Apr 17, 2017
@shilman shilman changed the title Update Docs Update Docs for monorepo Apr 17, 2017
@shilman
Copy link
Member

shilman commented Apr 17, 2017

@shilman is updating the doc content
@mnmtanish is updating the deployment so we can get it on storybooks.js.org

@shilman
Copy link
Member

shilman commented Apr 18, 2017

Update: we've updated the contents and added a clever way to publish by @mnmtanish. Now we're just waiting for the DNS changes to go through and it should be live on https://storybooks.js.org within 24H

@methyl
Copy link
Contributor

methyl commented Apr 18, 2017

@shilman even after updating docs there is no information on how to install addon included within monorepo, for example when you go to https://getstorybook.io/docs/react-storybook/addons/using-addons (or check out storybook-eol/storybooks.github.io#1) it says

npm i --save '@kadira/storybook-addon-notes';

which will install deprecated addon. How do you use addons from monorepo?

@shilman
Copy link
Member

shilman commented Apr 18, 2017

@methyl the monorepo addons have not been released yet. the addon itself is not deprecated, but the repo is deprecated, because we don't want people filing issues/PR's there. we hope to release the updated addons soon and will update the docs when the updated addons are available. Hope that helps!

@shilman
Copy link
Member

shilman commented Apr 18, 2017

I have deployed the updated docs temporarily to https://storybooks.github.io/

@shilman
Copy link
Member

shilman commented Apr 18, 2017

Site is now live at https://storybooks.js.org/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants