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
+93-2Lines changed: 93 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,8 @@ See {doc}`/volto/development/add-ons/index`.
23
23
For instructions to install an add-on that is released on {term}`PyPI`, select the tab below according to your Python package manager.
24
24
25
25
```{tip}
26
-
Select the tab for uv if you have a project that was created using Cookieplone.
26
+
Select the tab for uv if you have a project that was created using Cookieplone, and you have `managed = true` set in the `[tool.uv]` section of the file {file}`backend/pyproject.toml`.
27
+
Select the tab for pip if you have a project that was created using Cookieplone that does not have this setting.
27
28
```
28
29
29
30
`````{tab-set}
@@ -65,6 +66,43 @@ make backend-build
65
66
66
67
````
67
68
69
+
````{tab-item} pip
70
+
71
+
Add the name of your add-on in the file {file}`backend/pyproject.toml` in the section `dependencies`.
72
+
This example adds [`collective.easyform`](https://pypi.org/project/collective.easyform/).
73
+
74
+
```{code-block} toml
75
+
:emphasize-lines: 6
76
+
dependencies = [
77
+
"Products.CMFPlone==6.1.1",
78
+
"plone.api",
79
+
"plone.classicui",
80
+
"plone.app.caching",
81
+
"collective.easyform==4.4.0",
82
+
]
83
+
```
84
+
85
+
```{tip}
86
+
Including the add-on version, or "pinning a version", ensures that it won't unintentionally get upgraded in the future.
87
+
```
88
+
89
+
Also add the add-on to `zcml_package_includes` in the file {file}`backend/instance.yaml` to make sure its configuration will be loaded.
To actually download and install the new add-on, run the following command.
99
+
100
+
```shell
101
+
make backend-build
102
+
```
103
+
104
+
````
105
+
68
106
````{tab-item} Buildout
69
107
70
108
Update the file {file}`buildout.cfg`.
@@ -126,7 +164,8 @@ An unreleased add-on can be installed from a source control system such as GitHu
126
164
For instructions to install an add-on that is released on {term}`PyPI`, select the tab below according to your Python package manager.
127
165
128
166
```{tip}
129
-
Select the tab for uv if you have a project that was created using Cookieplone.
167
+
Select the tab for uv if you have a project that was created using Cookieplone, and you have `managed = true` set in the `[tool.uv]` section of the file {file}`backend/pyproject.toml`.
168
+
Select the tab for pip if you have a project that was created using Cookieplone that does not have this setting.
130
169
```
131
170
132
171
`````{tab-set}
@@ -162,6 +201,58 @@ default_context:
162
201
Stop the backend with {kbd}`ctrl-c`.
163
202
````
164
203
204
+
````{tab-item} pip
205
+
206
+
Add the name of your add-on in the file {file}`backend/pyproject.toml` in the section `dependencies`.
207
+
This example adds [`collective.easyform`](https://pypi.org/project/collective.easyform/).
208
+
209
+
```{code-block} toml
210
+
:emphasize-lines: 6
211
+
dependencies = [
212
+
"Products.CMFPlone==6.1.1",
213
+
"plone.api",
214
+
"plone.classicui",
215
+
"plone.app.caching",
216
+
"collective.easyform",
217
+
]
218
+
```
219
+
220
+
```{note}
221
+
When installing an add-on from source, it's best not to pin a version.
222
+
This way you always get the version that's currently available in the source control system.
223
+
```
224
+
225
+
Next add the add-on to `zcml_package_includes` in the file {file}`backend/instance.yaml` so that its configuration will load.
Copy file name to clipboardExpand all lines: docs/admin-guide/override-core.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,8 +19,8 @@ Sometimes you will need to override one or more package versions to fix a bug.
19
19
For instructions of how to override a core Plone package, select the tab below according to your Python package manager.
20
20
21
21
```{tip}
22
-
Select the tab for uv if you have a project that was created using Cookieplone after March 19, 2026.
23
-
Select the tab for pip if you have a project that was created using Cookieplone earlier.
22
+
Select the tab for uv if you have a project that was created using Cookieplone, and you have `managed = true` set in the `[tool.uv]` section of the file {file}`backend/pyproject.toml`.
23
+
Select the tab for pip if you have a project that was created using Cookieplone that does not have this setting.
24
24
```
25
25
26
26
`````{tab-set}
@@ -136,8 +136,8 @@ A core Plone package can be installed from a source control system such as GitHu
136
136
For instructions, select the tab below according to your Python package manager.
137
137
138
138
```{tip}
139
-
Select the tab for uv if you have a project that was created using Cookieplone after March 19, 2026.
140
-
Select the tab for pip if you have a project that was created using Cookieplone earlier.
139
+
Select the tab for uv if you have a project that was created using Cookieplone, and you have `managed = true` set in the `[tool.uv]` section of the file {file}`backend/pyproject.toml`.
140
+
Select the tab for pip if you have a project that was created using Cookieplone that does not have this setting.
0 commit comments