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
Copy file name to clipboardExpand all lines: docs/admin-guide/add-ons.md
+7-49Lines changed: 7 additions & 49 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,71 +20,29 @@ See {doc}`/volto/development/add-ons/index`.
20
20
21
21
## Install an add-on from PyPI
22
22
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`.
24
24
25
25
26
26
### Configure add-on installation
27
27
28
28
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.
35
30
36
31
`````{tab-set}
37
32
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.
0 commit comments