Skip to content

Commit b5a2d70

Browse files
committed
Clean up plone5-minor-upgrade.md
Add html_meta header Fix MyST and English grammar and syntax
1 parent 608a276 commit b5a2d70

File tree

1 file changed

+35
-25
lines changed

1 file changed

+35
-25
lines changed
Lines changed: 35 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,54 @@
1-
# Upgrading Plone 5 Within 5.x.x Series
1+
---
2+
myst:
3+
html_meta:
4+
"description": "Upgrading Plone 5 within 5.x.x series"
5+
"property=og:description": "Upgrading Plone 5 within 5.x.x series"
6+
"property=og:title": "Upgrading Plone 5 within 5.x.x series"
7+
"keywords": "Upgrading, Plone 5"
8+
---
9+
10+
(upgrading-plone-5-within-5.x.x-series-label)=
11+
12+
# Upgrading Plone 5 within 5.x.x series
13+
14+
This chapter outlines steps for minor upgrades within the Plone 5 major release.
215

3-
```{admonition} Description
4-
Steps for minor upgrades within the Plone 5 Major Release.
5-
```
616

717
```{warning}
818
Before performing any Plone upgrade, you should always have a complete backup of your site.
9-
See the {ref}`upgrade-preparations-label` section of this manual for more details.
19+
See the {doc}`../preparations` chapter of this documentation for more details.
1020
11-
In addition, you should check the {ref}`version-specific-upgrade-guide-label`
12-
section of this manual for any notes that may apply to the specific version upgrade you're about to perform.
21+
In addition, you should check the {doc}`../version-specific-migration/index` chapter of this documentation for any notes that may apply to the specific version upgrade that you are about to perform.
1322
```
1423

1524
## Buildout
1625

17-
Out of the box, Plone's Unified Installer includes a `buildout.cfg` (typically located at your-plone-directory/zinstance/buildout.cfg) file that contains the following parameter.
26+
Out of the box, Plone's Unified Installer includes a {file}`buildout.cfg` (typically located at `your-plone-directory/zinstance/buildout.cfg`) file that contains the following parameter.
1827

19-
```shell
28+
```cfg
2029
extends =
21-
base.cfg
22-
versions.cfg
23-
# http://dist.plone.org/release/5.1-latest/versions.cfg
30+
base.cfg
31+
versions.cfg
32+
# https://dist.plone.org/release/5.1-latest/versions.cfg
2433
```
2534

26-
This tells buildout to get all of its package versions from the included versions.cfg file.
27-
Notice that there is another line, commented out, that points to dist.plone.org. This location will always contain the
28-
most recent versions that comprise the latest release in the Plone 5.1 series.
29-
(You can also replace 5.1-latest with 5.0-latest or 5.2-latest, or another other existing minor release in the 5.x series.)
35+
This tells buildout to get all of its package versions from the included {file}`versions.cfg` file.
36+
Notice that there is another line, commented out, that points to `dist.plone.org`.
37+
This location will always contain the most recent versions that comprise the latest release in the Plone 5.1 series.
38+
You can also replace `5.1-latest` with `5.0-latest` or `5.2-latest`, or another existing minor release in the 5.x series.
3039

31-
To upgrade your buildout to use the latest Plone 5.1.x release, comment out versions.cfg and
32-
uncomment the line pointing to dist.plone.org, so it looks like this:
40+
To upgrade your buildout to use the latest Plone 5.1.x release, comment out `versions.cfg` and uncomment the line pointing to `dist.plone.org`, so it looks like this:
3341

34-
```shell
42+
```cfg
3543
extends =
36-
base.cfg
37-
# versions.cfg
38-
http://dist.plone.org/release/5.1-latest/versions.cfg
44+
base.cfg
45+
# versions.cfg
46+
https://dist.plone.org/release/5.1-latest/versions.cfg
3947
```
4048

4149
Save your changes.
4250

51+
4352
### Upgrading
4453

4554
Stop your Plone instance:
@@ -62,13 +71,14 @@ When buildout finishes running, restart your Plone instance:
6271
bin/plonectl start
6372
```
6473

74+
6575
## Migration
6676

67-
Visit your Management Interface (<http://yoursite:8080>).
77+
Visit your Management Interface (http://yoursite:8080).
6878
You will see a message prompting you to run Plone's migration script for each site in your instance:
6979

70-
`This site configuration is outdated and needs to be upgraded.`
80+
{guilabel}`This site configuration is outdated and needs to be upgraded.`
7181

72-
Click {guilabel}`Upgrade` button next to the site and the upgrade will run.
82+
Click the {guilabel}`Upgrade` button next to the site and the upgrade will run.
7383

7484
Check {guilabel}`Dry Run` if you want to test the migration before you execute it.

0 commit comments

Comments
 (0)