Skip to content

Commit f1aea02

Browse files
pbauerstevepiercy
andauthored
Document installing a Classic UI project with cookieplone (#1953)
* Document installing a classic project with cookieplone * update cookieplone output and some wording * add note for classic ui * The targets build-dev and build-backend have be replaced by install and backend-build. Also simplify the complex explanation of the make process. * imho this is distracting for the beginner-oriented installation * Don't erase history, append to it instead. * Simplify choose a user interface * Only markup first instance of glossary terms, move warnings before installing * Change heading, its label, and prevent an empty heading * Change headings to be explicitly for Volto, its label, prevent an empty heading, and remove now redundant seealso * Update docs/install/create-project-cookieplone.md Co-authored-by: Steve Piercy <[email protected]> * Update docs/install/index.md Co-authored-by: Steve Piercy <[email protected]> * Update docs/reference-guide/cookieplone-make-commands.md Co-authored-by: Steve Piercy <[email protected]> * Update docs/admin-guide/add-ons.md Co-authored-by: Steve Piercy <[email protected]> * Update docs/admin-guide/add-ons.md Co-authored-by: Steve Piercy <[email protected]> * Update docs/admin-guide/add-ons.md Co-authored-by: Steve Piercy <[email protected]> * Apply suggestions from code review Co-authored-by: Steve Piercy <[email protected]> * rename file * Anonymize cookieplone output * Explicitly name heading * Rename and add redirect * Promote Cookieplone as the recommended installation method, shortening the path by moving the Buildout and pip comparison to a seealso at the end. * Remove duplicate versionadded * Git is capitalized * Clean up Volto project console output * Clean up Classic UI project console output * Make distinction between Volto and Classic UI projects in both headings and narrative text * Grammar * Tweak glossary entry --------- Co-authored-by: Steve Piercy <[email protected]>
1 parent d6a0e18 commit f1aea02

File tree

13 files changed

+383
-127
lines changed

13 files changed

+383
-127
lines changed
266 KB
Loading
144 KB
Loading

docs/admin-guide/add-ons.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,18 @@ Use the following instructions if you installed Plone with Cookieplone.
2626

2727
### Install an add-on
2828

29-
Add a line with the name of your add-on in the file {file}`backend/requirements.txt`.
30-
This example uses [`collective.easyform`](https://pypi.org/project/collective.easyform/).
31-
32-
```
33-
collective.easyform==4.2.1
29+
Add the name of your add-on in the file {file}`backend/pyproject.toml` in the section `dependencies`.
30+
This example adds [`collective.easyform`](https://pypi.org/project/collective.easyform/).
31+
32+
```{code-block} toml
33+
:emphasize-lines: 6
34+
dependencies = [
35+
"Products.CMFPlone==6.1.1",
36+
"plone.api",
37+
"plone.classicui",
38+
"plone.app.caching",
39+
"collective.easyform==4.4.0",
40+
]
3441
```
3542

3643
```{tip}

docs/conceptual-guides/choose-user-interface.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ The choice of user interface has implications for editors, admins, and developer
2525
:target: /_static/volto-ui.png
2626
```
2727
28+
Test it on https://volto.demo.plone.org (without add-ons) or https://demo.plone.org (with add-ons).
29+
2830
For editors and other end users:
2931
3032
- The user interface is a fast, modern, single-page web application.
@@ -47,6 +49,8 @@ For developers and integrators:
4749
:target: /_static/classic-ui.png
4850
```
4951
52+
Test it on https://classic.demo.plone.org.
53+
5054
For editors and other end users:
5155
5256
- The user interface is similar to Plone 5.

docs/conceptual-guides/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ compare-buildout-pip
2020
distributions
2121
package-management
2222
package-dependencies
23-
make-build-backend-walk-through
23+
make-backend-build
2424
components
2525
```
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description": "make backend-build in Plone."
5+
"property=og:description": "make backend-build in Plone."
6+
"property=og:title": "make backend-build"
7+
"keywords": "Plone 6, make, backend-build, install"
8+
---
9+
10+
(make-backend-build-label)=
11+
12+
# `make backend-build`
13+
14+
This chapter assumes you have previously followed {doc}`/install/create-project-cookieplone`.
15+
16+
The `Makefile` at the root of your project invokes commands in `backend/Makefile`.
17+
18+
The command `make backend-build` performs the following tasks.
19+
20+
- Invokes the target `install` in `backend/Makefile`.
21+
- `install` has the two dependencies `$(VENV_FOLDER)` and `config`.
22+
- `$(VENV_FOLDER)` creates and populates a virtual Python environment with uv from a {file}`constraints.txt` file generated using mxdev.
23+
- `config` creates the Zope and Plone configuration files using cookiecutter-zope-instance.
24+
25+
You can configure your Zope instance as described in the section {doc}`/admin-guide/configure-zope`.

docs/conceptual-guides/make-build-backend-walk-through.md

Lines changed: 0 additions & 58 deletions
This file was deleted.

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,7 @@
383383
# -- sphinx-reredirects configuration ----------------------------------
384384
# https://documatt.com/sphinx-reredirects/usage.html
385385
redirects = {
386+
"conceptual-guides/make-build-backend-walk-through": "/conceptual-guides/make-backend-build.html",
386387
"contributing/plone-api": "/plone.api/contribute.html",
387388
"contributing/plone-restapi": "/plone.restapi/docs/source/contributing/index.html",
388389
"contributing/volto": "/volto/contributing/index.html",

docs/glossary.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ Cookieplone
3636
```{versionadded} Volto 18.0.0-alpha.43
3737
```
3838
39-
[Cookieplone](https://github.com/plone/cookieplone) is the method to create a Plone project.
40-
You can use Cookieplone to build a backend add-on, a new Volto add-on, or a full project with both backend and frontend.
39+
[Cookieplone](https://github.com/plone/cookieplone) is the recommended way to create a Plone project.
40+
You can use Cookieplone to build full Plone projects with either {term}`Volto` or {term}`Classic UI` for a frontend.
41+
You can also create a backend add-on, a Volto add-on, or a documentation scaffold.
4142
Cookieplone simplifies the process using robust Cookiecutter templates from {term}`cookieplone-templates`.
4243
4344
cookieplone-templates
@@ -896,7 +897,7 @@ Higher-Order Component
896897
```
897898
898899
Mocha
899-
[Mocha](https://mochajs.org/) is a feature-rich JavaScript test framework running on {term}`Node.js` and in the browser, making asynchronous testing simple and fun.
900+
[Mocha](https://mochajs.org/) is a feature-rich JavaScript test framework running on {term}`Node.js` and in the browser, making asynchronous testing simple and fun.
900901
901902
Chai
902903
[Chai](https://www.chaijs.com/) Chai is a {term}`BDD` and {term}`TDD` assertion library for {term}`Node.js` and the browser that can be delightfully paired with any JavaScript testing framework.

0 commit comments

Comments
 (0)