Skip to content

Commit d220898

Browse files
committed
Merge branch 'upgrade-guide' of github.com:plone/documentation into upgrade-guide
� Conflicts: � docs/backend/upgrading/intro.md � docs/backend/upgrading/preparations.md
2 parents a11b176 + a5b8d5a commit d220898

File tree

4 files changed

+22
-25
lines changed

4 files changed

+22
-25
lines changed

docs/backend/upgrading/intro.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ It just fixed a bug.
8181
A post on the Community forum, [Rules for Plone 6 development during the beta stage](https://community.plone.org/t/rules-for-plone-6-development-during-the-beta-stage/15432), discusses alpha and beta versioning.
8282
```
8383

84+
In addition to the general procedure there are {doc}`version-specific migration guides </manage/upgrading/version_specific_migration/index>`.
8485

8586
(introduction-version-specific-upgrade-guides-label)=
8687

@@ -90,6 +91,8 @@ In addition to the general upgrade procedure, there are {doc}`version-specific m
9091

9192
These guides contain specific instructions and valuable information that has been collected from real-life migration cases.
9293

94+
This approach is recommended for all upgrades of minor version and can work fine for most mayor upgrades.
95+
When dealing with mayor changes in Plone or with very large or complex installations a export-import based migration (see below) is often the better solution.
9396

9497
(introduction-upgrade-strategies-label)=
9598

docs/backend/upgrading/preparations.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,9 @@ This chapter lists things to do before you migrate Plone.
2020
## Gather information
2121

2222
- 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.
23+
You will find these in the [online directory of released versions on `dist.plone.org`](https://dist.plone.org/release/).
24+
As an example, you can find the file [`RELEASE-NOTES.md` for 6.0.0b2](https://dist.plone.org/release/6.0.0b2/RELEASE-NOTES.md).
2425

25-
- Make sure to check installed add-ons.
26-
If you **do not** need certain add-ons anymore, deactivate and uninstall them.
2726

2827
- Check for dependencies.
2928

@@ -44,21 +43,16 @@ This chapter lists things to do before you migrate Plone.
4443

4544
- 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.
4645

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-
```
52-
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.
46+
```{seealso}
47+
Zope has its own documentation of migration guidelines.
48+
Of most interest for migration are the following.
5449
55-
- `README.txt`
56-
57-
- `INSTALL.txt`
58-
59-
- `UPGRADE.txt` (although this usually contains only the general procedure outlined above)
50+
- [What's new](https://zope.readthedocs.io/en/latest/news.html) at a high level.
51+
- [Migrating between Zope versions](https://zope.readthedocs.io/en/latest/migrations/index.html).
52+
- [Detailed changelog](https://zope.readthedocs.io/en/latest/changes.html).
6053
61-
These files may contain important last-minute information, and might be more specific than the relevant sections of this reference manual.
54+
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.
55+
```
6256

6357

6458
(upgrade-back-up-your-Plone-site-label)=

docs/backend/upgrading/troubleshooting.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ When a site error occurs, or Zope fails to start, there's probably an informativ
2121
Locate [these log files](https://plone.org/documentation/faq/plone-logs) and inspect instance.log.
2222
Ignore irrelevant warnings and search for words such as error, exception and traceback (case-insensitive).
2323

24-
When Zope doesn't start and there's no useful information in the log file, you can start Zope interactively and watch for error messages in the output::
24+
When Zope doesn't start and there's no useful information in the log file, you can start Zope interactively and watch for error messages in the output:
2525

26-
```
26+
```bash
2727
bin/instance fg
2828
```
2929

3030
You may be able to find more information on the error messages in:
3131

32-
- the {doc}`Version-specific migration tips </manage/upgrading/version_specific_migration/index>` for your version of Plone
32+
- the {doc}`Version-specific migration tips </backend/upgrading/version_specific_migration/index>` for your version of Plone
3333
- the {doc}`Error References </appendices/error-reference>`
3434

3535
## Test without customizations
@@ -41,11 +41,11 @@ Temporarily remove your customizations, for example by removing your layers from
4141
If the problem disappears, you'll need to double-check your customizations.
4242
It's usually best to copy the original files of the new version of Plone to your skin, and re-customize those.
4343

44-
## Test without products
44+
## Test without add-ons
4545

46-
Bugs or compatibility problems in products that you have installed may cause problems in Plone.
47-
Go to Site Setup > Add/Remove Products and remove (uninstall) all product that are not distributed with Plone.
48-
Remove the uninstalled products from the Products directory of your Zope instance.
46+
Bugs or compatibility problems in add-ons that you have installed may cause problems in Plone.
47+
Go to Site Setup > Add-ons and deactivate all add-ons that are not distributed with Plone.
48+
Remove the deactivated add-ons from the packages of your Zope instance.
4949

5050
If the problem disappears, you'll need to doublecheck the offending product:
5151

@@ -81,7 +81,7 @@ The more complex your story is, the more likely that it is unique to your situat
8181

8282
Once you have investigated, analyzed, identified and confirmed the cause of your problem and you are convinced it's a bug (rather than an X-file), go to the appropriate bug tracker and report it:
8383

84-
- Products: the README usually tells how to report bugs
84+
- Add-ons: the README usually tells how to report bugs
8585
- [Plone Issue Tracker](https://github.com/plone/Products.CMFPlone/issues)
8686

8787
Do not use the bug trackers to ask for help.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ See [PLIP 3061](https://github.com/plone/Products.CMFPlone/issues/3061).
162162
## Python
163163

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

0 commit comments

Comments
 (0)