Skip to content

Commit b807cae

Browse files
pbauerpbauer
committed
re-add the output of a classicui project
1 parent d2f19d4 commit b807cae

1 file changed

Lines changed: 147 additions & 21 deletions

File tree

‎docs/install/create-project-cookieplone.md‎

Lines changed: 147 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ Node.js is required only for Volto projects and not for Classic UI projects.
120120

121121
(create-project-cookieplone-create-volto-project-label)=
122122

123-
## Create a Plone project
123+
## Create a Volto project
124124

125-
After satisfying the prerequisites, generate a Plone project.
125+
After satisfying the prerequisites and having {ref}`activated an LTS version of Node.js <prerequisites-for-installation-nodejs-label>`, generate a Volto project.
126126

127127
```shell
128128
uvx cookieplone project
@@ -133,8 +133,6 @@ You can accept the default values in square brackets (`[default-option]`) by hit
133133

134134
For ease of documentation, we will use the default values and thus create a project using the Volto frontend.
135135

136-
To create a project using the ClassicUI frontend instead answer `No` when asked `Use Volto as frontend (Yes/no)`.
137-
138136
```{tip}
139137
See Cookieplone's README for how to [Use options to avoid prompts](https://github.com/plone/cookieplone/?tab=readme-ov-file#use-options-to-avoid-prompts).
140138
```
@@ -175,18 +173,9 @@ Note that pip normalizes these names, so `plone.volto` and `plone-volto` are the
175173
[7/20] Python Package Name (project.title):
176174
[8/20] Should we use prerelease versions? (yes/No):
177175
[9/20] Plone Version (6.2.0):
178-
```
179-
The next questions will determine if you will create a Volto or ClassicUI project.
180-
```
181176
[10/20] Use Volto as frontend (Yes/no):
182-
```
183-
These two questions are only asked if you choose to create a project using Volto:
184-
```
185177
[11/20] Volto Version (19.1.0):
186178
[12/20] Volto Addon Name (volto-project-title):
187-
```
188-
For the remaining questions again we choose the default answer.
189-
```
190179
[13/20] Language
191180
1 - English
192181
2 - Deutsch
@@ -278,9 +267,9 @@ Proceed? [Y/n]:
278267
```
279268

280269

281-
### Install the project
270+
### Install the Volto project
282271

283-
To work on your project, you need to install both the backend and frontend.
272+
To work on your Volto project, you need to install both the Plone backend and frontend.
284273

285274
Change your current working directory to {file}`project-title`.
286275

@@ -304,7 +293,7 @@ When the process completes successfully, it will exit with no message.
304293
```
305294

306295

307-
### Start Plone backend and Volto frontend
296+
### Start Plone
308297

309298
Plone with Volto for its frontend has two servers: one each for the backend and frontend.
310299
As such, we need to maintain two active shell sessions, one for each server, to start your Plone site.
@@ -333,17 +322,17 @@ Starting server in PID 93865.
333322
```
334323

335324

336-
#### Start Volto frontend
325+
#### Start Plone frontend
337326

338327
Create a second shell session in a new window.
339328
Change your current working directory to {file}`project-title`.
340-
Start the Volto frontend with the following command.
329+
Start the Plone frontend with the following command.
341330

342331
```shell
343332
make frontend-start
344333
```
345334

346-
The Volto frontend server starts up and emits messages to the console, and should end with output similar to the following.
335+
The Plone frontend server starts up and emits messages to the console, and should end with output similar to the following.
347336

