Skip to content

Commit cdd32ba

Browse files
MrTangodavisaglistevepiercy
authored
Improve install docs (#1760)
* rm deployment from admin guide description, as deployment has it's own chapter * correct venv creation, never mix venv and other configation files * Update docs/admin-guide/run-plone.md Co-authored-by: David Glick <david@glicksoftware.com> * Apply suggestions from code review --------- Co-authored-by: David Glick <david@glicksoftware.com> Co-authored-by: Steve Piercy <web@stevepiercy.com>
1 parent 4daa66c commit cdd32ba

File tree

4 files changed

+17
-7
lines changed

4 files changed

+17
-7
lines changed

docs/admin-guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ myst:
1111

1212
# Admin guide
1313

14-
In this part of the documentation, you can find how to install, operate, configure, and deploy Plone.
14+
In this part of the documentation, you can find how to install, operate, and configure Plone.
1515

1616

1717
```{toctree}

docs/admin-guide/install-buildout.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For other installation options, see {ref}`get-started-install-label`.
2525
## Prerequisites for installation
2626

2727
- For Plone 6.0, Python {SUPPORTED_PYTHON_VERSIONS_PLONE60}
28-
% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest".
28+
% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest".
2929
% - For Plone 6.1, Python {SUPPORTED_PYTHON_VERSIONS_PLONE61}
3030

3131

@@ -47,15 +47,17 @@ cd <my_projects>/plone
4747
Create a Python virtual environment.
4848

4949
```shell
50-
python3 -m venv .
50+
python3 -m venv venv
5151
```
5252

5353
Install the minimal Python packages needed in order to run Buildout.
5454

5555
```shell
56-
bin/pip install -r https://dist.plone.org/release/6-latest/requirements.txt
56+
venv/bin/pip install -r https://dist.plone.org/release/6-latest/requirements.txt
5757
```
5858

59+
60+
5961
Create a {file}`buildout.cfg` file in your directory with the following contents.
6062

6163
```cfg
@@ -75,6 +77,12 @@ eggs =
7577
Plone
7678
```
7779

80+
Use Buildout's [`bootstrap` command](https://www.buildout.org/en/latest/topics/bootstrapping.html) to install a local `buildout` script in the {file}`bin` directory.
81+
82+
```shell
83+
venv/bin/buildout bootstrap
84+
```
85+
7886
Run Buildout.
7987

8088
```shell
@@ -83,6 +91,7 @@ bin/buildout
8391

8492
This may take a few minutes.
8593

94+
Whenever you change the Buildout configuration, run `./bin/buildout` again.
8695

8796
## Start Plone in foreground mode
8897

docs/admin-guide/install-pip.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For other installation options, see {ref}`get-started-install-label`.
2525
## Prerequisites for installation
2626

2727
- For Plone 6.0, Python {SUPPORTED_PYTHON_VERSIONS_PLONE60}
28-
% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest".
28+
% TODO: These instructions install Plone 6.0.x. Uncomment next line and change the subsequent include when Plone 6.1 is released and "latest".
2929
% - For Plone 6.1, Python {SUPPORTED_PYTHON_VERSIONS_PLONE61}
3030

3131

@@ -47,13 +47,13 @@ cd <my_projects>/plone
4747
Create a Python virtual environment.
4848

4949
```shell
50-
python3 -m venv .
50+
python3 -m venv venv
5151
```
5252

5353
Install Plone and a helper package, {term}`pipx`.
5454

5555
```shell
56-
bin/pip install -c https://dist.plone.org/release/6.0-latest/constraints.txt Plone pipx
56+
venv/bin/pip install -c https://dist.plone.org/release/6.0-latest/constraints.txt Plone pipx
5757
```
5858

5959

docs/admin-guide/run-plone.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ There are different commands to run Plone, depending on which method you used to
1919

2020
Running Plone in foreground mode will show output in the terminal.
2121
This is recommended while developing a Plone site.
22+
The command you use depends on the installation method you used.
2223

2324
Cookieplone:
2425
: ```shell

0 commit comments

Comments
 (0)