GHA: Split storybook deploy from main docs build & deploy
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 106
- Forks
- 190
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
Plone Documentation versions affected
- 5.x
- 6.x
Description
The current build & deploy step of the documentation creates a build of the documentation which is python based, but also installs and runs a storybook build. Both results are then uploaded to netlify and our docs, where /storybook contains the storybook setup.
In PR #1444 I updated the github actions but couldn't get the inbuilt caching suport of setup-node@v3 working, but I also noticed this double building. Some discussion in the PR followed. This is a continuation/restart of that discussion for later.
-
The bundling of the docus with the 'master' branch of volto that has the storybook setup doesn't really make sense as storybook is showing the state of that Volto version and the documentation isn't really versioned at the moment, except for being suited for Plone 6.X
-
The deploy of the documentation itself is slower and the workflow is more complicated.
I suggest we separate the storybook generation from the documentation and create a separate workflow (maybe on the volto repo itself), create a storybook.plone.org and deploy storybook to versioned subdirectories so that we have an up to date but also historical view of the components in Volto. I can imagine that the compontens in Volto 17 are already looking different from those in Volto 16.
I found a an action last week that deployed storybook to GitHub Pages. But any other hosting is fine as well where we can deploy to, it's just static files.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the current GitHub Actions documentation build and deploy workflow and the discussion in PR #1444. Define a separate Storybook workflow and hosting approach, with versioned Storybook subdirectories and an independent documentation deployment; done means the two builds no longer run together and both outputs deploy successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, storybook
- Domain
- ci-cd, devops, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100