348337
```console
349338
webpack 5.90.1 compiled successfully in 14898 ms
@@ -393,9 +382,146 @@ To create a ClassicUI project run the same command as in the section {ref}`creat
393382
uvx cookieplone project
394383
```
395384

396-
Only when asked `Use Volto as frontend (Yes/no)` you answer `No`!
385+
You will be presented with a series of prompts.
386+
You can accept the default values in square brackets (`[default-option]`) by hitting the {kbd}`Enter` key, or enter your preferred values.
387+
388+
```{tip}
389+
See Cookieplone's README for how to [Use options to avoid prompts](https://github.com/plone/cookieplone/?tab=readme-ov-file#use-options-to-avoid-prompts).
390+
```
391+
392+
```{important}
393+
For {guilabel}`Project Slug`, you must not use any of the Plone core package names listed in [`constraints.txt`](https://dist.plone.org/release/6-latest/constraints.txt).
394+
Note that pip normalizes these names, so `my.project` and `my-project` are the same package.
395+
```
396+
397+
We accept the default values, except when asked `Use Volto as frontend (Yes/no)` we answer `No`!
398+
399+
```console
400+
╭──────────────────────────── cookieplone (2.0.0a3) ─────────────────────────────╮
401+
│ │
402+
│ ******* │
403+
│ *************** │
404+
│ *** *** │
405+
│ *** *** *** │
406+
│ *** ***** *** │
407+
│ *** *** *** │
408+
│ *** *** *** │
409+
│ *** ***** *** │
410+
│ *** *** *** *** │
411+
│ *** ***** *** │
412+
│ *** *** *** │
413+
│ *** *** │
414+
│ *************** │
415+
│ ******* │
416+
│ │
417+
╰───────────────────── Made with ❤️ by the Plone Community ──────────────────────╯
418+
```
419+
420+
```
421+
[1/18] Project Title (Project Title)
422+
[2/18] Project Description (A new project using Plone 6.):
423+
[3/18] Project Slug (Used for repository id) (project-title):
424+
[4/18] Project URL (without protocol) (project-title.example.com):
425+
[5/18] Author (Plone Foundation):
426+
[6/18] Author E-mail (collective@plone.org):
427+
[7/18] Python Package Name (project.title):
428+
[8/18] Should we use prerelease versions? (yes/No):
429+
[9/18] Plone Version (6.2.0):
430+
```
431+
432+
To the question `Use Volto as frontend` you need to answer `No` to create a ClassicUI project!
433+
434+
```
435+
[10/18] Use Volto as frontend (Yes/no): No
436+
[11/18] Language
437+
1 - English
438+
2 - Deutsch
439+
3 - Español
440+
4 - Português (Brasil)
441+
5 - Nederlands
442+
6 - Suomi
443+
7 - Italiano
444+
8 - Svenska
445+
Choose from [1/2/3/4/5/6/7/8] (1):
446+
[12/18] GitHub or GitLab username or organization slug from URL (collective):
447+
[13/18] Container Registry
448+
1 - GitHub Container Registry
449+
2 - Docker Hub
450+
3 - GitLab
451+
Choose from [1/2/3] (1):
452+
[14/18] Which persistent storage to use in the deployment stack?
453+
1 - RelStorage with PostgreSQL (recommended)
454+
2 - ZEO with FileStorage
455+
3 - Local FileStorage, implies a single backend
456+
Choose from [1/2/3] (1):
457+
[15/18] Should we setup a caching server? (Yes/no)
458+
[16/18] Add Ansible playbooks? (Yes/no)
459+
[17/18] Add GitHub Action to Deploy this project? (Yes/no)
460+
[18/18] Would you like to add a documentation scaffold to your project? (Yes/no)
461+
462+
╭─ Review your answers ──────────────────────────────────────────────────────────╮
463+
│ │
464+
│ Container Registry GitHub Container Registry │
465+
│ Should we use prerelease versions? No │
466+
│ Language English │
467+
│ Python Package Name project.title │
468+
│ Which persistent storage to use in RelStorage with PostgreSQL │
469+
│ the deployment stack? (recommended) │
470+
│ Author E-mail <your@email> │
471+
│ GitHub or GitLab username or collective │
472+
│ organization slug from URL │
473+
│ Project Title Project Title │
474+
│ Use Volto as frontend? No │
475+
│ Add Ansible playbooks? Yes │
476+
│ Author <Your Name> │
477+
│ Should we setup a caching server? Yes │
478+
│ Plone Version 6.2.0 │
479+
│ Project Description A new project using Plone 6. │
480+
│ Project URL (without protocol) project-title.example.com │
481+
│ Project Slug (Used for repository project-title │
482+
│ id) │
483+
│ Add GitHub Action to Deploy this Yes │
484+
│ project? │
485+
│ Would you like to add a Yes │
486+
│ documentation scaffold to your │
487+
│ project? │
488+
│ │
489+
╰────────────────────────────────────────────────────────────────────────────────╯
490+
Proceed? [Y/n]:
491+
492+
-> Setup Backend
493+
-> Ignoring (Setup Frontend)
494+
-> Generate documentation scaffold
495+
-> Setup Cache
496+
-> Setup Project Settings
497+
-> Setup VSCode configuration
498+
-> Setup GitHub CI
499+
-> Ignoring (Remove unneeded documentation files)
500+
-> Ignoring (Remove unneeded cache files)
501+
-> Ignoring (Remove unneeded deploy files)
502+
-> Remove frontend files for Classic UI
503+
-> Backend final cleanup
504+
-> Format backend code
505+
-> Ignoring (Format frontend code)
506+
-> Ignoring (Remove Ansible files)
507+
-> Ignoring (Remove GitHub Actions deployment files)
508+
-> Organize documentation files
509+
-> Ignoring (Remove unneeded documentation files)
510+
-> Initialize Git repository
511+
╭─────────────────────────── New project was generated ───────────────────────────╮
512+
│ │
513+
│ Project Title │
514+
│ │
515+
│ Now, code it, create a git repository, push to your organization. │
516+
│ │
517+
│ Sorry for the convenience, │
518+
│ The Plone Community. │
519+
│ │
520+
│ https://plone.org/ │
521+
╰─────────────────────────────────────────────────────────────────────────────────╯
522+
```
397523

398-
### Install the project
524+
### Install the Classic UI project
399525

400526
To work on your project, you need to install it.
401527

0 commit comments

Comments
 (0)