Skip to content

Commit 72107df

Browse files
committed
'installation from its packages'; further reprasing; runwsgi with verbose output
1 parent cc1cd37 commit 72107df

File tree

3 files changed

+37
-33
lines changed

3 files changed

+37
-33
lines changed

docs/install/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ What do you want to do?
2828

2929
## Choose an installation method
3030

31-
% TODO Explanation when to choose which installation method: container vs installation from scratch. Combination for backend and frontend?
31+
% TODO Explanation when to choose which installation method: container vs installation from its packages. Combination for backend and frontend?
3232

3333
Developers may choose to install Plone from either [the official container images](containers/index) or [source](source).
3434

docs/install/source-step-by-step.md

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
html_meta:
3-
"description": "Install Plone 6 backend from scratch for the one who wants to look under the hood"
4-
"property=og:description": "Install Plone 6 backend from scratch for the one who wants to look under the hood"
5-
"property=og:title": "Install Plone backend from Scratch – Step by Step"
6-
"keywords": "Plone, Plone 6, install, backend, pip, mxdev, mxmake, cookiecutter, source, Zope, buildout"
3+
"description": "Install Plone 6 backend from its packages for the one who wants to look under the hood"
4+
"property=og:description": "Install Plone 6 backend from its packages for the one who wants to look under the hood"
5+
"property=og:title": "Install Plone backend from its Packages – Step by Step"
6+
"keywords": "Plone, Plone 6, install, backend, pip, mxdev, mxmake, cookiecutter, packages, source, Zope, buildout"
77
---
88

99

1010
(install-source-stepbystep-start-label)=
1111

12-
# Install Plone backend from Scratch – Step by Step
12+
# Install Plone backend from its Packages – Step by Step
1313

1414

