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

Clarified steps in create-project-cookieplone.md for better understan… #1852

Closed
wants to merge 5 commits into from

Conversation

GOGETASSB23
Copy link

@GOGETASSB23 GOGETASSB23 commented Feb 11, 2025

Why:

The setup instructions for creating a new cookieplone project were unclear about the version selection for Plone and Volto, especially for newcomers. This caused confusion during the setup process.

What:

  • Clarified the instructions regarding the version selection in the create-project-cookieplone.md file.
  • Provided default values for Plone and Volto versions when the user presses Enter, making it easier for them to proceed without manual input.
  • Many users may either make a typo mistake while typing the versions or search for which version they have to type , so i just mentioned to press an enter for both (Plone and Volto versions ) so that their project is build on the stable current versions.

How:

  • Updated the documentation to explicitly mention that pressing Enter will select the latest stable version for both Plone and Volto.
  • Added a sample command to demonstrate the version selection process.

Testing:

  • No functional changes, only documentation updates. Read through the file to ensure the instructions are clearer.

Notes:

  • This is part of the ongoing documentation improvements for Plone 6 setup.

📚 Documentation preview 📚: https://plone6--1852.org.readthedocs.build/

Copy link

boring-cyborg bot commented Feb 11, 2025

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, read Plone's Code of Conduct and Contribute to documentation, as this will greatly help the review process.

Welcome to the Plone community! 🎉

mkdocs.yml Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this file.

@@ -189,8 +189,8 @@ before. Is it okay to delete and re-download it? [y/n] (y):
[5/17] Author (Plone Foundation):
[6/17] Author E-mail ([email protected]):
[7/17] Should we use prerelease versions? (No):
[8/17] Plone Version (6.1.0):
[9/17] Volto Version (18.8.1):
[8/17] Plone Version (6.1.0): (press enter if it is your first project)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is literal console output from running the command. We can't add something here that doesn't actually happen. Cookieplone would need to be updated with this altered prompt first.

Alternatively you can move instructions into the narrative documentation with the other admonitions above.

@GOGETASSB23
Copy link
Author

GOGETASSB23 commented Feb 12, 2025 via email

@GOGETASSB23 GOGETASSB23 closed this by deleting the head repository Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: in progress
Development

Successfully merging this pull request may close these issues.

2 participants