Skip to content
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

Adds docs for creating custom control panel #1909

Open
wants to merge 10 commits into
base: 6.0
Choose a base branch
from

Conversation

rohnsha0
Copy link

@rohnsha0 rohnsha0 commented Mar 14, 2025

Fixes #4131
Fixes #1304
See #1882


📚 Documentation preview 📚: https://plone6--1909.org.readthedocs.build/

@rohnsha0 rohnsha0 requested a review from stevepiercy March 14, 2025 04:07
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! 🎉

@stevepiercy stevepiercy requested review from sneridagh, a team and mauritsvanrees March 14, 2025 22:19
- 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.

```


## Register a control panel
Copy link
Contributor

Choose a reason for hiding this comment

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

I got a little bit lost here. Does this heading apply to both the plonecli and manual options, or just the manual one?

  • If both, then we should add a sentence to clarify this.
  • If only the latter, then its heading level should increase.

Copy link
Contributor

Choose a reason for hiding this comment

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

Does the Plone site need to be restarted after adding all the files for the control panel to show up? If so, then that step also needs to be documented in the appropriate location.

@stevepiercy
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.

@stevepiercy stevepiercy mentioned this pull request Mar 15, 2025
40 tasks
@stevepiercy stevepiercy added this to the Plone 6.1 milestone Mar 15, 2025
@stevepiercy
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.

@rohnsha0
Copy link
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!

@stevepiercy
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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

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