Skip to content

Commit e27ace1

Browse files
committed
Add Cookiecutter to pre-requisites, and sort list.
Move Cookiecutter installation into pre-requisites and update to use user's Python. Remove creation of a virtual environment, as that is handled by the cookiecutter. Update cookiecutter command with correct feature branch. Update console output.
1 parent f7f594f commit e27ace1

File tree

1 file changed

+19
-23
lines changed

1 file changed

+19
-23
lines changed

docs/install/install-from-packages.md

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,9 @@ You may host multiple Plone sites on the same server.
3838
### Pre-requisites for installation
3939

4040
- Python 3.8, 3.9, or 3.10.
41-
- nvm
41+
- Cookiecutter
4242
- Node.JS
43+
- nvm
4344
- Yarn
4445
- ```{todo}
4546
List any system libraries, such as `make`, `Xcode`, and so on.
@@ -48,6 +49,12 @@ You may host multiple Plone sites on the same server.
4849
Installing Python is beyond the scope of this documentation.
4950
However, it is recommended to use a Python version manager, [`pyenv`](https://github.com/pyenv/pyenv) that allows you to install multiple versions of Python on your development environment without destroying your system's Python.
5051
52+
Install or upgrade {term}`Cookiecutter` in your user's Python:
53+
54+
```shell
55+
pip install --user --upgrade cookiecutter
56+
```
57+
5158
{ref}`Install nvm and Node.js documentation <frontend-getting-started-install-nvm-label>`.
5259

5360
{ref}`Install Yarn documentation <frontend-getting-started-yarn-label>`.
@@ -72,29 +79,18 @@ mkdir my_project
7279
cd my_project
7380
```
7481

75-
Issue the following commands in a shell session to create a Python virtual environment in the current directory.
76-
77-
```shell
78-
python -m venv venv
79-
source venv/bin/activate
80-
```
82+
Run `cookiecutter` to create a Plone project skeleton using the cookiecutter {term}`cookiecutter-plone-starter` with the following command.
8183

82-
Upgrade Python package management tools.
84+
````{todo}
85+
When the feature branch is merged, the following command should be replaced with:
8386
84-
```shell
85-
pip install --upgrade pip wheel
8687
```
87-
88-
Install {term}`Cookiecutter`:
89-
90-
```shell
91-
pip install cookiecutter
88+
cookiecutter https://github.com/collective/cookiecutter-plone-starter/
9289
```
93-
94-
You can now run `cookiecutter` to create a Plone project skeleton using the cookiecutter {term}`cookiecutter-plone-starter` with the following command.
90+
````
9591

9692
```shell
97-
cookiecutter https://github.com/collective/cookiecutter-plone-starter/
93+
cookiecutter https://github.com/collective/cookiecutter-plone-starter.git --checkout feature-4
9894
```
9995

10096
You will be presented with a series of prompts.
@@ -111,7 +107,7 @@ author [Plone Foundation]:
111107
112108
python_package_name [project_title]:
113109
plone_version [6.0.0b2]:
114-
volto_version [16.0.0-alpha.34]:
110+
volto_version [16.0.0-alpha.35]:
115111
Select language_code:
116112
1 - en
117113
2 - de
@@ -129,18 +125,18 @@ Project Title generation
129125
Running sanity checks
130126
- Python: ✓
131127
- Node: ✓
132-
- yo: Yeoman not found.
128+
- yo:
133129
- Docker: ✓
134130
- git: ✓
135131

136132
Summary:
137133
- Plone version: 6.0.0b2
138-
- Volto version: 16.0.0-alpha.34
139-
- Output folder: /path-to/my_project/project-title
134+
- Volto version: 16.0.0-alpha.35
135+
- Output folder: /Users/stevepiercy/projects/Plone/documentation/ainstall/project-title
140136

141137
Frontend codebase:
142138
- Install latest @plone/generator-volto
143-
- Generate frontend application with @plone/volto 16.0.0-alpha.34
139+
- Generate frontend application with @plone/volto 16.0.0-alpha.35
144140

145141
Backend codebase
146142
- Format generated code in the backend

0 commit comments

Comments
 (0)