Skip to content

Commit 1e7ade7

Browse files
committed
Clean up preparations.md
1 parent 115fd1d commit 1e7ade7

File tree

1 file changed

+58
-43
lines changed

1 file changed

+58
-43
lines changed
Lines changed: 58 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,91 @@
11
---
22
myst:
33
html_meta:
4-
"description": ""
5-
"property=og:description": ""
6-
"property=og:title": ""
7-
"keywords": ""
4+
"description": "Plone upgrade preparations"
5+
"property=og:description": "Plone upgrade preparations"
6+
"property=og:title": "Plone upgrade preparations"
7+
"keywords": "Plone, upgrade, preparations"
88
---
99

10-
# Preparations
11-
12-
```{admonition} Description
13-
Things to do before you migrate Plone.
14-
```
15-
16-
## Gather Information
17-
18-
- Read the "What's new in..." for your relevant Plone version, and read the release notes.
19-
20-
- You'll find these in the CMFPlone directory of the distribution of the new version of Plone.
2110

22-
- Make sure to check installed add-ons, if you **do not** need certain add-ons anymore, please deactivate and deinstall.
11+
(upgrade-preparations-label)=
2312

24-
- Check for dependencies
13+
# Preparations
2514

26-
- Read the release notes for the Plone release you are upgrading to, in particular:
15+
This chapter lists things to do before you migrate Plone.
2716

28-
- What version of Python is required?
2917

30-
- What version of Zope is required?
18+
(upgrade-gather-informationlabel)=
3119

32-
- Do you need any new Python libraries?
20+
## Gather information
3321

34-
- Make sure all the add-on products you are using have updated to support the version of Plone you are upgrading to.
22+
- Read the "What's new in..." for your relevant Plone version, and read the release notes.
23+
You will find these in the {file}`CMFPlone` directory of the distribution of the new version of Plone.
3524

36-
- Start with the third-party products that are in use on your site.
25+
- Make sure to check installed add-ons.
26+
If you **do not** need certain add-ons anymore, deactivate and uninstall them.
3727

38-
- Verify that they have been updated or verified to work on the new version, and get them upgraded in your existing instance before you start the Plone/Zope/Python upgrade if possible.
28+
- Check for dependencies.
3929

40-
- If Zope depends on a newer version of Python, install the new version of Python first.
30+
- Read the release notes for the Plone release you are upgrading to, in particular:
31+
32+
- What version of Python is required?
33+
34+
- What version of Zope is required?
35+
36+
- Do you need any new Python libraries?
37+
38+
- Make sure all the add-on products you are using have been updated to support the version of Plone to which you are upgrading.
39+
40+
- Start with the third-party products that are in use on your site.
41+
Verify that they have been updated or verified to work on the new version, and get them upgraded in your existing instance before you start the Plone/Zope/Python upgrade, if possible.
42+
43+
- If Zope depends on a newer version of Python, install the new version of Python first.
44+
45+
- If the newer version of Plone depends on a newer version of Zope, you will need to install that before proceeding with the Plone upgrade.
4146

42-
- If the newer version of Plone depends on a newer version of Zope, you will need to install that before proceeding with the Plone upgrade.
47+
```{note}
48+
Zope has its own migration guidelines, which you will find in the release notes of the version you are migrating to.
49+
50+
If Plone is being upgraded at the same time as a Zope version, Plone will usually handle the Zope upgrade with its own migration script.
51+
```
4352
44-
```{note}
45-
Zope has its own migration guidelines, which you will find in the release notes of the version you are migrating to.
53+
- Read the following files in the {file}`CMFPlone` directory of the distribution of the new version of Plone to which you want to update.
4654
47-
If Plone is being upgraded at the same time as a Zope version, Plone will usually handle the Zope upgrade with its own migration script.
48-
```
55+
- `README.txt`
56+
57+
- `INSTALL.txt`
58+
59+
- `UPGRADE.txt` (although this usually contains only the general procedure outlined above)
4960
50-
- Read the following files in the CMFPlone directory of the distribution of the new version of Plone you want to update to:
61+
These files may contain important last-minute information, and might be more specific than the relevant sections of this reference manual.
5162
52-
- README.txt
5363
54-
- INSTALL.txt
64+
(upgrade-back-up-your-Plone-site-label)=
5565
56-
- UPGRADE.txt (although this usually contains only the general procedure outlined above)
66+
## Back up your Plone site
5767
58-
- These files are important because they may contain important last minute information and might be more specific than the relevant sections of this reference manual.
68+
```{danger}
69+
Always back up your Plone site before upgrading.
70+
```
5971

60-
## Back Up Your Plone Site
72+
```{seealso}
73+
See Plone 5.2 documentation, [Backing up your Plone deployment](https://docs.plone.org/manage/deploying/backup.html).
74+
```
6175

62-
```{note}
63-
It's important to back up your Plone site.
76+
```{todo}
77+
Migrate the Plone 5.2 docs for Backing up your Plone deployment into Plone 6 docs.
6478
```
6579

66-
You will find a {doc}`how-to on backing up your Plone site here </manage/deploying/backup>`.
6780

68-
## Setup A Test Environment To Rehearse The Upgrade
81+
(upgrade-setup-a-test-environment-to-rehearse-the-upgrade-label)=
82+
83+
## Setup a test environment to rehearse the upgrade
6984

70-
```{note}
85+
```{danger}
7186
Never work directly on your live site until you know that the upgrade was successful.
7287
```
7388

74-
Instead, create a test environment to rehearse the upgrade.
89+
Always create a test environment to rehearse the upgrade.
7590
Copy your instance into a new environment and upgrade the copy.
76-
This is a good way of working out your third party products and dependencies in preparation for the final upgrade of the live site!
91+
This is a good way of working through your third-party products and dependencies in preparation for the final upgrade of the live site.

0 commit comments

Comments
 (0)