Skip to content

Commit a1ac3f9

Browse files
committed
The instructions for installation from PyPI for both uv and pip were identical. Combine into the project creation method instead.
1 parent f8b392b commit a1ac3f9

1 file changed

Lines changed: 7 additions & 49 deletions

File tree

docs/admin-guide/add-ons.md

Lines changed: 7 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -20,71 +20,29 @@ See {doc}`/volto/development/add-ons/index`.
2020

2121
## Install an add-on from PyPI
2222

23-
This section describes how to install an add-on that is released on {term}`PyPI`
23+
This section describes how to install an add-on that is released on {term}`PyPI`.
2424

2525

2626
### Configure add-on installation
2727

2828
First, configure your project according to the instructions in the tabbed interface below.
29-
Select the tab according to your Python package manager.
30-
31-
```{tip}
32-
Select the tab {guilabel}`uv` for projects created with Cookieplone which have in the file {file}`backend/pyproject.toml`, under the `[tool.uv]` table, the setting of `managed = true`.
33-
Select the tab {guilabel}`pip` for projects created with Cookieplone that don't have this setting.
34-
```
29+
Select the tab according to the method you used to create your project.
3530

3631
`````{tab-set}
3732
38-
````{tab-item} uv
39-
40-
Add the name of your add-on in the file {file}`backend/pyproject.toml` in the section `dependencies`.
41-
This example adds [`collective.easyform`](https://pypi.org/project/collective.easyform/).
42-
43-
```{code-block} toml
44-
:emphasize-lines: 6
45-
dependencies = [
46-
"Products.CMFPlone==6.1.1",
47-
"plone.api",
48-
"plone.classicui",
49-
"plone.app.caching",
50-
"collective.easyform==4.4.0",
51-
]
52-
```
53-
54-
```{tip}
55-
Including the add-on version, or "pinning a version", ensures that it won't unintentionally get upgraded in the future.
56-
```
57-
58-
Also add the add-on to `zcml_package_includes` in the file {file}`backend/instance.yaml` to make sure its configuration will be loaded.
59-
60-
```yaml
61-
default_context:
62-
zcml_package_includes: project_title, collective.easyform
63-
```
64-
65-
Stop the backend with {kbd}`ctrl-c`.
66-
67-
To actually download and install the new add-on, run the following command.
68-
69-
```shell
70-
make backend-build
71-
```
72-
73-
````
74-
75-
````{tab-item} pip
33+
````{tab-item} Cookieplone
7634
7735
Add the name of your add-on in the file {file}`backend/pyproject.toml` in the section `dependencies`.
7836
This example adds [`collective.easyform`](https://pypi.org/project/collective.easyform/).
7937
8038
```{code-block} toml
8139
:emphasize-lines: 6
8240
dependencies = [
83-
"Products.CMFPlone==6.1.1",
41+
"Products.CMFPlone==6.1.4",
8442
"plone.api",
8543
"plone.classicui",
8644
"plone.app.caching",
87-
"collective.easyform==4.4.0",
45+
"collective.easyform==4.5.1",
8846
]
8947
```
9048
@@ -215,11 +173,11 @@ This example adds [`collective.easyform`](https://pypi.org/project/collective.ea
215173
```{code-block} toml
216174
:emphasize-lines: 6
217175
dependencies = [
218-
"Products.CMFPlone==6.1.1",
176+
"Products.CMFPlone==6.1.4",
219177
"plone.api",
220178
"plone.classicui",
221179
"plone.app.caching",
222-
"collective.easyform",
180+
"collective.easyform==4.5.1",
223181
]
224182
```
225183

0 commit comments

Comments
 (0)