search

mitodl / mit-open

BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Fix storybook github pages publishing #1200

Closed ChristopherChudzicki closed 3 days ago

ChristopherChudzicki commented 1 week ago

What are the relevant tickets?

Description (What does it do?)

This PR:

  1. fixes publishing storybook on github pages. It wasn't working before
    • it will only publish when manually run or when there are pushes to main.
  2. Removes our github-pages react app.
    • At one point in the past, we had a react app + storybook deploying to github pages. The react app didn't have much besides a link to storybook, so we've just removed it.
  3. Renames a few storybook stories.
    • Previously we had two "Categories": ol-components/storyname and smoot-design/storyname. I've moved most things under ol-components/ to smoot-design/ (this only affects the storybook, not the workspace name) and renamed ol-components category to "old"

How can this be tested?

  1. Run yarn storybook locally and compare with https://mitodl.github.io/mit-open/. They should be the same.
jonkafton commented 3 days ago

PR looks good. Now we have static hosting for the front end set up, let's pick up the conversation of publishing Storybook alongside it for branch PRs and environments.

For the Storybook renaming, do you think it's worth making the distinction between components that form part of the design language - the Smoot Design components - and components that are just UI devices without any particular design - e.g. PlainList, Popover, the RoutedDrawer (arguably)?

jonkafton commented 3 days ago

Might be worth updating the project README (last line) to say it's now publishing Storybook there.

ChristopherChudzicki commented 3 days ago

@jonkafton

For the Storybook renaming, do you think it's worth making the distinction between components that form part of the design language - the Smoot Design components - and components that are just UI devices without any particular design - e.g. PlainList, Popover, the RoutedDrawer (arguably)?

I do think that this is a good idea and worthwhile, but mostly I want to get this deployed and shareable with Steve/Simone. I suspect we will do some further reorganizing / renaming after they've looked at it a bit. I'd like to hold off on more reorganizing till then.