Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Too many installation docs (and other suggested improvements)

See original GitHub issue

We have too many Volto installation docs.

I would strongly advocate for one, and only one, way to install Volto for development in Plone 6.

This would make it easier to maintain installation documentation and reduce frustration of developers.

As a couple of side notes:

I would require, not make it optional, to use nvm. Alternatively, we should make a statement such as, “The Volto development team uses nvm for installing and managing versions of Node.js. We do not support any other node version manager or the lack of one. If you do not use nvm, then we assume you know what you are doing and can resolve issues on your own.”
Provide clear paths to install Volto using either Docker or a manual installation. The current docs are not structured clearly because all headings are at the same level and not in order. The proposed version aims to provide that structure and order.
State “For simplicity in documentation, we use bash for a shell. Adjust commands according to your preferred shell flavor.”
Specify what characters are valid in a project name for npm init yo @plone/volto. Letters, number, dashes, underscores, other characters?
Use “Install”, not “Getting Started”, buried under “Introduction”. Elevate it.
Separate “Installation” from “Development” documentation. Volto (and any other core Plone package) should still have its specific documentation for development purposes, such as for running tests.