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

Add howto add a dependency to README.md #54

Merged
merged 8 commits into from
Mar 8, 2024
Merged
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,47 @@ The configuration for a new Volto site is:
}
```

#### How to add an add-on

If you want to add a Plone backend add-on to your Plone distribution, then you must perform the following steps.

Add your add-on, such as `collective.person`, to your `setup.py`:

```python
install_requires=[
"setuptools",
"Plone",
"plone.distribution>=1.0.0b2",
"plone.api",
"collective.person",
],
```

Add it to your `dependencies.zcml`:

```xml
<!-- List all packages you depend here -->
<include package="plone.volto" />
<include package="plone.restapi" />
<include package="collective.person" />
<include package="plone.distribution" />

</configure>
```

Add it to your `profiles.json`:

```json
"base": [
"plone.app.contenttypes:default",
"plone.app.caching:default",
"plone.restapi:default",
"plone.volto:default",
"collective.person:default",
"plonetheme.barceloneta:default"
],
```

### `schema.json`

In case you require additional input from the user during site creation, you can customize the form using the `schema.json` file.
Expand Down