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

Improve install docs #1760

Merged
merged 5 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/admin-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ myst:

# Admin guide

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


```{toctree}
Expand Down
15 changes: 12 additions & 3 deletions docs/admin-guide/install-buildout.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}


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

```shell
python3 -m venv .
python3 -m venv venv
davisagli marked this conversation as resolved.
Show resolved Hide resolved
```

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
Expand All @@ -75,6 +77,12 @@ eggs =
Plone
```

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.

```shell
venv/bin/buildout bootstrap
```

Run Buildout.

```shell
Expand All @@ -83,6 +91,7 @@ bin/buildout

This may take a few minutes.

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

## Start Plone in foreground mode

Expand Down
6 changes: 3 additions & 3 deletions docs/admin-guide/install-pip.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}


Expand All @@ -47,13 +47,13 @@ cd <my_projects>/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
```


Expand Down
1 change: 1 addition & 0 deletions docs/admin-guide/run-plone.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ There are different commands to run Plone, depending on which method you used to

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

Cookieplone:
: ```shell
Expand Down