Skip to content

Commit 153d0ad

Browse files
committed
Add MyST for labels, clean up English grammar and syntax
1 parent 86e1ef9 commit 153d0ad

File tree

1 file changed

+28
-26
lines changed
  • docs/backend/upgrading/version_specific_migration

1 file changed

+28
-26
lines changed

docs/backend/upgrading/version_specific_migration/v60.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -122,35 +122,36 @@ The training documentation lists {ref}`three possible theming strategies <traini
122122
See [PLIP 3061](https://github.com/plone/Products.CMFPlone/issues/3061).
123123

124124

125-
(v60--label)=
125+
(v60-python-label)=
126126

127127
## Python
128128

129129
You may need to use a newer Python version.
130-
Supported Python versions are: 3.7, 3.8 and 3.9.
130+
Supported Python versions are 3.7, 3.8, and 3.9.
131131
We recommend the most recent version.
132132
See https://www.python.org/downloads/ for which Python version is still supported by the Python community.
133133

134134
See [PLIP 3229](https://github.com/plone/Products.CMFPlone/issues/3229).
135135

136136

137-
(v60--label)=
137+
(v60-plone.api.relation-label)=
138138

139139
## `plone.api.relation`
140140

141-
The `plone.api` package now has a `relation` module. Add-on authors may want to use this to get, create or delete relations.
141+
The `plone.api` package now has a `relation` module.
142+
Add-on authors may want to use this to get, create, or delete relations.
142143

143144
See [PLIP 3137](https://github.com/plone/Products.CMFPlone/issues/3137).
144145

145146

146-
(v60--label)=
147+
(v60-mockup-resource-registry-label)=
147148

148149
## Mockup and resource registry redone
149150

150151
Mockup contains the source of most Classic Plone JavaScript.
151152
The compiled version is in `plone.staticresources`.
152153

153-
Mockup is now based on Patternslib 4.
154+
Mockup is now based on [Patternslib 4](https://patternslib.com/).
154155
It uses ES6 module imports instead of RequireJS.
155156
Add-ons for Classic Plone that use JavaScript should be updated to use ES6 modules as well.
156157

@@ -160,62 +161,63 @@ Add-ons for Classic Plone only need to register bundles, not individual resource
160161
See [PLIP 3211](https://github.com/plone/Products.CMFPlone/issues/3211).
161162

162163

163-
(v60--label)=
164+
(v60-relations-control-panel-label)=
164165

165166
## Relations control panel
166167

167-
Plone 6 has a new control panel for relations: `@@inspect-relations`.
168+
Plone 6 has a new control panel for relations, `@@inspect-relations`.
168169
As Manager you may want to use this control panel to look for and fix possible problems.
169170

170171
See [PLIP 3232](https://github.com/plone/Products.CMFPlone/issues/3232).
171172

172173

173-
(v60--label)=
174+
(v60-deprecated-unicode-property-types-label)=
174175

175-
## Deprecated unicode property types
176+
## Deprecated Unicode property types
176177

177-
Zope 5 has deprecated the unicode property types: ustring, ulines, utext, utokens.
178-
If you use these in your add-on, you should switch to their standard variants: string, lines, text, tokens.
178+
Zope 5 has deprecated the Unicode property types `ustring`, `ulines`, `utext`, and `utokens`.
179+
If you use these in your add-on, you should switch to their standard variants `string`, `lines`, `text`, and `tokens`.
179180
These behave exactly the same on Python 3.
180-
Plone has an upgrade step that goes through all objects in the site, replacing the deprecated properties with the default ones, so you should not see them anymore.
181-
But in your own code you should avoid adding them again.
181+
Plone has an upgrade step that goes through all objects in the site, replacing the deprecated properties with the default ones.
182+
You should avoid adding them to your code.
182183

183184
See [issue 3305](https://github.com/plone/Products.CMFPlone/issues/3305).
184185

185186

186-
(v60--label)=
187+
(v60-autoinclude-label)=
187188

188189
## autoinclude
189190

190191
We have replaced `z3c.autoinclude` with `plone.autoinclude`.
191-
Both are used by add-ons (Python packages) to signal with an entry point that Plone must load the zcml of the add-on.
192-
In most cases, the existing entry point can stay the same, for example in `setup.py`:
192+
Both are used by add-ons (Python packages) to signal with an entry point that Plone must load the ZCML of the add-on.
193+
In most cases, the existing entry point can stay the same.
194+
For example in `setup.py`:
193195

194-
```
196+
```python
195197
entry_points="""
196198
[z3c.autoinclude.plugin]
197199
target = plone
198200
"""
199201
```
200202

201-
When your package name differs from your module name, so what you import in Python, you need a different entry point.
202-
When your module is called `example.alternative`, create this entry point:
203+
When your package name differs from your module name, you need to specify a differently named entry point.
204+
When your module is named `example.alternative`, create this entry point:
203205

204-
```
206+
```python
205207
entry_points="""
206208
[plone.autoinclude.plugin]
207209
target = plone
208210
module = example.alternative
209211
"""
210212
```
211213

212-
A second change that may influence add-ons, is that the `includeDependencies` directive is no longer supported.
214+
The `includeDependencies` directive is no longer supported.
213215
It was already recommended not to use this directive, as it is too implicit.
214-
In the zcml files of your add-on, search for `includeDependencies`.
215-
If you find it, you must replace it by explicitly loading any zcml from other packages that the add-on needs.
216-
Sample change from [`dexterity.membrane`](https://github.com/collective/dexterity.membrane/pull/60):
216+
In the ZCML files of your add-on, search for `includeDependencies`.
217+
Replace all of its instances by explicitly loading any ZCML from other packages used by the add-on.
218+
Here is a sample change from [`dexterity.membrane`](https://github.com/collective/dexterity.membrane/pull/60):
217219

218-
```
220+
```diff
219221
- <includeDependencies package="." />
220222
+ <include package="Products.membrane" />
221223
```

0 commit comments

Comments
 (0)