Documentation deployment inconsistent with package deployment

[shilman]

why

• Documentation goes live as soon as its merged to master
• Packages go live as soon as somebody manually releases them (@shilman has been doing it about once a week so far)

This causes the documentation to be temporarily out of sync, and problems like this which is bad for users: #1230

what

Either:

• Make documentation fixes part of the release process (somehow)
• Automate releases so that they happen as soon as a PR is merged

[tmeasday]

Unless we want to go all CD, I would recommend a vNEXT branch on the docs that is the "base" branch for PRs etc, and merge to master on release.

If we want to get really fancy we could do what we did for Meteor and have a deploy per release and a vNEXT deploy (http://docs.meteor.com/vNEXT/) but that's probably way over the top ;)

[shilman]

@tmeasday Chatted with @ndelangen in Slack and he proposed that we only deploy docs alongside lerna publish. This makes sense to me.

[ndelangen]

My goal is to go fully CD!

But right now that's just not going to work.

• Test coverage is too low.
• There are no integration tests.
• There are no flow tests.
• Most addons are no tested at all.

I figured updating docs continuously already wouldn't be such a big deal. I was wrong, it's causing people to be confused when upgrading.

So yes, for right now I suggest to stop auto-deploying docs, and deploy manually (scripted) when performing a release.

[tmeasday]

Having a deploy branch or merging PRs to a different branch will have that effect btw.

[tmeasday]

I think this solves it: #1357

[ndelangen]

Yes, We talked about this on slack:

• Docs should be deployed to separated instances per release.
• We will introduce a dropdown for selecting a release
• A deployed instance will do a periodic back-end call to something like https://storybook.js.org/versions.json to get the latest list of versions to display in the dropdown.

//cc @shilman

[stale]

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 60 days. Thanks!