Skip to content

Commit 7aed317

Browse files
committed
Revise Add an add-on section, referring to default mxdev files, modifying them, and make narrative text more generic for any add-on
1 parent 5dbc2a9 commit 7aed317

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

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

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -164,21 +164,28 @@ We will also use Classic UI for the interface because some packages and add-ons
164164

165165
### Add an add-on
166166

167-
Add a line with the name of your add-on to `requirements.txt`
167+
Add a line with the name of your add-on in `requirements.txt`.
168+
This example uses [`collective.easyform`](https://pypi.org/project/collective.easyform/).
168169

169170
```
170171
collective.easyform
171172
```
172173

173174
Add it to {file}`instance.yml` to let Zope know that this add-on should be loaded:
174175

175-
```yaml
176+
```{code-block} yaml
177+
:emphasize-lines: 3-6
176178
default_context:
177-
load_zcml:
178-
package_includes: ['collective.easyform']
179+
load_zcml:
180+
package_includes: [
181+
'project_title',
182+
'collective.easyform',
183+
]
179184
```
180185

181-
Apply your changes and restart backend:
186+
Stop the backend with {kbd}`ctrl-c`.
187+
Then apply your changes and start the backend.
188+
You do not need to stop the frontend.
182189

183190
```shell
184191
make build-backend
@@ -187,12 +194,11 @@ make start-backend
187194

188195
In your web browser, and assuming you are currently logged in as `admin`, visit the URL http://localhost:8080/Plone/prefs_install_products_form.
189196

190-
Then click the {guilabel}`Install` button to complete installation of `collective.easyform`.
191-
192-
Return to the {guilabel}`Site Setup` control panel.
193-
At the bottom of the page, you should see the heading {guilabel}`Add-on Configuration`, and a panel {guilabel}`easyform` to configure the add-on that we just installed.
197+
Then click the {guilabel}`Install` button next to your add-on to complete installation of the add-on.
194198

195-
While visiting the home page, you can add a new `easyform` object.
199+
Some add-ons have configuration options.
200+
To configure such add-ons, return to the {guilabel}`Site Setup` control panel.
201+
At the bottom of the page, you should see the heading {guilabel}`Add-on Configuration`, and a control panel to configure the add-on that you just installed.
196202

197203

198204
(manage-backend-pin-the-version-of-an-add-on)=

0 commit comments

Comments
 (0)