Skip to content

Commit 025f8b4

Browse files
authored
Clean up install with Cookieplone (#1929)
* Clean up install with Cookieplone - Rewrite introduction where Cookieplone is a tool, not a template - Move hardware to first subsection of requirements - Remove Python as a prerequisite, now that uv handles it - Move enumerated item 3 from pages into the Volto include for installing Node.js - Add a cross-reference to activation of LTS version of Node.js - Create a make command to toggle the symlink between Volto and Seven - Restore mistakenly removed include for Python and Plone 6.1 * Move `_inc/_install-uv.md` from `plone/documentation` to `plone/volto` and refactor * Fix cross-references * - Move hardware requirements from main documentation to volto
1 parent a11e2a2 commit 025f8b4

File tree

7 files changed

+38
-68
lines changed

7 files changed

+38
-68
lines changed

Makefile

+12
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,18 @@ docs/volto: ## Setup Volto docs
7373
@echo "Documentation of volto initialized."
7474
@echo
7575

76+
ln-seven: ## Toggle the symlink to Seven
77+
rm docs/volto
78+
ln -s ../submodules/volto/docs ./docs/volto
79+
@echo "Symlink to Volto changed to Seven."
80+
@echo
81+
82+
ln-volto: ## Toggle the symlink to Volto
83+
rm docs/volto
84+
ln -s ../submodules/volto/docs/source ./docs/volto
85+
@echo "Symlink to Seven changed to Volto."
86+
@echo
87+
7688
.PHONY: deps
7789
deps: venv/bin/python docs/volto docs/plone.restapi venv/plone.api-install ## Create Python virtual environment, install requirements, initialize or update the volto, plone.restapi, and plone.api submodules, create symlinks to the source files, and finally install plone.api.
7890

docs/_inc/_hardware-requirements.md

-19
This file was deleted.

docs/_inc/_install-python-plone61.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Installing Python is beyond the scope of this documentation.
2+
However, it is recommended to use a Python version manager, {term}`pyenv`, that allows you to install multiple versions of Python on your development environment without destroying your system's Python.
3+
4+
```{warning}
5+
Do not create or activate a Python virtual environment at this time.
6+
The instructions below will create one.
7+
```
8+
9+
Plone 6.1 requires Python version {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}.

docs/_inc/_install-uv.md

-21
This file was deleted.

docs/backend/subscribers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Here, the event handler code will only be executed if the object is a content ty
6060
If you want this to be interface agnostic, insert an asterix `*` as a wildcard instead.
6161

6262
The third line defines the event on which this should happen, which is `IObjectCreatedEvent`.
63-
For more available possible events to use as a trigger, see {ref}`subscribers-event-handlers`.
63+
For more available possible events to use as a trigger, see {ref}`subscribers-event-types-label`.
6464

6565
The fourth line gives the path to the callable function to be executed.
6666

docs/contributing/documentation/authors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ The Plone Documentation Team adopted additional guidelines.
371371
To make that work in Volto, set your browser width to 1180 pixels.
372372
You will notice that the drag and trash icons for each block move inside the block from outside.
373373

374-
If you create images wider than 740 pixels, then you must use image display enhancement as described in {ref}`enhance-images-label`.
374+
If you create images wider than 740 pixels, then you must use image display enhancement as described in {ref}`enhance-media-label`.
375375
- In user documentation, provide screenshots of each step where the interface changes.
376376
It is painstaking, but worth the effort.
377377
Provide sufficient detail of what each option is and does.

docs/install/create-project-cookieplone.md

+15-26
Original file line numberDiff line numberDiff line change
@@ -12,41 +12,40 @@ myst:
1212

1313
# Install Plone with Cookieplone
1414

15-
This chapter describes how you can create a web application using the {term}`Cookieplone` template.
16-
17-
This template is the recommended way to start a new Plone project using the Volto frontend.
15+
This chapter describes how you can create a web application using {term}`Cookieplone`.
16+
Cookieplone is the recommended way to create a Plone project as an add-on using the Volto frontend.
1817
It also includes tools for development and deployment.
1918

2019
```{seealso}
2120
For other installation options, see {ref}`get-started-install-label`.
2221
```
2322

2423
```{versionadded} Volto 18.0.0-alpha.43
25-
{term}`Cookieplone` was added as the recommended template to create a Plone project with Volto starting in Volto 18.0.0-alpha.43 and above.
24+
{term}`Cookieplone` was added as the recommended tool to create a Plone project with Volto starting in Volto 18.0.0-alpha.43 and above.
2625
```
2726

2827

2928
(create-project-cookieplone-system-requirements)=
3029

3130
## System requirements
3231

33-
Plone 6 has both hardware requirements and software prerequisites.
32+
Plone has both hardware requirements and software prerequisites.
3433

3534

36-
### Supported web browsers
35+
(create-project-cookieplone-hardware-requirements-label)=
3736

38-
```{include} /volto/_inc/_install-browser-reqs-volto.md
39-
```
37+
### Hardware requirements
4038

41-
```{include} /_inc/_install-browser-reqs-classic-ui.md
39+
```{include} /volto/_inc/_hardware-requirements.md
4240
```
4341

4442

45-
(create-project-cookieplone-hardware-requirements-label)=
43+
### Supported web browsers
4644

47-
### Hardware requirements
45+
```{include} /volto/_inc/_install-browser-reqs-volto.md
46+
```
4847

49-
```{include} /_inc/_hardware-requirements.md
48+
```{include} /_inc/_install-browser-reqs-classic-ui.md
5049
```
5150

5251

@@ -66,32 +65,23 @@ Plone 6 has both hardware requirements and software prerequisites.
6665

6766
#### uv
6867

69-
```{include} /_inc/_install-uv.md
68+
```{include} ../volto/_inc/_install-uv.md
7069
```
7170

7271

73-
#### Python
74-
75-
{term}`uv` will download and install the required Python version for your project.
76-
77-
7872
#### nvm
7973

8074
```{include} ../volto/_inc/_install-nvm.md
8175
```
8276

8377

78+
(prerequisites-for-installation-nodejs-label)=
79+
8480
#### Node.js
8581

8682
```{include} ../volto/_inc/_install-nodejs.md
8783
```
8884

89-
3. Enable {term}`corepack` so that Node.js will install {term}`pnpm` as a package manager.
90-
91-
```shell
92-
npm i -g corepack@latest && corepack enable
93-
```
94-
9585

9686
#### Make
9787

@@ -109,8 +99,7 @@ Plone 6 has both hardware requirements and software prerequisites.
10999

110100
## Generate the project
111101

112-
After satisfying the prerequisites and having activated an LTS version of Node,
113-
generate the project.
102+
After satisfying the prerequisites and having {ref}`activated an LTS version of Node.js <prerequisites-for-installation-nodejs-label>`, generate the project.
114103

115104
```shell
116105
uvx cookieplone project

0 commit comments

Comments
 (0)