Autodesk / hig

Autodesk's unified design system
https://storybook.weave.autodesk.com
Apache License 2.0
180 stars 114 forks source link

Publish storybook to GitHub pages #1077

Open nfiniteset opened 6 years ago

nfiniteset commented 6 years ago

As a developer outside the VPN I can read the docs so I can use the library


Acceptance:


Add a step in our build process to publish the storybook to our repo's GitHub pages.

Continue publishing it to storybook.hig.autodesk.com as well.

arirusso commented 6 years ago

This is feasible

Looks like have a couple of options as a starting point

  1. Create a branch gh-pages. The root of this branch would correspond to autodesk.github.io.

We could build a bare version of the repository into that branch where there's a directory hig and a directory storybook in that that corresponds to /packages/storybook/storybook-static on master. I'm assuming this could be done using the ci master build script. Then our storybook would appear at autodesk.github.io/hig/storybook.

  1. Enable the docs directory on the master branch

We could have the master build script copy /packages/storybook/storybook-static to some place like /docs/hig/storybook. Which would correspond to autodesk.github.io/hig/storybook

We'd have to be mindful of what we put in /docs in this case

Thoughts?