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

Added windows support in install Plone with pip docs #1858

Closed
wants to merge 7 commits into from

Conversation

pranshustuff
Copy link

@pranshustuff pranshustuff commented Feb 12, 2025

Description

I made this contributing as I was trying to install Plone with pip on my Windows laptop to test its feature. These are fixes to errors I faced along the way.

The command venv/bin/ is for Linux/MacOS

For Windows it is .\venv\Scripts

Plus I was facing issues with pipx run cookie cutter.
If you're already in a venv, you can install cookiecutter with pip, so I added instructions for that.

Page which was modified

https://6.docs.plone.org/admin-guide/install-pip.html


📚 Documentation preview 📚: https://plone6--1858.org.readthedocs.build/admin-guide/install-pip.html

Copy link

boring-cyborg bot commented Feb 12, 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! 🎉

@pranshustuff pranshustuff changed the title Added windows support in instal Plone with pip docs Added windows support in install Plone with pip docs Feb 12, 2025
@stevepiercy
Copy link
Contributor

@pranshustuff did you use Windows Subsystem for Linux (WSL) on Windows or Windows alone?

I'm hesitant to recommend installation steps for Windows alone if they don't actually result in a functional Plone site, and I have no way to verify that. See the Important admonition at https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation.

If you used WSL, then we might want to include that admonition into the pip installation docs.

@pranshustuff
Copy link
Author

pranshustuff commented Feb 12, 2025

I used Windows only.
I understand your concerns, since I have only created a basic site, I can't guarantee the working of more advanced features.

I can add the admonition instead.

Although, I would like to leave in the activation of venv and installation of cookiecutter through pip directly instead of pipx as an alternative, since my issue with pipx was with something to do with file path, which I assume can happen with WSL too. I can write a WSL version for those.

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

I'm on the fence about adding commands for Windows for this installation method until and unless we have feedback confirming that a fully functional Plone site is running.

If we do go about it, then I would prefer to use Sphinx Design's synchronized tabs to better display the options, as in this example, with Linux as the default selected tab.

@pranshustuff
Copy link
Author

I am closing the pull request and moving this discussion to the forums.

Thank you for your time and guidance! I learnt a lot today.

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

Successfully merging this pull request may close these issues.

2 participants