guideConnection optimization

# Overview

A need for optimization may arise in documents that are being edited for a long time. The optimization consists of compressing operations sent during the editing process. This speeds up the document loading time in the rich text editor.

CKEditor 5 performs lots of calculations during the processing of operations. This affects the document loading time because the browser resources are limited. Compressing operations on connecting means that instead of processing thousands of operations, the editor only needs to process a few of them.

# Requirements

Follow the steps below to prepare your environment to use the connection optimization feature.

  1. Set the bundleVersion property in the editor configuration. See the Editor configuration section of the Editor bundle documentation for more details.

  2. Upload your editor bundle with the editor configuration to the CKEditor Cloud Services server. Refer to the Editor bundle guide for more information. Make sure that your editor configuration contains the required bundleVersion property mentioned in the point above.

  3. Log in to the CKEditor Ecosystem customer dashboard and navigate to “Your products > Cloud Services”.

  4. From the list of available subscriptions in the dashboard choose the subscription that you want to manage and press the “Manage” link.

Your products view in CKEditor Ecosystem customer dashboard.

  1. Select the environment where you want to enable the connection optimization feature.

Select the environment that you want to manage.

  1. Navigate to the “Feature configuration” tab.

Select the environment that you want to manage.

  1. Switch on the feature in the “Collaboration > Connection optimization” section.

Feature configuration with enabled compression.

Remember that the connection optimization feature works only for the environment where it was turned on. If you use many environments, you must enable it separately for each of them.

# Usage

After fulfilling the requirements above, the connection optimization feature will work automatically. CKEditor Cloud Services will compress the operations from time to time, lowering the document loading time for your users.

# Debugging

If needed, it is possible to store all collaboration data for debugging purposes. Thanks to this, our customer support team will be able to check the errors that occurred during the connection optimization.

When this option is enabled, the data will be stored only for debugging purposes. Please enable this option only when you are asked to do do by our customer support team.