Skip to content

Commit 65efa87

Browse files
committed
Rename file with dashes, fix grammar and syntax, add a few inline todos.
1 parent 5e4b60f commit 65efa87

File tree

2 files changed

+104
-79
lines changed

2 files changed

+104
-79
lines changed
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
html_meta:
3+
"description": "Upgrading to Volto"
4+
"property=og:description": "Upgrading to Volto"
5+
"property=og:title": "Upgrading to Volto"
6+
"keywords": "Upgrading, Plone 6, Volto"
7+
---
8+
9+
(backend-upgrading-to-volto-label)=
10+
11+
```{todo}
12+
Is this "upgrading" or "migrating"? It seems to be a migration more than an upgrade. Please clarify.
13+
```
14+
15+
# Upgrading to Volto
16+
17+
```{todo}
18+
I think there needs to be an introduction to this chapter to give it better context. Here are a few questions I have when I jump to this document from who knows where.
19+
20+
1. Why would someone want to upgrade (migrate?) to Volto versus staying with Classic UI?
21+
1. What is the target audience?
22+
1. What are the pre-requisites?
23+
1. Other?
24+
25+
If you provide bullet points, I can write up the narrative and push to this PR.
26+
```
27+
28+
Upgrading an existing site to run with Volto requires several changes to your existing content stored in the backend.
29+
The form `/@@migrate_to_volto` allows you to run all these steps directly.
30+
After you upgraded your existing Database to Plone 6 there also is a message **You can prepare your site for Volto, the default frontend of Plone 6!** with a link to the form `localhost:8080/Plone/@@migrate_to_volto`.
31+
32+
```{todo}
33+
The previous sentence lacks context.
34+
When did I upgrade my existing database?
35+
Is there documentation that describes the database upgrade process?
36+
```
37+
38+
```{warning}
39+
Test all migrations thoroughly before applying them on a production environment!
40+
41+
A migrated site will still work with Plone Classic UI, but it will behave differently.
42+
For example, editors can only effectively work with the content using Volto.
43+
```
44+
45+
46+
```{todo}
47+
`{py:mod}` does not link to the Python modules (see https://deploy-preview-1254--6-dev-docs-plone-org.netlify.app/backend/upgrading/upgrade_to_volto.html).
48+
49+
We could either use inline literals as shown in the suggestion, or we could link to their Glossary entry (or create one), GitHub repo, PyPI project, or relevant chapter in the docs. Which do you think is best?
50+
```
51+
52+
The required steps are:
53+
54+
1. **Install the packages `plone.volto` and `plone.restapi`.**
55+
56+
`plone.restapi` is the RESTful API for Plone that allows the frontend Volto to communicate with the backend.
57+
`plone.volto` configures Plone to work with Volto, the new default frontend for Plone 6.
58+
59+
1. **Migrate RichText fields to Volto blocks**
60+
61+
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+
Images, links, and most kinds of HTML formatting are preserved.
64+
65+
For this you need to have `blocks-conversion-tool` running on an accessible URL.
66+
The easiest way to have that running on your machine is to use Docker:
67+
68+
```shell
69+
docker run -it -p 5000:5000 plone/blocks-conversion-tool:latest
70+
```
71+
72+
For more options read https://github.com/plone/blocks-conversion-tool.
73+
74+
1. **Pages, News Items, and Events are made folderish**
75+
76+
That means these types can contain other content such as Images or other Pages.
77+
When you create a new site in Plone 6, this setting is also applied automatically.
78+
But existing content remains non-folderish until this step is run.
79+
80+
1. **Turn folders into folderish pages**
81+
82+
In Volto adding Folders is disabled by default.
83+
Instead folderish pages are used to create folder structures.
84+
This step turns all folders into folderish pages.
85+
If the folder shows a listing of the content, an appropriate listing block will be added.
86+
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 *Implicitly addable?* in ``/portal_types/Folder/manage_propertiesForm``.
88+
89+
1. **Default Pages of Folders are merged with the Folderish Pages that replace the Folder**
90+
91+
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+
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+
Metadata (subjects, author, rights, and so on) and relations are moved to the folderish page.
95+
96+
97+
1. **Collections are migrated to Pages with Listing Blocks**
98+
99+
In Volto adding Collections is disabled by default.
100+
Instead folderish pages with listing blocks are used.
101+
This step turns all collections into folderish pages.
102+
The criteria of the collection are uses to configure a listing block in that page.
103+
104+
It is recommended to use the default settings, but you can choose to skip some of the migration steps in the form.

docs/backend/upgrading/upgrade_to_volto.md

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

0 commit comments

Comments
 (0)