Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Adds docs for creating custom control panel #1909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rohnsha0 wants to merge 20 commits into 6.0
base: 6.0
Choose a base branch
Loading
from rohnsha0-control-panel

Conversation

@rohnsha0
Copy link
Member

@rohnsha0 rohnsha0 commented Mar 14, 2025 •
edited by stevepiercy
Loading

Copy link

boring-cyborg bot commented Mar 14, 2025

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, read Plone's Code of Conduct and Contribute to documentation, as this will greatly help the review process.

Welcome to the Plone community! 🎉

 

- Sentence case headings
- Add content to empty headings
- Use appropriate list type, either bulleted or definition
- Indent lists 4 spaces for consistency and visually spotting syntax issues
- Use `{file}` markup for files, directories, and file paths
- Emphasize lines in code block as needed
Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I completed my review by making thoroughly commented commits.

I have a couple of questions for clarification.

This also needs a technical peer review before getting merged.

Thank you for pulling all the pieces together. This is awesome.

Copy link
Contributor

@plone/classicui-team can I get a review from y'all? This will establish the basis for both Classic UI and Volto.

Copy link
Contributor

@sneridagh I couldn't find an example of how to create a control panel in Volto. Does a clear how to guide exist anywhere?

We should include that in this page, or if it exists, add a link to that resource.
jensens reacted with thumbs up emoji rohnsha0 reacted with eyes emoji

Copy link
Member Author

@sneridagh I couldn't find an example of how to create a control panel in Volto. Does a clear how to guide exist anywhere?

-> https://training.plone.org/mastering-plone/registry.html#add-a-custom-control-panel
@stevepiercy the above link is for addon, but it works the same way for other use cases too!

Copy link
Contributor

@rohnsha0 would you please adapt and add that content to this PR? Then developers can go to a single page to add a control panel, regardless of frontend. FTW!

Copy link
Contributor

@rohnsha0 I chatted with @sneridagh about this PR, and he said that as long as the control panel uses the basic HTML5 form controls, then they can be mapped to mapped to those in the Storybook. If the control panel does complex things, such as XHR or tabbed interfaces, then that would require significant effort.

Copy link
Member Author

@rohnsha0 I chatted with @sneridagh about this PR, and he said that as long as the control panel uses the basic HTML5 form controls, then they can be mapped to mapped to those in the Storybook. If the control panel does complex things, such as XHR or tabbed interfaces, then that would require significant effort.

Is this something for Volto. Right?

Copy link
Contributor

@rohnsha0 yes.

Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few changes based on response.

```


## Use `FieldSet` to group fields
Copy link
Contributor

@stevepiercy stevepiercy Apr 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this also part of the manual process only or both manual and plonecli?

Copy link
Member Author

@rohnsha0 rohnsha0 Apr 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stevepiercy this needs to be added in any way you use to create the controlpanel, as these include the fields (to be grouped) that needs to be shown in the settings (of the controlpanel)

Copy link
Contributor

@stevepiercy stevepiercy Apr 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, please see other comments regarding the flow and structure of this chapter. I think we're close to finished with those enhancements.

rohnsha0 reacted with eyes emoji
Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rohnsha0 note that the page contents contains six subheadings, but the manual process introduction contains only four items.

Screenshot 2025年04月06日 at 12 43 21 PM

Screenshot 2025年04月06日 at 12 44 28 PM

In the current structure, it appears that they are part of the manual process only, but were omitted from the list of items in its introduction.

But you are saying that they apply for both the plonecli and manual processes. As such the last two items should have one fewer # to appear at the correct level.

If that is correct, then I would also insert a statement that transitions the reader, and add that to the main introduction as well. I'll add other suggestions in another round of review.

```


## Use `FieldSet` to group fields
Copy link
Contributor

@stevepiercy stevepiercy Apr 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, please see other comments regarding the flow and structure of this chapter. I think we're close to finished with those enhancements.

rohnsha0 reacted with eyes emoji
Copy link
Contributor

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These comments remain unresolved and need to be addressed before merging. The content is good and ready, but its flow between sections could use some improvement. Thank you!

Copy link
Member Author

@rohnsha0 note that the page contents contains six subheadings, but the manual process introduction contains only four items.

Screenshot 2025年04月06日 at 12 43 21 PM

Screenshot 2025年04月06日 at 12 44 28 PM

In the current structure, it appears that they are part of the manual process only, but were omitted from the list of items in its introduction.

* [Access your settings in code](https://plone6--1909.org.readthedocs.build/developer-guide/create-control-panel.html#access-your-settings-in-code)
* [Register a control panel](https://plone6--1909.org.readthedocs.build/developer-guide/create-control-panel.html#register-a-control-panel)

But you are saying that they apply for both the plonecli and manual processes. As such the last two items should have one fewer # to appear at the correct level.

If that is correct, then I would also insert a statement that transitions the reader, and add that to the main introduction as well. I'll add other suggestions in another round of review.

@stevepiercy the registering part is solely for manual procedure as the plonecli already register the configs. However, accessing the code part can be pulled out of the manual process. and ig one # can be removed

Copy link
Member Author

@stevepiercy ig now the flow of the article looks much better

Copy link
Contributor

MrTango commented Apr 18, 2025

I have the feeling this went i bit in the wrong direction.
I'll have a more detailed look into it, but for now, just a view points.
As far as i know, the control panel created by plonecli should work out of the box in Volto.
This is the case for all simple control panels, where the fields are defined in the zope.schema and the default is used. If there is more customization involved like custom templates in classic UI, that's not out of the box, in Volto. But this should not be part of the docs here. Maybe in an advanced chapter, for classic ui and Volto, separately.

Also we have to careful not to duplicate the schema relevant parts here. This is all forms related and forms, schema and fields have there own chapter with details.

@MrTango MrTango self-requested a review April 18, 2025 14:44
Copy link
Member Author

@MrTango please also see #1939

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stevepiercy stevepiercy stevepiercy requested changes

@sneridagh sneridagh Awaiting requested review from sneridagh

@mauritsvanrees mauritsvanrees Awaiting requested review from mauritsvanrees

@MrTango MrTango Awaiting requested review from MrTango

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

Status: In Progress

Milestone

Plone 6.1

Development

Successfully merging this pull request may close these issues.

How to create a control panel in Plone Create Control Panel needs content

AltStyle によって変換されたページ (->オリジナル) /