Problem/Motivation

Drupal.ckeditor5 one of the few JavaScript APIs CKEditor 5 module provides. However, at the moment, it has barely any documentation.

Proposed resolution

Let's ensure that Drupal.ckeditor5 is documented sufficiently.

Remaining tasks

User interface changes

API changes

Data model changes

Issue fork drupal-3248430

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

lauriii created an issue. See original summary.

Wim Leers’s picture

Wim Leers
Location Ghent 🇧🇪🇪🇺
CreditAttribution: Wim Leers at Acquia commented
Issue tags: +JavaScript

+1!

Wim Leers’s picture

Wim Leers
Location Ghent 🇧🇪🇪🇺
CreditAttribution: Wim Leers at Acquia commented
Project: CKEditor 5 » Drupal core
Version: 1.0.x-dev » 9.3.x-dev
Component: Documentation » ckeditor5.module

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Wim Leers’s picture

Wim Leers
Location Ghent 🇧🇪🇪🇺
CreditAttribution: Wim Leers at Acquia commented
Issue tags: +stable blocker

This feels like a stable blocker, specifically for the documentation gate.

nod_’s picture

nod_
Primary language French
Location Lille
CreditAttribution: nod_ as a volunteer and at Acquia commented
Version: 9.4.x-dev » 10.0.x-dev

nod_ opened merge request !1919

nod_’s picture

nod_
Primary language French
Location Lille
CreditAttribution: nod_ as a volunteer and at Acquia commented
Status: Active » Needs review

It's not too bad, especially compared to the ckeditor 4 module file, which is already stable.

Wim Leers’s picture

Wim Leers
Location Ghent 🇧🇪🇪🇺
CreditAttribution: Wim Leers at Acquia commented

OMG is that it?! 😅🤣

I thought this was going to need much more work. I wonder if @lauriii had more in mind than this, but it seems what's needed… 🙈

lauriii’s picture

lauriii
he/him
Primary language Finnish
Location Finland
CreditAttribution: lauriii at Acquia commented
Status: Needs review » Reviewed & tested by the community

Thank you @nod_! ✨

  • catch committed f7f880f on 10.0.x 
    Issue #3248430 by nod_, Wim Leers, lauriii: Improve Drupal.ckeditor5...

  • catch committed 42b500c on 9.4.x 
    Issue #3248430 by nod_, Wim Leers, lauriii: Improve Drupal.ckeditor5...

  • catch committed bd7e90b on 9.3.x 
    Issue #3248430 by nod_, Wim Leers, lauriii: Improve Drupal.ckeditor5...
catch’s picture

catch
he/him
Primary language English
CreditAttribution: catch at Third and Grove commented
Version: 10.0.x-dev » 9.3.x-dev
Status: Reviewed & tested by the community » Fixed

Was expecting this patch to be bigger... just adding some missing phpdoc in JavaScript, what's added looks good.

Committed/pushed to 10.0.x and cherry-picked to 9.4.x and 9.3.x, thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.