Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit c89c927

Browse files
committedApr 18, 2025··
Enhance documentation for creating control panels by adding notes on importing the Generic Profile and clarifying buildout steps.
1 parent 0b71881 commit c89c927

File tree

1 file changed

+32
-10
lines changed

1 file changed

+32
-10
lines changed
 

‎docs/developer-guide/create-control-panel.md

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ It also covers advanced topics—including how to group fields in your control p
2121

2222
## `plonecli`
2323

24+
> **Note**: This method only works when developing Plone add-ons. If you're working on a Plone project that is not an add-on, you'll need to follow the manual steps described in the next section.
25+
2426
Given you've already created a Plone add-on using one of the following methods.
2527

2628
- {doc}`/install/create-project-cookieplone`
@@ -225,17 +227,9 @@ To register the view as a control panel so that it appears in the {guilabel}`Sit
225227

226228
## Load your control panel
227229

228-
After performing the above steps, you must add them to your buildout configuration, run buildout, and restart the Plone site.
229-
230-
```{todo}
231-
Add a sample buildout configuration.
232-
```
230+
After performing the above steps, you must perform below mentioned steps as they are important to load the profile (including registry) to the project.
233231

234-
Run buildout with the `-N` option, so that it does not check for new versions of Python requirements.
235-
236-
```shell
237-
bin/buildout -N
238-
```
232+
### Restarting the instance
239233

240234
To stop a running Plone instance, press {kbd}`ctrl-c` in the terminal where Plone is running.
241235
To start it again, use the appropriate command based on your installation method.
@@ -278,6 +272,34 @@ make frontend-start
278272
279273
`````
280274

275+
### Importing the Generic Profile
276+
277+
​To apply your newly created control panel in a Plone project, you'll need to manually import the GenericSetup profile associated with your project. Here's how you can do this:​
278+
279+
#### Access the ZMI (Zope Management Interface)
280+
281+
Navigate to your Plone site's URL and append /manage to access the ZMI. For example:​
282+
283+
```bash
284+
http://localhost:8080/Plone/manage
285+
286+
```
287+
288+
#### Navigate to the Setup Tool
289+
290+
In the ZMI, locate and click on portal_setup.​
291+
292+
#### Import the Profile
293+
294+
- Within portal_setup, go to the Import tab.
295+
- From the Profile dropdown menu, select your project's profile. This is typically named in the format:​
296+
```
297+
profile-your.projectname:default
298+
```
299+
- Click the Import All Steps button to apply the profile.​
300+
301+
This process will register your control panel and any associated registry settings defined in your registry.xml and controlpanel.xml files.
302+
281303
Your control panel should now appear in {guilabel}`Site Setup`.
282304

283305

0 commit comments

Comments
 (0)
Please sign in to comment.