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

Too many installation docs (and other suggested improvements) #3289

Closed
stevepiercy opened this issue Apr 30, 2022 · 18 comments
Closed

Too many installation docs (and other suggested improvements) #3289

stevepiercy opened this issue Apr 30, 2022 · 18 comments

Comments

@stevepiercy
Copy link
Collaborator

stevepiercy commented Apr 30, 2022

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:

  1. 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."
  2. 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.
  3. State "For simplicity in documentation, we use bash for a shell. Adjust commands according to your preferred shell flavor."
  4. Specify what characters are valid in a project name for npm init yo @plone/volto. Letters, number, dashes, underscores, other characters?
  5. Use "Install", not "Getting Started", buried under "Introduction". Elevate it.
  6. 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.
@tiberiuichim

This comment was marked as resolved.

@ksuess

This comment was marked as resolved.

@stevepiercy

This comment was marked as resolved.

@ksuess

This comment was marked as resolved.

@stevepiercy

This comment was marked as resolved.

@ksuess

This comment was marked as resolved.

@stevepiercy
Copy link
Collaborator Author

I've created a project to track all Install-related issues, Install Docs.

@rileydog

This comment was marked as duplicate.

@stevepiercy

This comment was marked as resolved.

@rileydog

This comment was marked as resolved.

@stevepiercy

This comment was marked as resolved.

@rileydog

This comment was marked as resolved.

@stevepiercy

This comment was marked as resolved.

@aclark4life

This comment was marked as resolved.

@ericof

This comment was marked as resolved.

@stevepiercy

This comment was marked as resolved.

@polyester

This comment was marked as resolved.

@stevepiercy
Copy link
Collaborator Author

I'm going to close this issue, because we have resolved most of the issues and consolidated documentation into include files. Specific issues remain, but they can be addressed separately.

@stevepiercy stevepiercy unpinned this issue Jan 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Archived in project
Development

No branches or pull requests

7 participants