Skip to content

Commit c1d559a

Browse files
committed
Add Glossary terms for Volto and Classic UI.
Use shorter sentences. More English grammar, syntax, and spelling cleanup. Fix some MyST syntax. Add guilabel for GUI elements.
1 parent 8ee1358 commit c1d559a

File tree

2 files changed

+34
-12
lines changed

2 files changed

+34
-12
lines changed

docs/backend/upgrading/migrate-to-volto.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,35 @@ html_meta:
1010

1111
# Migrate to Volto
1212

13-
Plone 6 comes with a new default frontend, called Volto.
14-
Volto is written in React and uses `plone.restapi` to communicate with the backend.
15-
When creating a new site in Plone 6 you have the option to choose between creating a default Plone site (that will use Volto) and a Classic Plone site.
16-
This choice is presented because there are some non-trivial differences between their configurations.
13+
Plone 6 comes with a new default frontend called {term}`Volto`.
14+
Volto is written in React and uses {py:mod}`plone.restapi` to communicate with the backend.
15+
16+
When creating a new Plone 6 site, you may choose between frontends.
1717

18+
- Volto - {guilabel}`Create a new Plone site`, the default option
19+
- {term}`Classic UI` - {guilabel}`Create Classic Plone site`
20+
- {guilabel}`Advanced`
21+
22+
This choice is presented because there are some non-trivial differences between their configurations.
1823
This document discusses these differences.
19-
It also informs administrators and developers of how to migrate their existing Plone 6 site with Classic UI for its frontend to instead become compatible with Volto for its frontend.
24+
It also informs administrators and developers of how to migrate their existing Plone 6 site with Classic UI to instead become compatible with Volto for its frontend.
2025

21-
```important
26+
```{important}
2227
As a pre-requisite, your Plone site must be [upgraded to Plone 6](v60) before migrating to Volto for the frontend.
2328
```
2429

2530
Plone provides a form `/@@migrate_to_volto` that allows you to run all the required changes to your existing site to make it compatible with Volto.
2631

27-
You can access this form in the browser when you are logged-in as an administrator by opening `http://localhost:8080/Plone/@@migrate_to_volto` (where `localhost` is your server, `8080` the port that Plone is running on and `Plone` is the name of the Plone instance).
32+
You can access this form in the browser when you are logged in as an administrator.
33+
Open `http://localhost:8080/Plone/@@migrate_to_volto`, where `localhost` is your hostname, `8080` is the port on which Plone runs, and `Plone` is the name of the Plone instance.
2834

29-
Additionally, after upgrading an existing site to Plone 6 (see {doc}`v60`) a message will appear, **You can prepare your site for Volto, the default frontend of Plone 6!**, with a link to that form.
35+
Additionally, after upgrading an existing site to Plone 6 (see {doc}`v60`), a message will appear, **You can prepare your site for Volto, the default frontend of Plone 6!**, with a link to that form.
3036

3137
```{warning}
3238
Test all migrations thoroughly before applying them on a production environment!
3339
3440
A site that is made compatible with Volto will be accessible with Plone Classic UI, but it will behave differently.
35-
For example, editors can only effectively work with the content using Volto because html is no longer editable in the TinyMCE editor.
41+
For example, editors can only effectively work with the content using Volto because HTML is no longer editable in the TinyMCE editor used in Classic UI.
3642
```
3743

3844
The required steps are:
@@ -70,7 +76,7 @@ The required steps are:
7076
This step turns all folders into folderish pages.
7177
If the folder shows a listing of the content, an appropriate listing block will be added.
7278
If the folder shows a default page, then it will be handled in the next step.
73-
You can re-enable Folders by checking the box *Implicitly addable?* in ``/portal_types/Folder/manage_propertiesForm``.
79+
You can re-enable Folders by checking the box {guilabel}`Implicitly addable?` in ``/portal_types/Folder/manage_propertiesForm``.
7480

7581
1. **Default Pages of Folders are merged with the Folderish Pages that replace the Folder**
7682

@@ -85,9 +91,9 @@ The required steps are:
8591
In Volto adding Collections is disabled by default.
8692
Instead folderish pages with listing blocks are used.
8793
This step turns all collections into folderish pages.
88-
The criteria of the collection are uses to configure a listing block in that page.
94+
The criteria of the collection are used to configure a listing block in that page.
8995

90-
It is recommended to use the default settings, but you can choose to skip some of the migration steps in the form.
96+
It is recommended to use the default settings, but you can choose to skip some migration steps in the form.
9197

9298
```{note}
9399
If you are migrating an existing site to Plone 6 using [{py:mod}`collective.exportimport`](https://pypi.org/project/collective.exportimport) and want to use Volto in the new site, then you do not need to use the form `@@migrate_to_volto`.

docs/glossary.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,4 +306,20 @@ HAProxy
306306
307307
nginx
308308
[nginx](https://docs.nginx.com/nginx/) (pronounced "engine x") is an HTTP and reverse proxy server, a mail proxy server, and a generic TCP/UDP proxy server, originally written by Igor Sysoev.
309+
310+
Volto
311+
[Volto](https://github.com/plone/volto) is a React-based frontend for the Plone CMS.
312+
It is the default user interface for Plone 6.
313+
314+
The other frontend is {term}`Classic UI`.
315+
316+
Classic UI
317+
Classic UI is a secondary frontend for Plone 6.
318+
It is integrated with [Products.CMFPlone](https://github.com/plone/Products.CMFPlone/).
319+
Its theme is named [Barceloneta](https://github.com/plone/plonetheme.barceloneta/).
320+
It is based on Twitter Bootstrap 5.
321+
It uses [Mockup](https://github.com/plone/mockup/) as its JavaScript stack.
322+
[View Mockup's patterns](https://plone.github.io/mockup/dev/).
323+
324+
The other frontend is {term}`Volto`.
309325
```

0 commit comments

Comments
 (0)