Skip to content

Commit 6e92377

Browse files
committed
remove plonecli addon creation and note for monorepo "make" command
1 parent 2675e11 commit 6e92377

File tree

1 file changed

+4
-74
lines changed

1 file changed

+4
-74
lines changed

docs/developer-guide/create-a-backend-add-on.md

Lines changed: 4 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -99,80 +99,6 @@ Cookieplone creates a folder with the name of the add-on, in this example, `coll
9999
You can now continue to add subtemplates to your addon {ref}`create-a-backend-add-on-add-subtemplate-label`
100100

101101

102-
## Generate the add-on project with `plonecli`
103-
104-
Run the following command to create an addon project with `plonecli`
105-
106-
```shell
107-
uvx plonecli create addon <addon namespace package>
108-
```
109-
110-
```console
111-
> uvx plonecli create addon collective.addon
112-
RUN: bobtemplates.plone:addon -O collective.addon
113-
114-
Welcome to mr.bob interactive mode. Before we generate directory structure,
115-
some questions need to be answered.
116-
117-
Answer with a question mark to display help.
118-
Values in square brackets at the end of the questions show the default value if
119-
there is no answer.
120-
121-
122-
--> Package description [An add-on for Plone]:
123-
124-
--> Plone version [6.0.0]:
125-
126-
--> Python version for virtualenv [python3]:
127-
128-
--> Do you want me to activate VS Code support? (y/n) [y]:
129-
130-
131-
132-
isort-apply: successful:
133-
isort-apply: install_deps> python -I -m pip install isort -c constraints.txt
134-
isort-apply: commands[0]> isort /Users/<username>/Development/collective.addon/src
135-
/Users/<username>/Development/collective.addon/setup.py
136-
Fixing /Users/<username>/Development/collective.addon/src/collective/addon/testing.py
137-
Fixing /Users/<username>/Development/collective.addon/src/collective/addon/tests/test_setup.py
138-
isort-apply: OK (2.57=setup[1.94]+cmd[0.63] seconds)
139-
congratulations :) (2.59 seconds)
140-
141-
142-
Identified `/` as project root containing a file system root.
143-
Sources to be formatted: "Users/<username>/Development/collective.addon/src",
144-
"Users/<username>/Development/collective.addon/setup.py"
145-
src/collective/__init__.py wasn't modified on disk since last run.
146-
src/collective/addon/browser/__init__.py wasn't modified on disk since last run.
147-
src/collective/addon/locales/__init__.py wasn't modified on disk since last run.
148-
src/collective/addon/tests/__init__.py wasn't modified on disk since last run.
149-
src/collective/addon/interfaces.py already well formatted, good job.
150-
reformatted src/collective/addon/__init__.py
151-
reformatted src/collective/addon/setuphandlers.py
152-
reformatted src/collective/addon/testing.py
153-
reformatted setup.py
154-
reformatted src/collective/addon/locales/update.py
155-
reformatted src/collective/addon/tests/test_setup.py
156-
157-
All done! ✨ 🍰 ✨
158-
6 files reformatted, 5 files left unchanged.
159-
160-
black-enforce: successful:
161-
black-enforce: install_deps> python -I -m pip install black -c constraints.txt
162-
black-enforce: commands[0]> black -v src setup.py
163-
black-enforce: OK (2.60=setup[2.12]+cmd[0.48] seconds)
164-
congratulations :) (2.61 seconds)
165-
166-
167-
git init is disabled!
168-
Generated file structure at /Users/<username>/Development/collective.addon/collective.addon
169-
```
170-
171-
Plonecli creates a folder with the name of the add-on, in this example, `collective.addon`.
172-
173-
You can now continue to add subtemplates to your addon {ref}`create-a-backend-add-on-add-subtemplate-label`
174-
175-
176102
(create-a-backend-add-on-add-subtemplate-label)=
177103

178104
## Add `plonecli` subtemplate to an addon
@@ -216,6 +142,10 @@ Available mr.bob templates:
216142
uvx plonecli add <subtemplate>
217143
```
218144

145+
```{note}
146+
When you have created a project with `cookieplone`, then you can simply do `make add <subtemplate>` inside the {file}`backend` folder.
147+
```
148+
219149
Currently documented subtemplates:
220150

221151
- behavior: {ref}`backend-behaviors-label`

0 commit comments

Comments
 (0)