From a3d015f69075a149a5f005c11899995c3a99608c Mon Sep 17 00:00:00 2001 From: MrTango Date: Wed, 6 Nov 2024 18:24:28 +0200 Subject: [PATCH] correct venv creation, never mix venv and other configation files --- docs/admin-guide/install-buildout.md | 23 ++++++++++++++++------- docs/admin-guide/install-pip.md | 6 +++--- docs/admin-guide/run-plone.md | 2 +- 3 files changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/admin-guide/install-buildout.md b/docs/admin-guide/install-buildout.md index f0f87cc2e..010205651 100644 --- a/docs/admin-guide/install-buildout.md +++ b/docs/admin-guide/install-buildout.md @@ -25,7 +25,7 @@ For other installation options, see {ref}`get-started-install-label`. ## Prerequisites for installation - For Plone 6.0, Python {SUPPORTED_PYTHON_VERSIONS_PLONE60} -% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest". +% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest". % - For Plone 6.1, Python {SUPPORTED_PYTHON_VERSIONS_PLONE61} @@ -47,15 +47,17 @@ cd /plone Create a Python virtual environment. ```shell -python3 -m venv . +python3 -m venv venv ``` Install the minimal Python packages needed in order to run Buildout. ```shell -bin/pip install -r https://dist.plone.org/release/6-latest/requirements.txt +./venv/bin/pip install -r https://dist.plone.org/release/6-latest/requirements.txt ``` + + Create a {file}`buildout.cfg` file in your directory with the following contents. ```cfg @@ -75,21 +77,28 @@ eggs = Plone ``` +Install Buildout script in bin directory. + +```shell +./venv/bin/buildout bootstrap +``` + Run Buildout. ```shell -bin/buildout +./bin/buildout ``` This may take a few minutes. +When ever the buildout configuration has changed, re-run ./bin/buildout ## Start Plone in foreground mode Start the instance for a quick test in foreground mode: ```shell -bin/instance fg +./bin/instance fg ``` ```{include} /_inc/_create-classic-ui-instance.md @@ -101,7 +110,7 @@ bin/instance fg Start the instance. ```shell -bin/instance start +./bin/instance start ``` @@ -110,5 +119,5 @@ bin/instance start Stop the instance. ```shell -bin/instance stop +./bin/instance stop ``` diff --git a/docs/admin-guide/install-pip.md b/docs/admin-guide/install-pip.md index 62ede6906..943920a60 100644 --- a/docs/admin-guide/install-pip.md +++ b/docs/admin-guide/install-pip.md @@ -25,7 +25,7 @@ For other installation options, see {ref}`get-started-install-label`. ## Prerequisites for installation - For Plone 6.0, Python {SUPPORTED_PYTHON_VERSIONS_PLONE60} -% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest". +% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest". % - For Plone 6.1, Python {SUPPORTED_PYTHON_VERSIONS_PLONE61} @@ -47,13 +47,13 @@ cd /plone Create a Python virtual environment. ```shell -python3 -m venv . +python3 -m venv venv ``` Install Plone and a helper package, {term}`pipx`. ```shell -bin/pip install -c https://dist.plone.org/release/6.0-latest/constraints.txt Plone pipx +./venv/bin/pip install -c https://dist.plone.org/release/6.0-latest/constraints.txt Plone pipx ``` diff --git a/docs/admin-guide/run-plone.md b/docs/admin-guide/run-plone.md index d90e363be..e73784010 100644 --- a/docs/admin-guide/run-plone.md +++ b/docs/admin-guide/run-plone.md @@ -18,7 +18,7 @@ There are different commands to run Plone, depending on which method you used to ## Run Plone in foreground mode Running Plone in foreground mode will show output in the terminal. -This is recommended while developing a Plone site. +This is recommended while developing a Plone site. The command to be used, depends on the used install method. Cookieplone: : ```shell