Skip to content
Open
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
091a89a
Add Create a backend add-on section in the Developer guide.
stevepiercy Nov 6, 2024
a766f5a
- Update meta information
stevepiercy Nov 6, 2024
d8e135c
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy Nov 6, 2024
ed9c4af
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy Nov 8, 2024
13b85f7
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy Nov 18, 2024
0f7a455
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy Nov 19, 2024
7767c8b
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy Dec 5, 2024
9d9994f
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy Feb 9, 2025
3119199
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy Feb 26, 2025
dcc8b32
Merge branch '6.0' into dev-guide-create-a-backend-add-on
petschki Nov 25, 2025
67b1ee7
create backend addon documentation
petschki Nov 25, 2025
0cad2b0
create genericsetup documentation
petschki Nov 25, 2025
042ff32
remove note
petschki Nov 25, 2025
aad7b71
Use file markup
stevepiercy Nov 26, 2025
df7340f
Revert changes in i18n and glossary to keep PR focused on GenericSetup
stevepiercy Nov 27, 2025
6af80fc
Revert changes in i18n and glossary to keep PR focused on GenericSetup
stevepiercy Nov 27, 2025
8579a16
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy Dec 1, 2025
2675e11
Update docs/developer-guide/create-a-backend-add-on.md
petschki Dec 1, 2025
6e92377
remove plonecli addon creation and note for monorepo "make" command
petschki Dec 1, 2025
0a4cace
only mention "make" command for "cookieplone" generated addons
petschki Dec 1, 2025
132f1be
Update docs/developer-guide/create-a-backend-add-on.md
petschki Dec 9, 2025
2fe88be
Merge branch '6.0' into dev-guide-create-a-backend-add-on
MrTango Jan 14, 2026
bb795bc
explain how to create a backend-addon with plonecli only.
petschki Jan 15, 2026
3db83f5
minor command fix
petschki Jan 15, 2026
a7b0d43
Merge branch '6.0' into dev-guide-create-a-backend-add-on
stevepiercy Feb 9, 2026
096109d
Begin editorial clean up
stevepiercy Feb 9, 2026
a0358f1
Merge branch '6.0' into dev-guide-create-a-backend-add-on
petschki Feb 20, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Begin editorial clean up
  • Loading branch information
stevepiercy committed Feb 9, 2026
commit 096109df61858c5a27d9170e1bcf60140923326f
23 changes: 9 additions & 14 deletions docs/backend/generic-setup.md
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I just skimmed through to check that this is still accurate/relevant information. It is and we should prioritize getting this merged. It does need some editing to match current doc styles.

Original file line number Diff line number Diff line change
Expand Up @@ -19,25 +19,20 @@ It provides XML-based rules to change the site settings.
remove archetypes example code everywhere
```

GenericSetup is mainly used to prepare the Plone site for add-on packages, by:

## Introduction

GenericSetup is an XML-based way to import and export Plone site configurations.

It is mainly used to prepare the Plone site for add-on packages, by:

- registering Registry entries (resources, configuration, etc)
- setting various properties,
- registering portlets,
- registering portal_catalog search query indexes,
- providing upgrade steps for addon version upgrades
- ... etc ...
- registering Registry entries, such as resources and configuration
- setting various properties
- registering portlets
- registering portal_catalog search query indexes
- providing upgrade steps for addon version upgrades
- and other preparations

GenericSetup is mostly used to apply an add-on's specific changes to the site configuration and to enable specific behaviors when the add-on installer is run.

GenericSetup XML files are usually in a `profiles/default` folder inside the add-on package.
GenericSetup XML files are usually in a {file}`profiles/default` folder inside the add-on package.

All run-time through-the-web ({term}`TTW`) configurable items (for example viewlets order through `/@@manage-viewlets` page) are made repeatable using GenericSetup profile files.
All run-time through-the-web ({term}`TTW`) configurable itemsfor example, viewlet order through the `/@@manage-viewlets` pageare made repeatable using GenericSetup profile files.

You can always change the configuration options through Plone or using the Management Interface, and then you export the resulting profile as an XML file, using the *Export* tab in `portal_setup` accessible from the Management Interface.

Expand Down
Loading