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

Versioned Documentation #1357

Closed
3 tasks
shilman opened this issue Jun 25, 2017 · 12 comments
Closed
3 tasks

Versioned Documentation #1357

shilman opened this issue Jun 25, 2017 · 12 comments

Comments

@shilman
Copy link
Member

shilman commented Jun 25, 2017

why

We need a way to document preview releases of storybook. We may also want docs for people using old versions.

what

  • Docs for a preview release, clearly labeled as preview with disclaimers and pointers to the main docs
  • Docs for the latest stable release of Storybook, statically hosted at https://storybook.js.org
  • Docs for previous minor releases of Storybook, with disclaimers and pointers to the main docs
@shilman
Copy link
Member Author

shilman commented Jun 25, 2017

@smooJitter
Copy link

You all are moving fast. It would be nice (on the readme.md at statement about upgrading. I have had a fair share of problems with configuring and installing storybook. Now that I have it working. I am afraid to upgrade the cli. Fortunately, Im only using storybook on a ui test app. I found it easier reinstall storybook, start a new project, then copy over the stories. It looks like you are posting new releases ever few days. The version I have works fine. I'd like to keep up with the changes. After more than a year, I've finally gotten storybook to work for me. THANKS!

@shilman
Copy link
Member Author

shilman commented Jun 28, 2017

@smooJitter All of the releases since 3.0 have been backwards compatible unless we messed up. Whenever we make changes that require modifications on your side, we have been updating MIGRATION.md. But we'll do a better job documenting the changes and all suggestions are welcome. Thanks!

@danielduan
Copy link
Member

is this still a valid issue @Hypnosphi @ndelangen? wouldn't we be able to deploy branch builds to netlify for each release and keep them versioned?

@Hypnosphi
Copy link
Member

Hypnosphi commented Apr 20, 2018

We already do, but we haven't any links to them anywhere
E.g. docs for current alpha (master) https://storybooks.netlify.com/

@ndelangen
Copy link
Member

As @Hypnosphi describes, this issue has become:
We need a method for users to be able to select an older version of the docs.
We can use netlify links for that purpose. But it needs a UI & links on the docs.

@tkharuk
Copy link

tkharuk commented May 15, 2021

Oh, I've just faced this, where my org uses v5 but all I can find is v6 examples.
Even though I know the same functionality exists in v5 but I just don't remember how to make it work :(

@ajbarry
Copy link

ajbarry commented Jun 28, 2021

Likewise, I am attempting to learn how to use Storybook, but I am limited to the version currently used in my org.
I took a look at the netlify links and while the version in the sidebar header is 5.1 all of the sub pages are currently not found:

https://storybooks.netlify.app/docs/basics/introduction/

@Hypnosphi @ndelangen ... if versioned documentation is already available, could you please provide an example of the netlify link to a historical version?

@jonniebigodes
Copy link
Contributor

@ajbarry see if this helps in your case.

@ajbarry
Copy link

ajbarry commented Jun 29, 2021

Ah... thank you so much @jonniebigodes ... it does.

@jonniebigodes
Copy link
Contributor

Glad that helps out.

@jonniebigodes
Copy link
Contributor

@shilman closing this issue as we already have versioned documentation available to the community.

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

8 participants