Skip to content

Commit ee90925

Browse files
committed
Update include for installing Python, to avoid repetition.
Update after walk-through of process, adding missing bits and pieces.
1 parent 6a1211b commit ee90925

File tree

2 files changed

+31
-19
lines changed

2 files changed

+31
-19
lines changed

docs/_inc/_install-python-plone61.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,3 @@ Installing Python is beyond the scope of this documentation.
22
However, it is recommended to use a Python version manager, {term}`pyenv`, that allows you to install multiple versions of Python on your development environment without destroying your system's Python.
33
% TODO: uncomment this line after upgrading to plone-sphinx-theme and latest Sphinx which supports replacements inside includes.
44
% Plone requires Python version {SUPPORTED_PYTHON_VERSIONS_PLONE61}.
5-
6-
Plone 6.0 requires Python version 3.8, 3.9, 3.10, 3.11, or 3.12.
7-
8-
Plone 6.1 requires Python version 3.10, 3.11, or 3.12.

docs/admin-guide/install-buildout.md

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ myst:
1414
This chapter describes how you can install Plone using {term}`Buildout`.
1515

1616
This is one way to install Plone with the Classic UI.
17-
Using Buildout will be the most familiar approach for admins who have experience with Plone 3, 4, or 5.
17+
Using Buildout will be the most familiar approach for administrators who have experience with Plone 3, 4, or 5.
1818

1919
```{seealso}
2020
For other installation options, see {ref}`get-started-install-label`.
@@ -26,39 +26,40 @@ For other installation options, see {ref}`get-started-install-label`.
2626

2727
- For Plone 6.0, Python {SUPPORTED_PYTHON_VERSIONS_PLONE60}
2828
- For Plone 6.1, Python {SUPPORTED_PYTHON_VERSIONS_PLONE61}
29-
- Buildout
3029

3130

3231
### Python
3332

3433
```{include} /_inc/_install-python-plone61.md
3534
```
3635

37-
### Buildout
38-
39-
See [Getting started with Buildout](http://www.buildout.org/en/latest/getting-started.html).
40-
4136

4237
## Installation
4338

44-
Select a directory of your choice:
39+
Select a directory of your choice.
4540

4641
```shell
47-
mkdir -p /opt/plone && cd /opt/plone
42+
mkdir -p <my_projects>/plone && cd <my_projects>/plone
4843
```
4944

50-
Create a Python virtual environment:
45+
Create a Python virtual environment.
5146

5247
```shell
5348
python3 -m venv .
5449
```
5550

56-
Install the minimal Python packages needed in order to run Buildout:
51+
Install the minimal Python packages needed in order to run Buildout.
5752

5853
```shell
5954
bin/pip install -r https://dist.plone.org/release/6-latest/requirements.txt
6055
```
6156

57+
Install Buildout into the Python virtual environment.
58+
59+
```shell
60+
bin/pip install zc.buildout
61+
```
62+
6263
Create a `buildout.cfg` file in your directory with the following contents:
6364

6465
```cfg
@@ -77,12 +78,15 @@ eggs =
7778
Plone
7879
```
7980

80-
Run buildout:
81+
Run Buildout.
8182

8283
```shell
8384
bin/buildout
8485
```
8586

87+
This may take a few minutes.
88+
89+
8690
## Run Plone in foreground mode
8791

8892
Start the instance for a quick test in foreground mode:
@@ -91,21 +95,33 @@ Start the instance for a quick test in foreground mode:
9195
bin/instance fg
9296
```
9397

94-
Your instance starts in foreground mode, which is only advisable for troubleshooting or for local demonstration purposes.
98+
Your instance starts in foreground mode.
99+
This should be used only for troubleshooting or local demonstration purposes.
100+
101+
Now you can visit `http://localhost:8080` in your browser.
102+
Select {guilabel}`Create Classic UI Plone site`.
103+
104+
Enter {guilabel}`username` of `admin`, and {guilabel}`password` of `admin`.
105+
106+
Fill out the form as needed, and click {guilabel}`Create Plone Site`.
107+
108+
You will be redirected to your new Plone instance.
109+
110+
To stop the Plone instance in foreground mode, type {kbd}`CTRL-C`.
95111

96-
Now you can call the url `http://localhost:8080` in your browser and you can add a **Classic UI Plone site**.
97112

98113
## Start Plone as a background service
99114

100-
Start the instance:
115+
Start the instance.
101116

102117
```shell
103118
bin/instance start
104119
```
105120

121+
106122
## Stop Plone as a background service
107123

108-
Stop the instance:
124+
Stop the instance.
109125

110126
```shell
111127
bin/instance stop

0 commit comments

Comments
 (0)