Skip to content

Commit 36acb7c

Browse files
authored
Update create project with cookieplone documentation. (#1922)
* Update create project with cookieplone documentation. * Use tabs for installation methods * Fix installation method of uv
1 parent ad87d8f commit 36acb7c

File tree

3 files changed

+57
-36
lines changed

3 files changed

+57
-36
lines changed

docs/_inc/_install-uv.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Install {term}`uv` -- and {term}`uvx` -- on your local environment.
2+
3+
Carefully read the console output for further instructions, and follow them, if needed.
4+
5+
`````{tab-set}
6+
7+
````{tab-item} macOS, Linux and Windows with WSL2
8+
```shell
9+
curl -LsSf https://astral.sh/uv/install.sh | sh
10+
```
11+
````
12+
13+
````{tab-item} Windows
14+
```shell
15+
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
16+
```
17+
````
18+
`````
19+
20+
```{seealso}
21+
- [Other {term}`UV` installation methods](https://docs.astral.sh/uv/getting-started/installation/)
22+
```

docs/glossary.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,12 @@ pyenv
9999
Python version management.
100100
[pyenv](https://github.com/pyenv/pyenv) lets you easily switch between multiple versions of Python.
101101
102+
UV
103+
[UV](https://docs.astral.sh/uv/) is a Python package and project manager, written in Rust.
104+
105+
uvx
106+
`uvx` is a command implemented by [UV](https://docs.astral.sh/uv/) to execute and installs command-line tools provided by Python packages in an ephemeral environment, similar to {term}`pipx`
107+
102108
pm2
103109
[PM2](https://pm2.keymetrics.io/) is a daemon process manager.
104110
@@ -463,7 +469,7 @@ Slate
463469
`volto-slate` is an interactive default text editor for Volto, developed on top of {term}`Slate`, offering enhanced {term}`WYSIWYG` functionality and behavior.
464470
465471
WYSIWYG
466-
WYSIWYG is an acronym for "what you see is what you get", referring to software that allows content to be edited in a form that resembles its appearance when printed or displayed as a finished product.
472+
WYSIWYG is an acronym for "what you see is what you get", referring to software that allows content to be edited in a form that resembles its appearance when printed or displayed as a finished product.
467473
468474
TinyMCE
469475
The rich text {term}`WYSIWYG` editor used in {term}`Classic UI`.
@@ -563,7 +569,7 @@ ZODB
563569
[A native object database for Python](https://zodb.org/en/latest/).
564570
565571
`FileStorage`
566-
`FileStorage` is a Python class in {term}`ZODB` that saves data in a file.
572+
`FileStorage` is a Python class in {term}`ZODB` that saves data in a file.
567573
568574
```{seealso}
569575
https://zodb.org/en/latest/reference/storages.html#filestorage
@@ -868,7 +874,7 @@ schema enhancer
868874
variation
869875
A variation is a common development pattern that provides alternative views for the same data.
870876
For example, a teaser block can present data as `title + link`, `title + description + link`, or `title + image + link`.
871-
877+
872878
An advanced variation can enhance the block by adding data fields to the block.
873879
For example, a listing block variation can show news items with `title + link`.
874880
Extending this example, a developer can add a boolean field to the block that toggles the display of the link.
@@ -880,7 +886,7 @@ Higher-Order Component
880886
HOCs are not part of the React API, per se.
881887
They are a pattern that emerges from React's compositional nature.
882888
Concretely, a higher-order component is a function that takes a component and returns a new component.
883-
889+
884890
```{important}
885891
Higher-order components are not commonly used in modern React code.
886892
```

docs/install/create-project-cookieplone.md

Lines changed: 25 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -57,29 +57,22 @@ Plone 6 has both hardware requirements and software prerequisites.
5757
```{include} ../volto/_inc/_install-operating-system.md
5858
```
5959

60-
- Python {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}
61-
- {term}`pipx`
60+
- {term}`UV`
6261
- {term}`nvm`
6362
- {term}`Node.js` LTS 20.x
6463
- {term}`GNU make`
6564
- {term}`Git`
6665

6766

68-
#### Python
69-
70-
```{include} /_inc/_install-python-plone61.md
71-
```
67+
#### UV
7268

73-
```{warning}
74-
Python 3.9 will reach [end of life in October 2025](https://devguide.python.org/versions/).
75-
Do not create a new Plone project with Python 3.9.
69+
```{include} /_inc/_install-uv.md
7670
```
7771

7872

79-
#### pipx
73+
#### Python
8074

81-
```{include} /_inc/_install-pipx.md
82-
```
75+
{term}`UV` will download and install the required Python version for your project.
8376

8477

8578
#### nvm
@@ -168,58 +161,58 @@ Note that pip normalizes these names, so `plone.volto` and `plone-volto` are the
168161
│ .xxxxxxxxxxxxxx. │
169162
│ │
170163
╰─────────────────────────────────────────────────────────────────────────────╯
171-
You've downloaded /Users/stevepiercy/.cookiecutters/cookieplone-templates
172-
before. Is it okay to delete and re-download it? [y/n] (y):
164+
You've downloaded /Users/stevepiercy/.cookiecutters/cookieplone-templates
165+
before. Is it okay to delete and re-download it? [y/n] (y):
173166
╭─────────────────────────────── Plone Project ───────────────────────────────╮
174167
│ │
175168
│ Creating a new Plone Project │
176169
│ │
177170
│ Sanity check results: │
178171
│ │
179172
│ - Cookieplone: ✓ │
180-
│ - Python: ✓ │
173+
│ - UV: ✓
181174
│ - Node: ✓ │
182175
│ - git: ✓ │
183176
│ - Docker (optional): ✓ │
184177
│ │
185178
╰─────────────────────────────────────────────────────────────────────────────╯
186-
[1/17] Project Title (Project Title):
187-
[2/17] Project Description (A new project using Plone 6.):
188-
[3/17] Project Slug (Used for repository id) (project-title):
189-
[4/17] Project URL (without protocol) (project-title.example.com):
190-
[5/17] Author (Plone Foundation):
191-
[6/17] Author E-mail ([email protected]):
192-
[7/17] Should we use prerelease versions? (No):
193-
[8/17] Plone Version (6.1.0):
194-
[9/17] Volto Version (18.8.1):
195-
[10/17] Python Package Name (project.title):
196-
[11/17] Volto Addon Name (volto-project-title):
179+
[1/17] Project Title (Project Title):
180+
[2/17] Project Description (A new project using Plone 6.):
181+
[3/17] Project Slug (Used for repository id) (project-title):
182+
[4/17] Project URL (without protocol) (project-title.example.com):
183+
[5/17] Author (Plone Foundation):
184+
[6/17] Author E-mail ([email protected]):
185+
[7/17] Should we use prerelease versions? (No):
186+
[8/17] Plone Version (6.1.0):
187+
[9/17] Volto Version (18.8.1):
188+
[10/17] Python Package Name (project.title):
189+
[11/17] Volto Addon Name (volto-project-title):
197190
[12/17] Language
198191
1 - English
199192
2 - Deutsch
200193
3 - Español
201194
4 - Português (Brasil)
202195
5 - Nederlands
203196
6 - Suomi
204-
Choose from [1/2/3/4/5/6] (1):
205-
[13/17] GitHub or GitLab Username or Organization (collective):
197+
Choose from [1/2/3/4/5/6] (1):
198+
[13/17] GitHub or GitLab Username or Organization (collective):
206199
[14/17] Container Registry
207200
1 - GitHub Container Registry
208201
2 - Docker Hub
209202
3 - GitLab
210-
Choose from [1/2/3] (1):
203+
Choose from [1/2/3] (1):
211204
[15/17] Should we setup a caching server?
212205
1 - Yes
213206
2 - No
214-
Choose from [1/2] (1):
207+
Choose from [1/2] (1):
215208
[16/17] Add Ansible playbooks?
216209
1 - Yes
217210
2 - No
218-
Choose from [1/2] (1):
211+
Choose from [1/2] (1):
219212
[17/17] Add GitHub Action to Deploy this project?
220213
1 - Yes
221214
2 - No
222-
Choose from [1/2] (1):
215+
Choose from [1/2] (1):
223216
╭───────────────────────── Project Title generation ──────────────────────────╮
224217
│ │
225218
│ Summary: │

0 commit comments

Comments
 (0)