1515
(install-source-stepbystep-backend-start-label)=
@@ -21,7 +21,7 @@ For system requirements and pre-requisites for the installation see {ref}`instal
2121
We install the Plone backend with `pip`, `cookiecutter-zope-instance`, `mxdev` and other fancy helpers.
2222

2323
```{note}
24-
There will be one single cookiecutter template to install both backend and frontend from scratch. You will find the instructions on {ref}`install-source-installation-jump-label`. That chapter is for you if you want to develop and want to jump in with all steps prepared by an overall cookiecutter. The subsequent sections explain the installation of the backend step by step. You will learn the details of the installation included in the future overall cookiecutter.
24+
There will be one single cookiecutter template to install both backend and frontend from its packages. You will find the instructions on {ref}`install-source-installation-jump-label`. That chapter is for you if you want to develop and want to jump in with all steps prepared by an overall cookiecutter. The subsequent sections explain the installation of the backend step by step. You will learn the details of the installation included in the future overall cookiecutter.
2525
```
2626

2727

@@ -48,8 +48,6 @@ pip install -U pip wheel
4848
:class: margin toggle
4949
The Plone packages and dependencies are installed in trees.
5050
51-
% TODO Why in trees?
52-
5351
```
5452
venv/lib/Python3.x/
5553
site-packages/
@@ -74,7 +72,6 @@ pip install Plone -c https://dist.plone.org/release/6.0.0a6/constraints.txt
7472
````{admonition} mkwsgiinstance's minimal Zope configuration
7573
:class: margin toggle
7674
`mkwsgiinstance` creates a home with a minimal configuration for a Zope instance.
77-
No blob storage, etc. is defined so far.
7875
7976
```
8077
┌── etc/
@@ -132,11 +129,10 @@ For the configuration, you have two options:
132129
{term}`cookiecutter-zope-instance` is such a template that allows to create a complete Zope configuration.
133130
Zope configuration means:
134131

135-
- type of storage: direct filestorage/blobs, relational database, ZEO, you name it.
136-
- ports,
137-
- threads/caches,
138-
- debugging/profiling options,
139-
- ...
132+
- type of storage: direct filestorage/blobs, relational database, ZEO, you name it
133+
- ports
134+
- threads/caches
135+
- debugging/profiling options
140136

141137
Install cookiecutter:
142138

@@ -152,8 +148,14 @@ cookiecutter https://github.com/plone/cookiecutter-zope-instance
152148

153149
(install-source-cookiecutter-zope-instance-presets-label)=
154150

155-
Instead we prepare a file {file}`instance.yaml` with the parameters we want to set.
156-
A minimal example with one add-on configured is (add options as needed):
151+
Instead we prepare a configuration file {file}`instance.yaml` with the parameters we want to set.
152+
In this section we will learn how to configure our `Zope` / `Plone` installation via `instance.yaml`.
153+
A minimal example with one add-on configured:
154+
155+
```{note}
156+
:class: margin
157+
Reference of configuration options of [`cookiecutter-zope-instance`](https://github.com/plone/cookiecutter-zope-instance#options).
158+
```
157159

158160
```yaml
159161
default_context:
@@ -166,10 +168,10 @@ default_context:
166168
db_storage: direct
167169
```
168170
169-
Find more [options of cookiecutter `cookiecutter-zope-instance`](https://github.com/plone/cookiecutter-zope-instance#options).
170171
171-
The file {file}`instance.yaml` allows to set some presets.
172-
Add-ons are listed here, but need to be installed with pip.
172+
173+
174+
Add-ons are listed here to be loaded by `Zope` app. As python packages they also need to be installed with pip.
173175
The documented installation of add-ons with pip is achieved via a {file}`requirements.txt` file.
174176
We list an add-on like for example `collective.easyform` in\
175177
`requirements.txt`:
@@ -186,7 +188,7 @@ pip install -r requirements.txt
186188

187189
You have done two things so far: You installed your add-on packages and you have prepared an initializing file to roll out a Zope / Plone project, configured to load your installed add-on packages.
188190

189-
You are now ready to apply `cookiecutter`to generate the Zope configuration:
191+
You are now ready to apply `cookiecutter` to generate the Zope configuration:
190192

191193
```shell
192194
cookiecutter -f --no-input --config-file instance.yaml https://github.com/plone/cookiecutter-zope-instance
@@ -225,7 +227,7 @@ Summed up tasks and commands after creating a Zope instance with {ref}`mkwsgiins
225227
It's time to start the new Zope instance.
226228

227229
```shell
228-
runwsgi instance/etc/zope.ini
230+
runwsgi -v instance/etc/zope.ini
229231
```
230232

231233
Head over to http://localhost:8080/ and see that Plone is running.
@@ -253,10 +255,12 @@ plone.api>=2.0.0a3
253255
Unfortunatly pip does not allow this way of overwriting constraints.
254256
255257
`mxdev` is made for assembling Plone constraints with your needs of version pinning or source checkouts.\
256-
It reads your {file}`constraints.txt`, fetches the constraints of Plone and writes a {file}`constraints-mxdev.txt` which combines the constraints. Comments on which Plone constraint is modified assure the readability.
257-
% TODO language: 'readability'?
258+
It reads your {file}`requirements.txt` and so your {file}`constraints.txt`, fetches the requirements/constraints of Plone and writes the files {file}`requirements-mxdev.txt` and {file}`constraints-mxdev.txt`.
259+
Both are containing the combined requirements and constraints, but modified according to the configuration in {file}`mx.ini`.
260+
The generated files are transparent about where constraints were fetched from and comments are added when a modification was necessary.
258261
259-
mxdev operates on three files to tell pip which packages to install with which version.
262+
In summary, mxdev operates on three files to tell pip which packages to install with which version.
263+
A minimal example set of files would look like the following.
260264
261265
{file}`requirements.txt`
262266

docs/install/source.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
html_meta:
3-
"description": "Install Plone 6 from scratch – the installer"
4-
"property=og:description": "Install Plone 6 from scratch – the installer"
5-
"property=og:title": "Install Plone from scratch"
6-
"keywords": "Plone, Plone 6, install, pip, scratch, source, buildout"
3+
"description": "Install Plone 6 from its packages – the installer"
4+
"property=og:description": "Install Plone 6 from its packages – the installer"
5+
"property=og:title": "Install Plone from its Packages"
6+
"keywords": "Plone, Plone 6, install, pip, packages, source, buildout"
77
---
88

99

1010
(install-source-1-label)=
1111

12-
# Install Plone from Scratch
12+
# Install Plone from its Packages
1313

14-
Installation from scratch is for development and it is reasonable for deployment with full control.
14+
Installation from its packages is for development and it is reasonable for deployment with full control.
1515

1616
As an overview, you will perform the following steps in order.
1717

@@ -152,7 +152,7 @@ Instead we customize the setting with additional add-ons and constraints of a Pl
152152

153153
(install-source-tweak-backend-installation-label)=
154154

155-
### Tasks on your backend installation from scratch
155+
### Tasks on your backend installation from its packages
156156

157157
You have installed Plone with `pip` like explained above or in {ref}`install-source-stepbystep-start-label`.
158158

@@ -376,7 +376,7 @@ Now that you installed your backend and decided to go with the ReactJS frontend,
376376

377377
Instead navigate to {doc}`/classic-ui/index` if you do not want a ReactJs based frontend, but prefer to go with a Plone Classic frontend.
378378

379-
<!-- TODO strip all down to official Plone 6 frontend installation (from scratch. no docker) (https://6.dev-docs.plone.org/volto/getting-started/install.html#installing-volto) -->
379+
<!-- TODO strip all down to official Plone 6 frontend installation (from its packages. no docker) (https://6.dev-docs.plone.org/volto/getting-started/install.html#installing-volto) -->
380380

381381

382382
(install-source-nvm-node-version-manager-label)=

0 commit comments

Comments
 (0)