Skip to content

Commit dab811e

Browse files
committed
update docs on migrating to volto
1 parent 9dd1220 commit dab811e

File tree

3 files changed

+10
-27
lines changed

3 files changed

+10
-27
lines changed

docs/backend/upgrading/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ html_meta:
1616
:hidden:
1717
1818
v60
19-
upgrade-to-volto
19+
migrate-to-volto
2020
```

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

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,14 @@
11
---
22
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"
3+
"description": "Migrate to Volto"
4+
"property=og:description": "Migrate to Volto"
5+
"property=og:title": "Migrate to Volto"
6+
"keywords": "Migrating, Upgrading, Plone 6, Volto"
77
---
88

9-
(backend-upgrading-to-volto-label)=
9+
(backend-migrate-to-volto-label)=
1010

11-
```{todo}
12-
Is this "upgrading" or "migrating"? It seems to be a migration more than an upgrade. Please clarify.
13-
14-
Technically it is a migration since the version of Plone does not get changed and it is no upgrade-step.
15-
It could be called a upgrade though because Volto is the new default frontend.
16-
Not 100% sure...
17-
```
18-
19-
20-
# Upgrading to Volto
11+
# Migrate to Volto
2112

2213
Plone 6 comes with a new default frontend, called Volto.
2314
Volto is written in React and uses `plone.restapi` to communicate with the backend.
@@ -26,32 +17,24 @@ This choice is presented because there are some non-trivial differences between
2617

2718
This document discusses these differences.
2819
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.
20+
2921
```important
3022
As a pre-requisite, your Plone site must be [upgraded to Plone 6](v60) before migrating to Volto for the frontend.
3123
```
3224

3325
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.
26+
3427
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).
3528

3629
After upgrading an existing site to Plone 6 (see {doc}`v60`) there will also appear a message **You can prepare your site for Volto, the default frontend of Plone 6!** with a link to that form.
3730

38-
39-
4031
```{warning}
4132
Test all migrations thoroughly before applying them on a production environment!
4233
4334
A site that is make compatible with Volto will be accessible with Plone Classic UI, but it will behave differently.
4435
For example, editors can only effectively work with the content using Volto because html is no longer editable in the TinyMCE editor.
4536
```
4637

47-
```{todo}
48-
`{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).
49-
50-
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?
51-
52-
I like `{py:mod}` because it is semantic and renders like a inline-literal. We don't require link in these cases.
53-
```
54-
5538
The required steps are:
5639

5740
1. **Install the packages {py:mod}`plone.volto` and {py:mod}`plone.restapi`.**

docs/backend/upgrading/v60.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The classic integrated frontend which is called "Classic UI" is still available
5555
If you choose to use Classic UI, then do not use the `plone.volto` package.
5656
```
5757

58-
To learn how to upgrade an existing Plone site to run with Volto, please read {doc}`upgrade-to-volto`.
58+
To learn how to modify an existing Plone site to run with Volto, please read {doc}`migrate-to-volto`.
5959

6060

6161
See [PLIP 2703](https://github.com/plone/Products.CMFPlone/issues/2703).

0 commit comments

Comments
 (0)