Skip to content

Commit 733724e

Browse files
committed
Update "Backend installation details" section
1 parent a7f709e commit 733724e

File tree

1 file changed

+37
-18
lines changed

1 file changed

+37
-18
lines changed

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

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ Follow the upgrade information, if present.
342342

343343
### Build and start your instance
344344

345-
Build and run Plone backend.
345+
Build and run the Plone backend.
346346

347347
```shell
348348
make build-backend
@@ -358,33 +358,49 @@ Your instance is running in the foreground.
358358

359359
## Backend installation details
360360

361-
Inside your project, open `backend/Makefile`.
361+
The `Makefile` at the root of you project invokes commands in `backend/Makefile`.
362+
Here are excerpts from `backend/Makefile` to show details of the `make build-backend` command.
362363

363364
```makefile
364365
bin/pip:
365-
@echo "$(GREEN)==> Setup Virtual Env$(RESET)"
366-
python -m venv .
367-
bin/pip install -U "pip" "wheel" "cookiecutter" "mxdev"
366+
@echo "$(GREEN)==> Setup Virtual Env$(RESET)"
367+
python3 -m venv .
368+
bin/pip install -U "pip" "wheel" "cookiecutter" "mxdev"
368369

369-
instance/etc/zope.ini: bin/pip
370-
@echo "$(GREEN)==> Install Plone and create instance$(RESET)"
371-
bin/cookiecutter -f --no-input --config-file instance.yaml https://github.com/plone/cookiecutter-zope-instance
372-
mkdir -p var/{filestorage,blobstorage,cache,log}
370+
instance/etc/zope.ini: bin/pip
371+
@echo "$(GREEN)==> Install Plone and create instance$(RESET)"
372+
bin/cookiecutter -f --no-input --config-file instance.yaml https://github.com/plone/cookiecutter-zope-instance
373+
mkdir -p var/{filestorage,blobstorage,cache,log}
373374

375+
# ...
376+
377+
.PHONY: build-dev
374378
build-dev: instance/etc/zope.ini ## pip install Plone packages
375-
@echo "$(GREEN)==> Setup Build$(RESET)"
376-
bin/mxdev -c mx.ini
377-
bin/pip install -r requirements-mxdev.txt
379+
@echo "$(GREEN)==> Setup Build$(RESET)"
380+
bin/mxdev -c mx.ini
381+
bin/pip install -r requirements-mxdev.txt
378382
```
379383

380-
/ `make build-backend`
384+
The command `make build-backend`:
385+
386+
- Invokes the target `build-dev` target in `backend/Makefile`.
387+
- This invokes the target `instance/etc/zope.ini`.
388+
- This invokes the target `bin/pip`.
389+
390+
- This creates a `Python` virtual environment if one does not exist.
391+
- It installs and upgrades Python package management tools in that virtual environment.
392+
393+
- Returning to the target `instance/etc/zope.ini`:
381394

382-
- Creates a `Python` virtual environment if one does not exist, then upgrades Python package management tools.
383-
- Creates or updates the Zope configuration from its `instance.yaml` file using `cookiecutter-zope-instance`.
384-
- Creates specified directories, if they do not exist.
385-
- Installs Plone core packages and add-ons according `mx.ini`, `requirements.txt` and `constraint.txt`
395+
- This creates or updates the Zope configuration from its `instance.yaml` file using `cookiecutter-zope-instance`.
396+
- Creates specified directories, if they do not exist.
386397

387-
You can configure your Zope instance as described in section {ref}`manage-common-management-tasks-label`.
398+
- Returning to the target `build-dev`:
399+
400+
- This generates the `mxdev` files as described above in {ref}`manage-mxdev-usage-overview-label`.
401+
- Installs Plone core packages and add-ons from the files generated by `mxdev`.
402+
403+
You can configure your Zope instance as described in the section {ref}`manage-common-management-tasks-label`.
388404

389405

390406
````{todo}
@@ -395,6 +411,9 @@ configuration frontend:
395411

396412
Add info here or link to respective frontend chapter.
397413
localhost:8050/volto/addons/index.html#configuring-a-volto-project-to-use-an-addon
414+
This already exists above:
415+
For developing add-ons for the Plone frontend, Volto, see {doc}`volto/addons/index`.
416+
398417

399418
run
400419
```

0 commit comments

Comments
 (0)