Skip to content

Commit 1629862

Browse files
committed
Clean up upgrade-to-60.md
1 parent ab70d94 commit 1629862

File tree

1 file changed

+88
-54
lines changed

1 file changed

+88
-54
lines changed

docs/backend/upgrading/version-specific-migration/upgrade-to-60.md

Lines changed: 88 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -21,35 +21,42 @@ Some may require changes in your setup.
2121

2222
Plone no longer ships with the `portal_quickinstaller` tool (`CMFQuickInstallerTool`).
2323
In existing sites, the standard upgrade will remove the tool.
24+
2425
This is the final step in a deprecation path that started in Plone 5.1.
25-
Documentation on how to switch to GenericSetup and the new installer, can be seen in the old [Plone 5.1 upgrade guide](https://docs.plone.org/develop/addons/upgrade-to-51.html#installation-code).
2626

27-
See [PLIP 1775](https://github.com/plone/Products.CMFPlone/issues/1775).
27+
Documentation of how to switch to `GenericSetup` and the new installer, can be seen in {doc}`upgrade-addons-to-51`.
28+
29+
```{seealso}
30+
[PLIP 1775](https://github.com/plone/Products.CMFPlone/issues/1775)
31+
```
2832

2933

3034
(v60-dexterity-site-root-label)=
3135

3236
## Dexterity site root
3337

3438
For content types, in Plone 4 and 5 you had the option to use the old Archetypes or the new Dexterity framework.
35-
The Plone Site root object was neither: it was in its own class.
39+
The Plone site root object was neither: it was in its own class.
3640
In Plone 6, the site root itself is a Dexterity object.
3741

3842
When you upgrade a site from Plone 5.2 to 6.0, at first you will see an empty site root.
3943
Do not panic.
40-
Your contents are only temporarily invisible.
41-
Perform the standard migration via the `@@plone-upgrade` view and your content will be visible again.
44+
😱
45+
Your content is only temporarily invisible.
46+
Perform the standard migration via the `@@plone-upgrade` view, and your content will be visible again.
4247

43-
See [PLIP 2454](https://github.com/plone/Products.CMFPlone/issues/2454).
48+
```{seealso}
49+
[PLIP 2454](https://github.com/plone/Products.CMFPlone/issues/2454)
50+
```
4451

4552

4653
(v60-volto-label)=
4754

4855
## Volto
4956

50-
Plone 6 ships with a new NodeJS frontend: Volto.
57+
Plone 6 ships with a new React-based frontend, Volto.
5158
When you use the `Plone` package in your project, you will get the `plone.volto` integration package.
52-
This package prepares your Plone Site as a REST API.
59+
This package prepares your Plone site's backend as a REST API.
5360

5461
```{note}
5562
The classic integrated frontend which is called "Classic UI" is still available if you are not ready for the new separate frontend.
@@ -58,18 +65,21 @@ If you choose to use Classic UI, then do not use the `plone.volto` package.
5865

5966
To learn how to modify an existing Plone site to run with Volto, please read {doc}`migrate-to-volto`.
6067

61-
62-
See [PLIP 2703](https://github.com/plone/Products.CMFPlone/issues/2703).
68+
```{seealso}
69+
[PLIP 2703](https://github.com/plone/Products.CMFPlone/issues/2703)
70+
```
6371

6472

6573
(v60-archetypes-label)=
6674

6775
## Archetypes
6876

69-
The deprecated Archetypes contenttypes framework is no longer supported.
70-
Add-ons that define a contenttype must use Dexterity instead.
77+
The deprecated Archetypes content types framework is no longer supported.
78+
Add-ons that define a content type must use Dexterity instead.
7179

72-
See [PLIP 2775](https://github.com/plone/Products.CMFPlone/issues/2775).
80+
```{seealso}
81+
[PLIP 2775](https://github.com/plone/Products.CMFPlone/issues/2775)
82+
```
7383

7484

7585
(v60-deprecated-views-label)=
@@ -81,63 +91,73 @@ You can replace them with the new ones based on the following table:
8191

8292
| Legacy name | New name |
8393
|---------------------|--------------|
84-
| all_content | full_view |
85-
| atct_album_view | album_view |
86-
| collection_view | listing_view |
87-
| folder_album_view | album_view |
88-
| folder_full_view | full_view |
89-
| folder_listing | listing_view |
90-
| folder_summary_view | summary_view |
91-
| folder_tabular_view | tabular_view |
92-
| standard_view | listing_view |
93-
| thumbnail_view | album_view |
94-
95-
See [plone/plone.app.contenttypes#621](https://github.com/plone/plone.app.contenttypes/pull/621).
96-
94+
| `all_content` | `full_view` |
95+
| `atct_album_view` | `album_view` |
96+
| `collection_view` | `listing_view` |
97+
| `folder_album_view` | `album_view` |
98+
| `folder_full_view` | `full_view` |
99+
| `folder_listing` | `listing_view` |
100+
| `folder_summary_view` | `summary_view` |
101+
| `folder_tabular_view` | `tabular_view` |
102+
| `standard_view` | `listing_view` |
103+
| `thumbnail_view` | `album_view` |
104+
105+
```{seealso}
106+
[plone/plone.app.contenttypes issue #621](https://github.com/plone/plone.app.contenttypes/pull/621)
107+
```
97108

98109
(v60-no-temp_folder-tempstorage)=
99110

100-
## No more temp_folder / tempstorage
111+
## No more `temp_folder` or `tempstorage`
101112

102113
The `temp_folder` object in the Zope root is no longer created by default.
103114
If the object is there, but it is broken, the standard Plone upgrade procedure will remove it.
104115

105-
For now you must explicitly disable the `temp_folder` if you use buildout:
116+
For now, you must explicitly disable the `temp_folder` if you use buildout:
106117

107118
```ini
108119
[instance]
109120
recipe = plone.recipe.zope2instance
110121
zodb-temporary-storage = off
111122
```
112123

113-
See [issue 2957](https://github.com/plone/Products.CMFPlone/issues/2957).
124+
```{seealso}
125+
[plone/Products.CMFPlone issue #2957](https://github.com/plone/Products.CMFPlone/issues/2957)
126+
```
114127

115128

116129
(v60-templates-bootstrap-5-label)=
117130

118-
## Changed Templates to Bootstrap 5 Markup
131+
## Changed templates to Twitter Bootstrap 5 markup
119132

120-
All templates in core Plone have been updated to use Bootstrap 5 markup.
133+
All templates in core Plone have been updated to use Twitter Bootstrap 5 markup.
121134
Add-on authors are encouraged to do the same.
122135
If you have customized a core template, you should check if your change is still needed, and update it to fit the new markup.
123136
Any CSS and JavaScript that relies on a specific structure, or certain IDs or classes, should be checked as well.
124137

125-
See [PLIP 2967](https://github.com/plone/Products.CMFPlone/issues/2967).
138+
```{seealso}
139+
[PLIP 2967](https://github.com/plone/Products.CMFPlone/issues/2967)
140+
```
126141

127142

128143
(v60-zope-5-label)=
129144

130145
## Zope 5
131146

132147
Plone 6.0 means we move from Zope 4 to 5.
133-
This drops support for Python 2.7, drops ZServer, and removes deprecated code.
134-
See [Zope 5.0a1](https://zope.readthedocs.io/en/latest/changes.html#a1-2020-02-28).
148+
This drops support for Python 2.7, drops `ZServer`, and removes deprecated code.
149+
150+
```{seealso}
151+
[Zope 5.0a1](https://zope.readthedocs.io/en/latest/changes.html#a1-2020-02-28)
152+
```
135153

136154
Some imports may need to change.
137155
Add-on authors should check on Plone 5.2 if their code runs without any deprecation warnings from Zope 4.
138156
If no warnings are shown, the add-on should run fine on Zope 5.
139157

140-
See [PLIP 3058](https://github.com/plone/Products.CMFPlone/issues/3058).
158+
```{seealso}
159+
[PLIP 3058](https://github.com/plone/Products.CMFPlone/issues/3058)
160+
```
141161

142162

143163
(v60-barceloneta-lts-label)=
@@ -148,25 +168,29 @@ The standard theme in Classic UI was updated to Bootstrap 5, CSS variables, and
148168
If you have a theme that builds on Barceloneta, you most likely need various changes.
149169

150170
It may be best to start with a fresh theme, and try to keep the changes minimal.
151-
The training documentation lists {ref}`three possible theming strategies <training:theming-label>`:
171+
The training documentation lists {doc}`three possible theming strategies <theming_plone_5/index>`:
152172

153-
- Create a theme based on Barceloneta
154-
- Create a theme from scratch
155-
- Create a theme based on Diazo
173+
- Create a theme based on Barceloneta.
174+
- Create a theme from scratch.
175+
- Create a theme based on Diazo.
156176

157-
See [PLIP 3061](https://github.com/plone/Products.CMFPlone/issues/3061).
177+
```{seealso}
178+
[PLIP 3061](https://github.com/plone/Products.CMFPlone/issues/3061)
179+
```
158180

159181

160182
(v60-python-label)=
161183

162184
## Python
163185

164186
You may need to use a newer Python version.
165-
Supported Python versions are 3.8, 3.9 and 3.10.
187+
Supported Python versions are 3.8, 3.9, and 3.10.
166188
We recommend the most recent version.
167189
See https://www.python.org/downloads/ for which Python version is still supported by the Python community.
168190

169-
See [PLIP 3229](https://github.com/plone/Products.CMFPlone/issues/3229).
191+
```{seealso}
192+
[PLIP 3229](https://github.com/plone/Products.CMFPlone/issues/3229)
193+
```
170194

171195

172196
(v60-plone.api.relation-label)=
@@ -176,34 +200,40 @@ See [PLIP 3229](https://github.com/plone/Products.CMFPlone/issues/3229).
176200
The `plone.api` package now has a `relation` module.
177201
Add-on authors may want to use this to get, create, or delete relations.
178202

179-
See [PLIP 3137](https://github.com/plone/Products.CMFPlone/issues/3137).
203+
```{seealso}
204+
[PLIP 3137](https://github.com/plone/Products.CMFPlone/issues/3137)
205+
```
180206

181207

182208
(v60-mockup-resource-registry-label)=
183209

184210
## Mockup and resource registry redone
185211

186-
Mockup contains the source of most Classic Plone JavaScript.
212+
Mockup contains the source of most Classic UI Plone JavaScript.
187213
The compiled version is in `plone.staticresources`.
188214

189215
Mockup is now based on [Patternslib 4](https://patternslib.com/).
190216
It uses ES6 module imports instead of RequireJS.
191-
Add-ons for Classic Plone that use JavaScript should be updated to use ES6 modules as well.
217+
Add-ons for Classic UI Plone that use JavaScript should be updated to use ES6 modules as well.
192218

193219
The resource registries and their control panel have been simplified.
194-
Add-ons for Classic Plone only need to register bundles, not individual resources.
220+
Add-ons for Classic UI Plone only need to register bundles, not individual resources.
195221

196-
See [PLIP 3211](https://github.com/plone/Products.CMFPlone/issues/3211).
222+
```{seealso}
223+
[PLIP 3211](https://github.com/plone/Products.CMFPlone/issues/3211)
224+
```
197225

198226

199227
(v60-relations-control-panel-label)=
200228

201229
## Relations control panel
202230

203231
Plone 6 has a new control panel for relations, `@@inspect-relations`.
204-
As Manager you may want to use this control panel to look for and fix possible problems.
232+
As a Manager, you may want to use this control panel to look for and fix possible problems.
205233

206-
See [PLIP 3232](https://github.com/plone/Products.CMFPlone/pull/3232).
234+
```{seealso}
235+
[PLIP 3232](https://github.com/plone/Products.CMFPlone/pull/3232)
236+
```
207237

208238

209239
(v60-deprecated-unicode-property-types-label)=
@@ -216,15 +246,17 @@ These behave exactly the same on Python 3.
216246
Plone has an upgrade step that goes through all objects in the site, replacing the deprecated properties with the default ones.
217247
You should avoid adding them to your code.
218248

219-
See [issue 3305](https://github.com/plone/Products.CMFPlone/issues/3305).
249+
```{seealso}
250+
[plone/Products.CMFPlone issue #3305](https://github.com/plone/Products.CMFPlone/issues/3305)
251+
```
220252

221253

222254
(v60-autoinclude-label)=
223255

224-
## autoinclude
256+
## `autoinclude`
225257

226258
We have replaced `z3c.autoinclude` with `plone.autoinclude`.
227-
Both are used by add-ons (Python packages) to signal with an entry point that Plone must load the ZCML of the add-on.
259+
Both are used by add-ons (Python packages) to signal, with an entry point, that Plone must load the ZCML of the add-on.
228260
In most cases, the existing entry point can stay the same.
229261
For example in `setup.py`:
230262

@@ -259,5 +291,7 @@ Here is a sample change from [`dexterity.membrane`](https://github.com/collectiv
259291

260292
The same change is needed for the no longer supported `includeDependenciesOverrides` directive, which may be used in `overrides.zcml`.
261293

262-
See [PLIP 3339](https://github.com/plone/Products.CMFPlone/issues/3339).
263-
Also see the [`plone.autoinclude`](https://github.com/plone/plone.autoinclude) documentation.
294+
```{seealso}
295+
- [PLIP 3339](https://github.com/plone/Products.CMFPlone/issues/3339)
296+
- [`plone.autoinclude`](https://github.com/plone/plone.autoinclude) documentation
297+
```

0 commit comments

Comments
 (0)