Skip to content

Commit 645d911

Browse files
committed
Apply Steve's review comments on 'installation from packages'
1 parent 14b5b6f commit 645d911

File tree

4 files changed

+48
-50
lines changed

4 files changed

+48
-50
lines changed

docs/glossary.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Linode
4747
[Linode.com](https://www.linode.com/) is an American privately owned virtual private server provider company based in Galloway, New Jersey, United States.
4848
4949
mxdev
50-
[mxdev](https://github.com/mxstack/mxdev) [mɪks dɛv] is a utility that makes it easy to work with Python projects containing lots of packages, of which you only want to develop some.
50+
[mxdev](https://github.com/mxstack/mxdev) [mɪks dɛv] is a utility that makes it easy to work with Python projects containing lots of packages, and you want to develop only some of those packages.
5151
It is designed for developers who use stable version constraints, then layer their customizations on top of that base while using a version control system.
5252
This design allows developers to override their base package constraints with a customized or newer version.
5353
@@ -348,7 +348,7 @@ Slate
348348
It enables you to create powerful, intuitive editors similar to those you've probably used in Medium, Dropbox Paper, or Google Docs.
349349
350350
volto-slate
351-
`volto-slate` is an interactive default text editor for Volto, developed on top of {term}`Slate` while offering enhanced WYSIWYG functionality and behavior.
351+
`volto-slate` is an interactive default text editor for Volto, developed on top of {term}`Slate`, offering enhanced WYSIWYG functionality and behavior.
352352
353353
elementEditor
354354
A generic {term}`volto-slate` plugin architecture that can be used to create other editor interactions that follow the pattern of having a button that toggles a format (an inline element).
@@ -358,11 +358,11 @@ WSGI
358358
The Web Server Gateway Interface (WSGI, pronounced _WIZ-ghee_) is a simple calling convention for web servers to forward requests to web applications or frameworks written in the Python programming language.
359359
360360
ZEO
361-
[ZEO](https://zeo.readthedocs.io/) is a client-server storage for ZODB for sharing a single storage among many clients.
361+
[ZEO](https://zeo.readthedocs.io/en/latest) is a client-server storage for ZODB for sharing a single storage among many clients.
362362
363363
ZODB
364-
[A native object database for Python](https://zodb.org/).
364+
[A native object database for Python](https://zodb.org/en/latest/).
365365
366366
Zope
367-
[Zope](https://zope.readthedocs.io/) is a Python-based application server for building secure and highly scalable web applications.
367+
[Zope](https://zope.readthedocs.io/en/latest/) is a Python-based application server for building secure and highly scalable web applications.
368368
```

docs/install/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ 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 its packages. Combination for backend and frontend?
31+
```{todo}
32+
Explanation when to choose which installation method: container vs installation from its packages. Combination for backend and frontend?
33+
```
3234

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

@@ -69,6 +71,6 @@ System requirements depend upon your choice of installation method:
6971
:hidden: true
7072
7173
containers/index
72-
source
73-
source-step-by-step
74+
installation-from-packages
75+
installation-backend-from-packages-step-by-step
7476
```

docs/install/source-step-by-step.md renamed to docs/install/installation-backend-from-packages-step-by-step.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,37 @@
22
html_meta:
33
"description": "Install Plone 6 backend from its packages for the one who wants to look under the hood"
44
"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"
5+
"property=og:title": "Install Plone backend from its Packages – Step-by-step"
66
"keywords": "Plone, Plone 6, install, backend, pip, mxdev, mxmake, cookiecutter, packages, source, Zope, buildout"
77
---
88

99

10-
(install-source-stepbystep-start-label)=
10+
(installation-backend-from-packages-step-by-step-start-label)=
1111

12-
# Install Plone backend from its Packages – Step by Step
13-
14-
15-
(install-source-stepbystep-backend-start-label)=
16-
17-
## Backend
12+
# Install Plone backend from its Packages – Step-by-step
1813

1914
For system requirements and pre-requisites for the installation see {ref}`install-source-system-requirements-label`.
2015

21-
We install the Plone backend with `pip`, `cookiecutter-zope-instance`, `mxdev` and other fancy helpers.
16+
We install the Plone backend with `pip`, `cookiecutter-zope-instance`, `mxdev` and other developer tools.
2217

2318
```{note}
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.
19+
There will be one single cookiecutter template to install both backend and frontend from its packages.
20+
You will find the instructions on {ref}`install-source-installation-jump-label`.
21+
That chapter is for you if you want to develop and want to jump in with all steps prepared by an overall cookiecutter.
22+
The subsequent sections explain the installation of the backend step-by-step.
23+
You will learn the details of the installation included in the future overall cookiecutter.
2524
```
2625

2726

28-
(install-source-installation-steps-label)=
29-
30-
### Installation steps
27+
(installation-backend-from-packages-installation-steps-label)=
3128

32-
Create a new directory to hold your project, make it your current directory, then issue the following commands in a shell session.
29+
## Installation steps
3330

34-
Create a Python virtual environment in the current directory.
31+
Create a new directory to hold your project and make it your current directory.
32+
Next issue the following commands in a shell session to create a Python virtual environment in the current directory.
3533

3634
```shell
37-
python3.9 -m venv venv
35+
python -m venv venv
3836
source venv/bin/activate
3937
```
4038

@@ -49,9 +47,10 @@ pip install -U pip wheel
4947
The Plone packages and dependencies are installed in trees.
5048
5149
```
52-
venv/lib/Python3.x/
53-
site-packages/
54-
┌── plone/
50+
venv/lib/python3.x/site-packages
51+
52+
53+
├── plone
5554
│ ├── …
5655
│ ├── app/
5756
│    ├── caching/
@@ -69,9 +68,8 @@ Install Plone 6 with constrained requirements using `pip`.
6968
pip install Plone -c https://dist.plone.org/release/6.0.0a6/constraints.txt
7069
```
7170

72-
````{admonition} mkwsgiinstance's minimal Zope configuration
71+
:::{admonition} <span>`mkwsgiinstance` creates a home with a minimal configuration for a Zope instance.</span>
7372
:class: margin toggle
74-
`mkwsgiinstance` creates a home with a minimal configuration for a Zope instance.
7573

7674
```
7775
┌── etc/
@@ -84,11 +82,11 @@ pip install Plone -c https://dist.plone.org/release/6.0.0a6/constraints.txt
8482
├── log/
8583
└── REAMDME.txt/
8684
```
87-
````
85+
:::
8886

89-
Create a Zope instance with the given username and password in the current directory.
87+
(installation-backend-from-packages-step-by-step-mkwsgiinstance)=
9088

91-
(install-source-mkwsgiinstance)=
89+
Create a Zope instance with the given username and password in the current directory.
9290

9391
```shell
9492
mkwsgiinstance -u admin:admin -d .
@@ -98,7 +96,7 @@ mkwsgiinstance -u admin:admin -d .
9896
:class: margin
9997
10098
```shell
101-
python3.9 -m venv venv
99+
python -m venv venv
102100
source venv/bin/activate
103101
pip install -U pip wheel
104102
pip install Plone -c https://dist.plone.org/release/6.0.0a6/constraints.txt
@@ -112,18 +110,18 @@ Start the Zope instance.
112110
runwsgi ./etc/zope.ini
113111
```
114112

113+
It will take a few seconds to start the Zope instance.
115114
You can stop the instance later with {kbd}`ctrl-esc`.
116115

117-
If you now open the browser with http://localhost:8080/, you see that you already can create a Plone instance.
118-
Before doing this, we configure our Zope instance for blobs, configure add-ons, etc..
116+
Before creating a Plone site on http://localhost:8080/, we configure our Zope instance for blobs, configure add-ons, etc..
119117

120118
For the configuration, you have two options:
121119
1. *manual* configuration by editing {file}`site.zcml` and {file}`zope.conf` (^[Configuring and Running Zope](https://zope.readthedocs.io/en/latest/operation.html))
122120
2. *generate* configuration by applying `cookiecutter-zope-instance`
123121

124122
(install-source-cookiecutter-zope-instance-label)=
125123

126-
#### Generate Plone / Zope configuration with cookiecutter
124+
### Generate Plone / Zope configuration with cookiecutter
127125

128126
{term}`Cookiecutter` creates projects from project templates.
129127
{term}`cookiecutter-zope-instance` is such a template that allows to create a complete Zope configuration.
@@ -239,7 +237,7 @@ If you want to develop a Plone package, then the subsequent section is for you.
239237

240238
(install-source-checkout-and-pin)=
241239

242-
#### Checkout or version pinning of a Plone package
240+
### Checkout or version pinning of a Plone package
243241

244242
If you want to checkout a Plone Core package for development or just want to override the constraints of Plone, then a first attempt would be to define constraints with a {file}`constraints.txt` to tell pip to install a different version of a Plone package.
245243

docs/install/source.md renamed to docs/install/installation-from-packages.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Application server {term}`Zope` with its database {term}`ZODB` provides the base
4949

5050
## Installation backend
5151

52-
We install the Plone backend with {term}`pip`, {term}`mxdev` and other fancy helpers.
52+
We install the Plone backend with {term}`pip`, {term}`mxdev` and other developer tools.
5353

5454
If you used Plone before, you are probably familiar with a `buildout` Plone installation.
5555
The installation with `zc.buildout` was the way to go for Plone 5.
@@ -78,18 +78,17 @@ Plone 6 prefers to be installed with {term}`pip`, which is the mainstream packag
7878

7979
```{important}
8080
There will be one single cookiecutter template to install both backend and frontend.
81-
By now the chapter {ref}`install-source-stepbystep-start-label` is for you.
81+
By now the chapter {ref}`installation-backend-from-packages-step-by-step-start-label` is for you.
8282
It explains the installation of the backend with `pip`.
8383
```
8484

85-
<!-- TODO Add installation steps for future cookiecutter template 'cookiecutter-plone-starter' https://github.com/collective/cookiecutter-plone-starter/
85+
```{todo} Add installation steps for future cookiecutter template 'cookiecutter-plone-starter' https://github.com/collective/cookiecutter-plone-starter/
8686
87-
Create a new directory to hold your project, make it your current directory, then issue the following commands in a shell session.
88-
89-
Create a Python virtual environment in the current directory.
87+
Create a new directory to hold your project and make it your current directory.
88+
Issue the following commands in a shell session to create a Python virtual environment in the current directory.
9089
9190
```shell
92-
python3.9 -m venv venv
91+
python -m venv venv
9392
source venv/bin/activate
9493
```
9594

@@ -141,14 +140,14 @@ We are now working with `make`. All available commands are listed with
141140
`make help`.
142141

143142
We could now build and run Zope / Plone with one command `make run`.\
144-
Instead we customize the setting with additional add-ons and constraints of a Plone package and a checkout of a Plone package. -->
143+
Instead we customize the setting with additional add-ons and constraints of a Plone package and a checkout of a Plone package. ``-->``
145144

146145

147146
(install-source-tweak-backend-installation-label)=
148147

149148
### Tasks on your backend installation from its packages
150149

151-
You have installed Plone with `pip` like explained above or in {ref}`install-source-stepbystep-start-label`.
150+
You have installed Plone with `pip` like explained above or in {ref}`installation-backend-from-packages-step-by-step-start-label`.
152151

153152
Add an add-on
154153
: 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:
@@ -495,10 +494,11 @@ You have completed the installation of Plone 6 with Volto frontend.
495494
Welcome to Plone 6!
496495
497496
498-
<!-- TODO I have now my local environment with add-ons. How do I deploy?
497+
```{todo}
498+
Now I have my local environment with add-ons. How do I deploy?
499499
- instructions, configuration, secrets with Ansible
500500
- orchestrating processes with pm2 https://pm2.keymetrics.io/ see Volto chapters
501-
-->
501+
```
502502
503503
504504
(install-source-process-manger)=
@@ -569,8 +569,6 @@ pm2 stop plone_backend_tutorial
569569
% Future cookiecutter template for backend and frontend
570570
% - {term}`cookiecutter-plone-starter`
571571
572-
<!-- TODO Update used tools -->
573-
574572
575573
## Footnotes
576574

0 commit comments

Comments
 (0)