volto icon indicating copy to clipboard operation
volto copied to clipboard

Add production deployment documentation using Cookieplone's sub/front…

Open aryan7081 opened this issue 1 month ago • 10 comments

Closes #7189

The deployment documentation lacked guidance on putting Volto into production using Cookieplone's recommended approach.

This fix adds production deployment documentation covering Cookieplone's sub/frontend_project template, building, deployment options, and migration guidance.


📚 Documentation preview 📚: https://volto--7626.org.readthedocs.build/

aryan7081 avatar Nov 17 '25 05:11 aryan7081

@stevepiercy Thanks for the detailed review. I have updated as suggested. Feel free to let me know if anything else needs fixing.

aryan7081 avatar Nov 17 '25 12:11 aryan7081

@wesleybl Updated to use uvx as recommended. Thanks!

aryan7081 avatar Nov 18 '25 01:11 aryan7081

@aryan7081 I'm not sure what happened, but you addressed only a few of my suggestions. There are about a dozen unresolved suggestions under https://github.com/plone/volto/pull/7626/files. If you agree with all the suggestions, then you can use the "Add suggestion to batch" feature on GitHub. Note this GitHub issue if you don't see it https://github.com/orgs/community/discussions/175664.

Also please update this branch to main.

stevepiercy avatar Nov 18 '25 06:11 stevepiercy

@stevepiercy I’m really sorry about missing several of the suggestions. I can’t believe I missed those earlier. I’ve gone through the PR again and addressed all of them now. Thanks for the tip about batching suggestions!

aryan7081 avatar Nov 18 '25 08:11 aryan7081

@stevepiercy, I have committed the suggested changes. Thanks!

aryan7081 avatar Nov 18 '25 12:11 aryan7081

@sneridagh can you take a look at the failing RTD Storybook build?

https://app.readthedocs.org/projects/volto/builds/30364001/

pnpm install
! Corepack is about to download https://registry.npmjs.org/pnpm/-/pnpm-10.20.0.tgz
packages/volto                           |  WARN  Unsupported engine: wanted: {"node":"^22 || ^24"} (current: {"node":"v20.19.1","pnpm":"10.20.0"})

stevepiercy avatar Nov 18 '25 12:11 stevepiercy

@sneridagh nm, it appears to have magically fixed itself https://app.readthedocs.org/projects/volto/builds/30364078/.

stevepiercy avatar Nov 18 '25 12:11 stevepiercy

@aryan7081 the sub/project is not supposed to be used by integrators... You'd rather use the full project one. Run cookieplone and the user/integrator facing options are the only ones listed in there.

sneridagh avatar Nov 19 '25 10:11 sneridagh

@sneridagh Thanks for the clarification. I have updated the production docs to recommend the Cookieplone project and noted that sub/frontend_project is only used internally for the Docker images. Please let me know if you would like any further changes. Thank you!

aryan7081 avatar Nov 19 '25 11:11 aryan7081

the sub/project is not supposed to be used by integrators... You'd rather use the full project one. Run cookieplone and the user/integrator facing options are the only ones listed in there.

@sneridagh The project generates the backend and frontend together. In cases where the backend is in one container and the frontend in another, does it make sense to tell the developer to "generate a complete project and copy the frontend"? To me, it makes more sense to generate only the frontend. What is the disadvantage of using sub/frontend_project? Is it not generated correctly? Volto's own image uses it.

wesleybl avatar Nov 19 '25 13:11 wesleybl