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

Move storybook.js.org to Netlify #4126

Closed
2 tasks done
shilman opened this issue Sep 5, 2018 · 15 comments
Closed
2 tasks done

Move storybook.js.org to Netlify #4126

shilman opened this issue Sep 5, 2018 · 15 comments
Assignees
Labels
documentation maintenance User-facing maintenance tasks
Milestone

Comments

@shilman
Copy link
Member

shilman commented Sep 5, 2018

Why

Infrastructure for next-gen docs. We've already been deploying our docs and project storybooks there for awhile. With this change we can get rid of the hacked up github pages setup and it will also help us do versioned docs in docs 2.0.

What

@shilman shilman added maintenance User-facing maintenance tasks documentation labels Sep 5, 2018
@shilman shilman self-assigned this Sep 5, 2018
@shilman
Copy link
Member Author

shilman commented Sep 5, 2018

Log of what's happened so far until the switchover is complete:

  1. Submitted the PR to js.org: storybook.js.org js-org/js.org#2304
  2. js.org setting updated and the Storybooks.js docs site went down temporarily
  3. I updated the netlify domain settings
  4. The site came back up, but pointing to the github pages version of the site, not the netlify version
  5. The js.org PR was merged, and presumably the updated DNS settings are propagating**
  6. Fingers crossed that it serves properly when the DNS propagates**

**See correction below.

@ndelangen
Copy link
Member

How can we verify?

@shilman
Copy link
Member Author

shilman commented Sep 5, 2018

Correction to above: apparently js.org is served through cloudflare, so there are no DNS settings to propagate in the current setup. Instead, I believe that Cloudflare is pointing to the Netlify site, and that the site is going through two levels of CDN, which is problematic.

Next steps:

  • Verify that storybook.js.org is serving content from Netlify not GH-pages
  • Ask js.org to bypass cloudflare for the Storybook site (a simple setting in CF)
  • Set up HTTPS certificates on Netlify once the cloudflare settings have been updated (there's a chance the site will go down temporarily while this is getting set up)

@shilman
Copy link
Member Author

shilman commented Sep 5, 2018

Verify & cleanup:

  • edit docs in minor way & push to release/3.4 which will trigger netlify deploy
  • verify changes on storybooks.netlify.com and storybook.js.org
  • verify NO changes on gh-pages branch which corresponds to storybooks.github.io/storybook and is only updated when a branch is tagged with vX.Y.Z
  • remove deploy step from circle config & issue PR and notify @pksunkara
  • update deploy directory on netlify since it's out of sync with netlify.toml

@pksunkara
Copy link
Member

pksunkara commented Sep 5, 2018

  • Create netlify storybook team
  • Invite storybook github team to netlify storybook team

@ndelangen
Copy link
Member

There's a netlify team here:
https://app.netlify.com/teams/storybook/members

Let me know who to invite via a personal message

@pksunkara
Copy link
Member

I have a question about this. Does netlify support deploy production only on tags? Because, we don't want the website to be changed for every commit on master. The documentation might be changed on master but it won't be valid until the next version is published, right?

@ndelangen
Copy link
Member

ndelangen commented Sep 6, 2018

It support promoting specific builds to production and it supports picking a production branch.

It also support webhooks

@pksunkara
Copy link
Member

So, netlify doesn't support tag based deploys. It only talks about branches. See this, mochajs/mocha#3206 (comment). Do we want to keep the deploy job in circleci?

@ndelangen ndelangen added this to the v4.0.0 milestone Sep 6, 2018
@pksunkara
Copy link
Member

The deploy job in circleci was broken anyway. Once we decide on the process of release deployment on netlify, I will create a new job on circleci. So, here are some more tasks in the list.

  • Decide on the deployment schedule and how to
  • If automated, set it up

@ndelangen
Copy link
Member

Great topic for the roadmap meeting next week 👍

@Hypnosphi
Copy link
Member

Hypnosphi commented Sep 8, 2018

we don't want the website to be changed for every commit on master

It's deployed from release branch not from master. And we only cherry-pick commits into it right before the release so it shouldn't be a problem

@shilman
Copy link
Member Author

shilman commented Sep 19, 2018

Almost there: js-org/js.org#2340

@shilman shilman mentioned this issue Sep 20, 2018
2 tasks
@shilman
Copy link
Member Author

shilman commented Sep 20, 2018

@pksunkara Closing this and have opened up a follow-up issue regarding deployment: #4207

@shilman shilman closed this as completed Sep 20, 2018
@ndelangen
Copy link
Member

👏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation maintenance User-facing maintenance tasks
Projects
None yet
Development

No branches or pull requests

4 participants