You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#### Generate Plone / Zope configuration with cookiecutter
131
132
132
133
`Cookiecutter` creates projects from project templates.
133
134
{term}`cookiecutter-zope-instance` is such a template that allows to create a complete Zope configuration. Zope configuration means: blob storage, type of file storage (Zope style or relational database), ZEO, you name it.
@@ -165,7 +166,7 @@ Find more [options of cookiecutter `cookiecutter-zope-instance`](https://github.
165
166
The file {file}`instance.yaml` allows to set some presets.
166
167
Add-ons are listed here, but need to be installed with pip.
167
168
The documented installation of add-ons with pip is achieved via a {file}`requirements.txt` file.
168
-
An add-on like for example `collective.easyform` is listed in\
169
+
We list an add-on like for example `collective.easyform` in\
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.
182
183
183
-
You are now ready to apply your cookiecutter:
184
+
You are now ready to apply `cookiecutter`to generate the Zope configuration:
A run of mxdev reads {file}`requirements.txt`, {file}`constraints.txt` and {file}`mx.ini`, and writes new combined requirements in {file}`requirements-mxdev.txt` and writes new constraints in {file}`constraints-mxdev.txt` according to {file}`mx.ini`:
290
291
291
-
- 'version-overrides' in [settings]
292
+
- 'version-overrides' in section [settings]
292
293
- checkout settings in [packagename] sections
293
294
294
295
@@ -311,9 +312,10 @@ Create
311
312
```
312
313
````
313
314
314
-
So with the three files above, run `mxdev` with:
315
+
So with the three files above, install and run `mxdev` with:
Copy file name to clipboardExpand all lines: docs/install/source.md
+66-11Lines changed: 66 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,8 @@ short explanation of backend components and how they interact
46
46
- Plone instance
47
47
- {term}`WSGI`
48
48
- REST API
49
+
50
+
Application server {term}`Zope` is working hard. {term}`Plone` provides the CMS stuff. {term}`WSGI` fills the gap between Python app Zope and web server. {term}`REST API` is the interface to request the Plone backend from thin air. The frontend {term}`Volto` does request this interface. Voilà.
49
51
```
50
52
51
53
@@ -78,7 +80,7 @@ You are probably familiar with a `buildout` Plone installation. The installation
78
80
79
81
### Installation – jump in and enfold the beauty
80
82
81
-
```{note}
83
+
```{important}
82
84
There will be one single cookiecutter template to install both backend and frontend.
83
85
By now the chapter {ref}`install-source-stepbystep-start-label` is for you.
84
86
It explains the installation of the backend with `pip`.
@@ -150,7 +152,9 @@ Instead we customize the setting with additional add-ons and constraints of a Pl
150
152
151
153
### Tasks on your backend installation from scratch
152
154
153
-
Adding an add-on
155
+
You have installed Plone with `pip` like explained above or in {ref}`install-source-stepbystep-start-label`.
156
+
157
+
Add an add-on
154
158
: Add a line with the name of your add-on to `requirements.txt` and add it to {ref}`instance.yaml<install-source-cookiecutter-zope-instance-presets-label>`, then install with pip and apply cookiecutter:
155
159
156
160
{file}`requirements.txt`:
@@ -173,7 +177,7 @@ Adding an add-on
173
177
pip install -r requirements-mxdev.txt
174
178
```
175
179
176
-
Pin version of an add-on
180
+
Pin the version of an add-on
177
181
: Pin the version in {file}`constraints.txt`:
178
182
179
183
```
@@ -204,13 +208,7 @@ Pin version of an add-on
204
208
205
209
206
210
Checkout an add-on
207
-
: Configure the repository address and branch in {file}`constraints.txt`:
0 commit comments