You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/backend/upgrading/version-specific-migration/migrate-to-volto.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,36 +30,37 @@ This document discusses these differences.
30
30
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.
31
31
32
32
```{important}
33
-
34
-
As a pre-requisite, your Plone site must be {ref}`upgraded to Plone 6<backend-upgrade-plone-v60-label>` before migrating to Volto for the frontend.
35
-
33
+
As a pre-requisite, your Plone site must be {doc}`upgraded to Plone 6 <upgrade-to-60>` before migrating to Volto for the frontend.
36
34
```
37
35
38
36
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.
39
37
40
-
You can access this form in the browser when you are logged in as an administrator.
38
+
You can access this form in the browser when you are logged in as an Administrator.
41
39
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.
42
40
43
-
Additionally, after upgrading an existing site to Plone 6 (see {ref}`backend-upgrade-plone-v60-label`), a message will appear, **You can prepare your site for Volto, the default frontend of Plone 6!**, with a link to that form.
41
+
Additionally, after upgrading an existing site to Plone 6 (see {doc}`upgrade-to-60`), a message will appear, **You can prepare your site for Volto, the default frontend of Plone 6!**, with a link to that form.
44
42
45
43
```{warning}
46
44
Test all migrations thoroughly before applying them on a production environment!
47
45
48
46
A site that is made compatible with Volto will be accessible with Plone Classic UI, but it will behave differently.
49
-
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.
47
+
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.
50
48
```
51
49
50
+
51
+
## Upgrade to Volto steps
52
+
52
53
The required steps are:
53
54
54
55
1.**Install the packages {py:mod}`plone.volto` and {py:mod}`plone.restapi`.**
55
56
56
57
{py:mod}`plone.restapi` is the RESTful API for Plone that allows the frontend Volto to communicate with the backend.
57
58
{py:mod}`plone.volto` configures Plone to work with Volto, the new default frontend for Plone 6.
58
59
59
-
1.**Migrate RichText fields to Volto blocks**
60
+
1.**Migrate `RichText` fields to Volto blocks**
60
61
61
62
Volto has a new editor called Slate, whereas Classic UI uses TinyMCE.
62
-
This step converts the HTML stored in RichText fields to text blocks, allowing you to edit them in Volto.
63
+
This step converts the HTML stored in `RichText` fields to text blocks, allowing you to edit them in Volto.
63
64
Images, links, and most kinds of HTML formatting are preserved.
64
65
65
66
For this you need to have `blocks-conversion-tool` running on an accessible URL.
@@ -84,20 +85,19 @@ The required steps are:
84
85
This step turns all folders into folderish pages.
85
86
If the folder shows a listing of the content, an appropriate listing block will be added.
86
87
If the folder shows a default page, then it will be handled in the next step.
87
-
You can re-enable Folders by checking the box {guilabel}`Implicitly addable?`in``/portal_types/Folder/manage_propertiesForm``.
88
+
You can re-enable Folders by checking the box {guilabel}`Implicitly addable?`in`/portal_types/Folder/manage_propertiesForm`.
88
89
89
90
1. **Default Pages of Folders are merged with the Folderish Pages that replace the Folder**
90
91
91
92
Volto does not have a concept of default pages.
92
-
Instead folderish pages can show text, a listing of all the content inside that page, or both.
93
+
Instead, folderish pages can show text, a listing of all the content inside that page, or both.
93
94
This step takes the content of the default page (such as text or the query of a collection), and adds that to the folderish page that replaces the folder.
94
95
Metadata (subjects, author, rights, and so on) and relations are moved to the folderish page.
95
96
96
-
97
97
1. **Collections are migrated to Pages with Listing Blocks**
98
98
99
99
In Volto adding Collections is disabled by default.
100
-
Instead folderish pages with listing blocks are used.
100
+
Instead, folderish pages with listing blocks are used.
101
101
This step turns all collections into folderish pages.
102
102
The criteria of the collection are used to configure a listing block in that page.
0 commit comments