|
| 1 | +--- |
| 2 | +html_meta: |
| 3 | + "description": "Upgrade to Volto" |
| 4 | + "property=og:description": "Upgrade to Volto" |
| 5 | + "property=og:title": "Upgrade to Volto" |
| 6 | + "keywords": "Upgrading, Plone 6, Volto" |
| 7 | +--- |
| 8 | + |
| 9 | +(backend-upgrade-to-volto-label)= |
| 10 | + |
| 11 | +# Upgrading to Volto |
| 12 | + |
| 13 | +To upgrade an existing site to run with Volto requires a couple of changes to your existing content. |
| 14 | + |
| 15 | +The form `/@@migrate_to_volto` allows you to run all these steps directly. |
| 16 | +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`. |
| 17 | + |
| 18 | +```{warning} |
| 19 | +Test all migrations thoroughly it before applying them on a production-environment! |
| 20 | +
|
| 21 | +A migrated site will still work in Plone Classic but behave different. |
| 22 | +Editors can only work with the content effectively using Volto. |
| 23 | +``` |
| 24 | + |
| 25 | +The required steps are: |
| 26 | + |
| 27 | +1. **Install the packages {py:mod}`plone.volto` and {py:mod}`plone.restapi`.** |
| 28 | + |
| 29 | + {py:mod}`plone.restapi` is the RESTful hypermedia API for Plone that allows the Frontend Volto to communicate with the backend. |
| 30 | + {py:mod}`plone.volto` configures Plone to work with Volto, the new default frontend for Plone 6. |
| 31 | + |
| 32 | +1. **Migrate Richtext-Fields to Volto blocks** |
| 33 | + |
| 34 | + Volto has a new editor different from TinyMCE that is used in Classic Plone. |
| 35 | + This step converts the html stored in RichText fields into text-blocks so you can edit it in Volto. |
| 36 | + Images, Links and most kinds of html-formating are preserved. |
| 37 | + |
| 38 | + |
| 39 | + For this you need to have `blocks-conversion-tool` running on an accessible url. |
| 40 | + The easiest way to have that running on your machine is to use docker: |
| 41 | + |
| 42 | + ```shell |
| 43 | + docker run -it -p 5000:5000 plone/blocks-conversion-tool:latest |
| 44 | + ``` |
| 45 | + |
| 46 | + For more options read https://github.com/plone/blocks-conversion-tool. |
| 47 | + |
| 48 | +1. **Pages, News Items and Events are made folderish** |
| 49 | + |
| 50 | + That means these types can contain other content like Images or other Pages. |
| 51 | + When you create a new site in Plone 6 this setting is also applied automatically. |
| 52 | + But existing content remains non-folderish undtil this step is run. |
| 53 | + |
| 54 | +1. **Turn folders into folderish pages** |
| 55 | + |
| 56 | + In Volto adding Folders is disabled by default. |
| 57 | + Instead folderish pages are used to create folder-structures. |
| 58 | + This step turn all folders into folderish pages. |
| 59 | + If the folder showed a listing of the content a appropriate listing block will be added. |
| 60 | + If the folder showed a default page that will be handled in the next step. |
| 61 | + You can re-enable Folders by checking the box *Implicitly addable?* in ``/portal_types/Folder/manage_propertiesForm``. |
| 62 | + |
| 63 | +1. **Default Pages of Folders are merged with the Folderish Pages that replace the Folder** |
| 64 | + |
| 65 | + Volto does not have a concept of default pages. |
| 66 | + Instead folderish pages can show text and/or a listing of all the content inside that page. |
| 67 | + This step takes the content of the default-page (e.g. text or the query of a collection) and adds that to the folderish page that replaced the folder. |
| 68 | + Metadata (subjects, author, rights...) and relations are moved to the folderish page. |
| 69 | + |
| 70 | + |
| 71 | +1. **Collections are migrated to Pages with Listing Blocks** |
| 72 | + |
| 73 | + In Volto adding Collections is disabled by default. |
| 74 | + Instead folderish pages with listing blocks are used. |
| 75 | + This step turns all collections into folderish pages. |
| 76 | + The criteria of the collection are uses to configure a listing block in that page. |
| 77 | + |
| 78 | + |
| 79 | +It is recommended to use the default settings but you can choose to skip some of the migration-steps in the form. |
0 commit comments