Skip to content

Commit e36a1c6

Browse files
authored
Revise README
Updated README to reflect compatibility with django CMS 4.1 and clarified migration instructions.
1 parent 7d89ae1 commit e36a1c6

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
**Warning:** If the migration process fails to complete you will not be able to undo the changes without reloading a database backup. We cannot be held accountable for any data loss sustained when running the commands provided in this project. Please keep a database backup before running any commands provided by this package.
44

55
## When do I need this package?
6-
This package is designed to migrate a django CMS 3.5+ project to django CMS 4.0.
6+
This package is designed to migrate a django CMS 3.5+ project to django CMS 4.0, 4.1.
7+
8+
For any later django CMS versions, **first go to django CMS 4.1**, then continue to upgrade.
79

810
## What does this package do?
911
- Keeps any draft and published content, ensuring that any new draft changes are kept as a new draft version in djangocms_versioning.
@@ -12,28 +14,28 @@ This package is designed to migrate a django CMS 3.5+ project to django CMS 4.0.
1214
- Runs django CMS' migrations
1315

1416
## Limitations
15-
Due to the nature of the changes between django CMS 3.5+ and 4.0 the package will fail to function if an incompatible package is installed.
17+
Due to the nature of the changes between django CMS 3.5+ and 4 the package will fail to function if an incompatible package is installed.
1618

1719
This may require you to:
1820
- Fork or copy and modify this package to work with any bespoke requirements your project has (we may accept these changes back for popular packages as a configurable option)
1921
- Ensure that all installed packages for your project are compatible with django CMS 4. If not, remove them before migrating.
2022
- `PageFields` in custom models need to have a `related_name` (since page pk change and references need to be updated). If you have page filds with a `related_name="+"`, temporarily give them a related name for the migration.
2123

2224
## Prerequisites
23-
Require knowledge of the changes and new features in 4.0:
25+
Require knowledge of the changes and new features in 4:
2426
- New cms app configuration
25-
- Revised Page, Title (Now named PageContent) and Placeholder relationships
27+
- Revised `Page`, `Title` (Now named `PageContent`) and `Placeholder` relationships
2628

27-
Requires knowledge of django CMS Versioning
29+
Requires knowledge of [django CMS Versioning](https://djangocms-versioning.readthedocs.io/)
2830
- Grouper and content model terms
2931
- Understanding how versioning selects published content
3032

3133
### Install the following packages
3234
The following packages are not yet officially released, they need to be installed directly from the repository. We need your help to make packages v4.0 compatible and to provide documentation for the wider community!
3335

34-
django CMS 4.0+
36+
django CMS 4.1+
3537
```
36-
pip install django-cms
38+
pip install django-cms\>=4.1,\<5
3739
```
3840

3941
djangocms-text-ckeditor

0 commit comments

Comments
 (0)