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

GHA: Split storybook deploy from main docs build & deploy #1450

Open
1 of 2 tasks
fredvd opened this issue Feb 19, 2023 · 1 comment
Open
1 of 2 tasks

GHA: Split storybook deploy from main docs build & deploy #1450

fredvd opened this issue Feb 19, 2023 · 1 comment

Comments

@fredvd
Copy link
Sponsor Member

fredvd commented Feb 19, 2023

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.

@fredvd fredvd changed the title GHA: Split storybook deploy from main documentatin build&deploy GHA: Split storybook deploy from main docs build & deploy Feb 19, 2023
@stevepiercy
Copy link
Contributor

I agree with your proposal.

I would suggest that you create a companion issue in the Volto repo, and request feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants