diff --git a/docs/content_management/rich_text/extend_online_editor.md b/docs/content_management/rich_text/extend_online_editor.md index d82fca3d06..c96e4eb409 100644 --- a/docs/content_management/rich_text/extend_online_editor.md +++ b/docs/content_management/rich_text/extend_online_editor.md @@ -383,13 +383,15 @@ For a full list of standard buttons, see the RichText module's [configuration fi Regular CKEditor plugins can be added to the Online Editor. This procedure is illustrated with the addition of the [Special characters plugin](https://ckeditor.com/docs/ckeditor5/latest/features/special-characters.html). -A CKEditor plugin is installed locally by using `yarn add ` or `npm install`, and is deployed by committing the `yarn.lock` file. +You can install a CKEditor plugin locally by using `yarn add ` or `npm install`, and deploy it by committing the `yarn.lock` file. A local installation looks like: ```bash -yarn add @ckeditor/ckeditor5-special-characters +yarn add @ckeditor/ckeditor5-special-characters@40.2.0 ``` +Make sure to specify a version range compatible with the CKEditor's version used in [[= product_name =]]. + The CKEditor plugin must be added to the `ibexa.richText.CKEditor.extraPlugins` array. For this purpose, create an `assets/js/richtext.ckeditor-plugins.js` to import the plugin elements and add them to the array using `ibexa.addConfig` : diff --git a/docs/update_and_migration/from_4.5/update_from_4.5.md b/docs/update_and_migration/from_4.5/update_from_4.5.md index 1f905506f3..b4b096f723 100644 --- a/docs/update_and_migration/from_4.5/update_from_4.5.md +++ b/docs/update_and_migration/from_4.5/update_from_4.5.md @@ -104,7 +104,7 @@ First, run: rm symfony.lock composer require ibexa/headless:[[= latest_tag_4_6 =]] --with-all-dependencies --no-scripts composer recipes:install ibexa/headless --force -v - # Bump CKEditor dependencies + # Update CKEditor dependencies yarn add @ckeditor/ckeditor5-alignment@^40.1.0 @ckeditor/ckeditor5-build-inline@^40.1.0 @ckeditor/ckeditor5-dev-utils@^39.0.0 @ckeditor/ckeditor5-widget@^40.1.0 @ckeditor/ckeditor5-theme-lark@^40.1.0 @ckeditor/ckeditor5-code-block@^40.1.0 ``` === "[[= product_name_exp =]]" @@ -112,7 +112,7 @@ First, run: ``` bash composer require ibexa/experience:[[= latest_tag_4_6 =]] --with-all-dependencies --no-scripts composer recipes:install ibexa/experience --force -v - # Bump CKEditor dependencies + # Update CKEditor dependencies yarn add @ckeditor/ckeditor5-alignment@^40.1.0 @ckeditor/ckeditor5-build-inline@^40.1.0 @ckeditor/ckeditor5-dev-utils@^39.0.0 @ckeditor/ckeditor5-widget@^40.1.0 @ckeditor/ckeditor5-theme-lark@^40.1.0 @ckeditor/ckeditor5-code-block@^40.1.0 ``` === "[[= product_name_com =]]" @@ -120,13 +120,15 @@ First, run: ``` bash composer require ibexa/commerce:[[= latest_tag_4_6 =]] --with-all-dependencies --no-scripts composer recipes:install ibexa/commerce --force -v - # Bump CKEditor dependencies + # Update CKEditor dependencies yarn add @ckeditor/ckeditor5-alignment@^40.1.0 @ckeditor/ckeditor5-build-inline@^40.1.0 @ckeditor/ckeditor5-dev-utils@^39.0.0 @ckeditor/ckeditor5-widget@^40.1.0 @ckeditor/ckeditor5-theme-lark@^40.1.0 @ckeditor/ckeditor5-code-block@^40.1.0 ``` The `recipes:install` command installs new YAML configuration files. Review the old YAML files and move your custom configuration to the relevant new files. +If you're using [custom CKEditor plugins](extend_online_editor.md#add-ckeditor-plugins), update them as well to use the same version range for all CKEditor dependencies. + ## Remove `node_modules` and `yarn.lock` Next, remove `node_modules` and `yarn.lock` before running `composer run post-update-cmd`,