Skip to content

Commit

Permalink
Update docs to use command
Browse files Browse the repository at this point in the history
  • Loading branch information
davisagli committed Nov 26, 2024
1 parent e3037c5 commit 72a2c08
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions backend_addon/{{ cookiecutter.__folder_name }}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Install {{ cookiecutter.python_package_name }} with `pip`:
```shell
pip install {{ cookiecutter.python_package_name }}
```

And to create the Plone site:

```shell
Expand All @@ -24,32 +25,29 @@ make create_site
This package provides markers as strings (`<!-- extra stuff goes here -->`) that are compatible with [`plonecli`](https://github.com/plone/plonecli) and [`bobtemplates.plone`](https://github.com/plone/bobtemplates.plone).
These markers act as hooks to add all kinds of subtemplates, including behaviors, control panels, upgrade steps, or other subtemplates from `plonecli`.

To use them, you need to use `bobtemplates.plone` version 6.3.4 or later, and run the following command.
To run `plonecli` with configuration to target this package, run the following command.

```shell
plonecli add -b .mrbob.ini content_type
make add <template_name>
```

The command passes the `.mrbob.ini` configuration file to `plonecli` to set some configuration variables which are needed to properly run the subtemplates.

For example, you can add a behavior to your package with the following command.
For example, you can add a content type to your package with the following command.

```shell
plonecli add -b .mrbob.ini behavior
make add content_type
```

You can add a control panel with the following command.
You can add a behavior with the following command.

```shell
plonecli add -b .mrbob.ini controlpanel
make add behavior
```

```{seealso}
You can check the list of available subtemplates in the [`bobtemplates.plone` `README.md` file](https://github.com/plone/bobtemplates.plone/?tab=readme-ov-file#provided-subtemplates).
See also the documentation of [Mockup and Patternslib](https://6.docs.plone.org/classic-ui/mockup.html) for how to build the UI toolkit for Classic UI.
```


## Contribute

- [Issue Tracker](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.python_package_name }}/issues)
Expand Down

0 comments on commit 72a2c08

Please sign in to comment.