Skip to content

Commit b8d9e0b

Browse files
committed
Update 'Backend installation details' and move to additional info
1 parent 2ce5828 commit b8d9e0b

File tree

1 file changed

+35
-27
lines changed

1 file changed

+35
-27
lines changed

docs/install/manage-add-ons-packages.md

Lines changed: 35 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -28,33 +28,6 @@ It generates files for installing and configuring both the frontend and backend.
2828
For the backend, it uses [`cookiecutter-zope-instance`](https://github.com/plone/cookiecutter-zope-instance) to generate configuration files for a Zope WSGI instance.
2929

3030

31-
(manage-backend-installation-details-label)=
32-
33-
## Backend installation details
34-
35-
Inside your project, open `backend/Makefile`.
36-
The `make` target `instance/etc/zope.ini` performs several tasks.
37-
38-
```makefile
39-
bin/pip:
40-
@echo "$(GREEN)==> Setup Virtual Env$(RESET)"
41-
python3 -m venv .
42-
bin/pip install -U "pip" "wheel" "cookiecutter"
43-
44-
instance/etc/zope.ini: bin/pip
45-
@echo "$(GREEN)==> Install Plone and create instance$(RESET)"
46-
bin/pip install Plone -c https://dist.plone.org/release/$(PLONE_VERSION)/constraints.txt
47-
bin/cookiecutter -f --no-input --config-file instance.yaml https://github.com/plone/cookiecutter-zope-instance
48-
mkdir -p var/{filestorage,blobstorage,cache,log}
49-
```
50-
51-
- Creates a virtual environment if one does not exist, then upgrades Python package management tools.
52-
- Installs Plone using a given `constraints.txt` file for a specific version using `pip`.
53-
- Creates or updates the Zope configuration from its `instance.yaml` file using `cookiecutter-zope-instance`.
54-
- Creates specified directories, if they do not exist.
55-
56-
You can configure your Zope instance using `make` as described in the next section.
57-
5831

5932
(manage-zope-configuration-with-cookiecutter-zope-instance-label)=
6033

@@ -503,3 +476,38 @@ Stop a named process with the following command.
503476
```shell
504477
pm2 stop plone_backend_tutorial
505478
```
479+
480+
481+
482+
(manage-backend-installation-details-label)=
483+
484+
## Backend installation details
485+
486+
Inside your project, open `backend/Makefile`.
487+
488+
```makefile
489+
bin/pip:
490+
@echo "$(GREEN)==> Setup Virtual Env$(RESET)"
491+
python -m venv .
492+
bin/pip install -U "pip" "wheel" "cookiecutter" "mxdev"
493+
494+
instance/etc/zope.ini: bin/pip
495+
@echo "$(GREEN)==> Install Plone and create instance$(RESET)"
496+
bin/cookiecutter -f --no-input --config-file instance.yaml https://github.com/plone/cookiecutter-zope-instance
497+
mkdir -p var/{filestorage,blobstorage,cache,log}
498+
499+
build-dev: instance/etc/zope.ini ## pip install Plone packages
500+
@echo "$(GREEN)==> Setup Build$(RESET)"
501+
bin/mxdev -c mx.ini
502+
bin/pip install -r requirements-mxdev.txt
503+
```
504+
505+
/ `make build-backend`
506+
507+
- Creates a `Python` virtual environment if one does not exist, then upgrades Python package management tools.
508+
- Creates or updates the Zope configuration from its `instance.yaml` file using `cookiecutter-zope-instance`.
509+
- Creates specified directories, if they do not exist.
510+
- Installs Plone core packages and add-ons according `mx.ini`, `requirements.txt` and `constraint.txt`
511+
512+
You can configure your Zope instance using `make` as described in the next section.
513+

0 commit comments

Comments
 (0)