From f1d2a069cf59eeb3c8ad2d4c248201dc7d7744b0 Mon Sep 17 00:00:00 2001 From: Corentin Bettiol <45763865+corentinbettiol@users.noreply.github.com> Date: Wed, 21 Jun 2023 09:42:19 +0200 Subject: [PATCH] docs: update README (#57) * DOCS: update README Add a "migrate from cmsplugin" management command mention in README * docs: update README Improve the "migrate from cmsplugin" mention, add a link to the deprecate_cmsplugin_filer app. --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index 972fdff..8f94b17 100644 --- a/README.rst +++ b/README.rst @@ -98,3 +98,19 @@ You can run tests by executing:: :target: https://www.djangoproject.com/ .. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.7%2B-blue.svg :target: https://www.django-cms.org/ + + +Updating from `cmsplugin-filer `_ +-------------------------------------------------------------------------------- + +Historically, `cmsplugin-filer` was used to create file, folder, image, link, teaser & video plugins on your django CMS projects. Now `cmsplugin-filer` has been archived, you can still migrate your old instances without having to copy them manually to the new `djangocms-` plugins. + +There's a third-party management command that supports your migration: + +`migrate_cmsplugin_filer.py `_ + +This management command is only a starting point. It *has* worked out of the box for some people, but we encourage you to read the code, understand what it does, and test it on a development environment before running it on your production server. + +The management command is only configured to transfer your `cmsplugin_link`, `cmsplugin_file`, `cmsplugin_folder` and `cmsplugin_image` plugins to modern `djangocms_*` plugins. If you need to transfer other `cmsplugin_*` plugins, you'll have to write your own code. + +Alternatively you can use the `deprecate_cmsplugin_filer `_ app, which only adds a small migration that transfer the old `cmsplugin-filer` plugins instances to the new `djangocms-` plugins.