Provide a good UX to ensure the CKEditor 4 to 5 update is always done before upgrading to Drupal 10 unless the contrib module is installed

Created on 19 August 2022, over 2 years ago
Updated 13 February 2024, 12 months ago

Problem/Motivation

We have a reliable CKEditor 4 → 5 upgrade path (see \Drupal\ckeditor5\SmartDefaultSettings and related infrastructure). But it's still manual.

It's being used when navigating to /admin/config/content/formats/manage/basic_html (for example) and switching the text editor from to . This allows sites to already adopt CKEditor 5 in Drupal 9.3, 9.4 and 9.5 and help stabilize the upgrade path — which it did, see the many problems/hardenings we discovered at Drupal Dev Days in Ghent ~4 months ago: https://wimleers.com/blog/ddd-ghent-2022.

@catch argued in #16 that this should be manual, not automated. Discussion followed in #17#25 and culminated in @xjm summarizing the conclusion in #26.

Steps to reproduce

Proposed resolution

(Not anymore, see #26.)

Remaining tasks

  1. Propose UX for how Drupal 10's update.php should handle the ckeditor module still being present in core.extension (aka Editor config entities still on CKEditor 4) if https://www.drupal.org/project/ckeditor/releases/1.0.1 is not installed
  2. Review that "update.php UX"
  3. Implement that "update.php UX"
  4. Implement "one-click script that batches the updates", akin to the automatic upgrade path that the now defunct MR 2647 implemented, but instead requiring an explicit action (per @catch in #29).
  5. Review the "batch UX"

User interface changes

None, but this will appear when running the D9 → 10 updates:

API changes

None.

Data model changes

None.

Release notes snippet

None.

📌 Task
Status

Closed: works as designed

Version

10.0

Component
CKEditor 5 

Last updated about 23 hours ago

Created by

🇧🇪Belgium wim leers Ghent 🇧🇪🇪🇺

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024