Skip to content

Instantly share code, notes, and snippets.

@shilman

shilman/versioned_docs.md

Created June 25, 2017 23:20
Show Gist options
  • Save shilman/6de9d40d9c8fb33d301060b8601b8c36 to your computer and use it in GitHub Desktop.
Save shilman/6de9d40d9c8fb33d301060b8601b8c36 to your computer and use it in GitHub Desktop.
Download ZIP
Versioned Docs
Raw
versioned_docs.md

Versioned Documentation for Storybook

Goals:

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

Proposal

Patterned off of Meteor docs site (source)

  1. A config file (package.json?) that lists out the versions, and also the current stable version
    • Code that reads this in and creates a drop-down
  2. A naming convention on release branches release/X.y
  3. A CI setup that:
    • deploys the branch to /vX.y/ if the change is to a release/X.y branch
    • deploys to / if it's on master
  4. Code that displays a warning banner if the user is not viewing the current stable version
@shilman
Copy link
Author

shilman commented Jun 29, 2017

@smooJitter most of the releases we're doing are just minor bugfixes, and we're trying to limit breaking changes to 1-2x / year with major releases (3.0.0, 4.0.0, etc.). AFAIK we have documented all necessary migrations in MIGRATION.md. But we'll try to do a better job of documenting it all. Thanks!

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