Remove ckeditor_templates_ui from Project page

Created on 7 December 2023, 11 months ago
Updated 8 May 2024, 6 months ago

Problem/Motivation

It seems CKEditor Templates UI module is no longer required with Drupal 10, CKEditor 5, and CKEditor Templates module with the work being done on CKEditor 5 support for Content Templates Needs review .

In ckeditor_templates_ui.routing.yml we have:

/admin/config/content/ckeditor_templates

entity.ckeditor_template.collection:
  path: '/admin/config/content/ckeditor_templates'
  defaults:
    _entity_list: 'ckeditor_template'
    _title: 'Ckeditor templates configuration'
  requirements:
    _permission: 'administer ckeditor templates'

In ckeditor_templates.routing.yml we have the following route:

admin/config/content/ckeditor-templates

entity.ckeditor_templates.collection:
  path: '/admin/config/content/ckeditor-templates'
  defaults:
    _entity_list: 'ckeditor_templates'
    _title: 'CKEditor Template Configuration'
  requirements:
    _permission: 'administer ckeditor templates'

The UI's are very similar. When adding templates using the route provided by the CKEditor Templates UI module, it has no effect on making the templates available to CKEditor 5. But when adding templates using the route provided by the main CKEditor Tempaltes module (with patch from #3273358), the functionality works as intended. Visually, the difference is the dash - versus the underscore _ in the URL and the version from the CKEditor Templates module additionally allows enabling the template in different text formats.

CKEditor Templates UI:

CKEditor Templates:

Proposed resolution

Once CKEditor 5 support for Content Templates Needs review lands:

  1. Document that ckeditor_templates_ui is incompatible for the latest versions of ckeditor_templates module on both respective project pages, readme, and in ckeditor_templates release notes.
  2. Ensure CKEditor 5 support for Content Templates Needs review contains an update hook to uninstall ckeditor_templates_ui, if present.

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Needs work

Version

1.0

Component

Documentation

Created by

🇪🇨Ecuador jwilson3

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

Comments & Activities

  • Issue created by @jwilson3
  • 🇪🇨Ecuador jwilson3

    Bumping to critical to avoid others having to waste time evaluating this and getting lost.

  • Status changed to Postponed 11 months ago
  • 🇯🇴Jordan Anas_maw

    You are talking about a patch wich is not committed yet, postponed until CKEditor 5 support for Content Templates Needs review

  • Status changed to Fixed 6 months ago
  • 🇯🇴Jordan Anas_maw

    This module now support Ckeditor 5 in the 2.x version, it's now depend on CKEditor 5 Template

  • Status changed to Active 6 months ago
  • 🇪🇨Ecuador jwilson3

    I'm not sure I understand the justification of how this is marked fixed. No docs updates were made, no mention on Project summary page of the fact that the features of this module are being included into the main CKEditor Template module with the work going on in CKEditor 5 support for Content Templates Needs review .

  • Status changed to Fixed 6 months ago
  • 🇯🇴Jordan Anas_maw

    The owners of the ckeditor_templates module decided to include the features provided by this module in their module, so this module will not be needed when they fixed the mentioned issue.
    At the same time, there is a new module ckeditor5_template which provides the CKEditor 5 feature, we integrated ckeditor_templates_ui module with ckeditor5_template in a separate branch, and this is mentioned on the module page.

  • Status changed to Needs work 6 months ago
  • 🇪🇨Ecuador jwilson3

    ckeditor_templates_ui maintainer is not interested in flagging this for folks. Therefore, lets take a different approach. I'm reopening and moving this to the ckeditor_templates issue queue as a documentation task to update the project page, and include accurate release notes that indicate that ckeditor_templates_ui should be uninstalled once CKEditor 5 support for Content Templates Needs review lands. There may even need to be an update hook added to automate uninstall the module as part of #3273358.

  • 🇯🇴Jordan Anas_maw

    Thanks for moving the issue to ckeditor_module, I'm really sad to see that the owners of ckeditor_module decided to take the features that I did on this module and include them in the ckeditor_module without any notice

  • 🇪🇨Ecuador jwilson3

    I could be wrong, but my understanding is that they added the UI because they're updating the architecture to use entities which facilitates admin UI's more or less for free. Also, consolidation and reducing overlap and module soup is – in general – a good thing in the Drupal ecosystem.

  • 🇬🇧United Kingdom jacobupal Leeds

    It feels kinda forward for a module to uninstall another module. I don't think I have experienced that before. It's especially weird if it occurs without the users knowledge.

    But if it was a notice/warning post-install and on the relevant pages and in the docs I think that would suffice no?

  • 🇪🇨Ecuador jwilson3

    Agreed. But your comment might be better served on the other issue CKEditor 5 support for Content Templates Needs review .

  • 🇳🇿New Zealand ericgsmith

    I'm really sad to see that the owners of ckeditor_module decided to take the features that I did on this module and include them in the ckeditor_module without any notice

    I don't think this was an active decision by the maintainers - this was just what the person who provided the original patch did.

Production build 0.71.5 2024