From 82bc70e23789ab0a9dc176a6960ba1867d5c8e2b Mon Sep 17 00:00:00 2001 From: Bartek Biedrzycki Date: Thu, 28 Nov 2024 13:50:36 +0100 Subject: [PATCH 1/5] Docs: update to v44 guide. [short flow] --- docs/updating/update-to-44.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/updating/update-to-44.md diff --git a/docs/updating/update-to-44.md b/docs/updating/update-to-44.md new file mode 100644 index 00000000000..1ec65652040 --- /dev/null +++ b/docs/updating/update-to-44.md @@ -0,0 +1,25 @@ +--- +category: update-guides +meta-title: Update to version 43.x | CKEditor 5 Documentation +menu-title: Update to v43.x +order: 80 +modified_at: 2024-11-28 +--- + +# Update to CKEditor 5 v44.x + + + When updating your CKEditor 5 installation, ensure **all the packages are the same version** to avoid errors. + + You may try removing the `package-lock.json` or `yarn.lock` files (if applicable) and reinstalling all packages before rebuilding the editor. For best results, make sure you use the most recent package versions. + + +## Update to CKEditor 5 v44.0.0 + +_Released on December 2, 2024._ + +For the entire list of changes introduced in version 44.0.0, see the [release notes for CKEditor 5 v44.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v44.0.0). + +Below are the most important changes that require your attention when upgrading to CKEditor 5 v44.0.0. + +### First heading From 02a68e77433835912580cd841cb16721b20821b8 Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Thu, 28 Nov 2024 18:17:13 +0100 Subject: [PATCH 2/5] Edit update to v44. --- .../licensing/usage-based-billing.md | 2 +- docs/updating/update-to-44.md | 45 +++++++++++++++++-- 2 files changed, 43 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/licensing/usage-based-billing.md b/docs/getting-started/licensing/usage-based-billing.md index 7b04b9b3cdc..2bc9eaf00fc 100644 --- a/docs/getting-started/licensing/usage-based-billing.md +++ b/docs/getting-started/licensing/usage-based-billing.md @@ -94,6 +94,6 @@ We advise linking the email address associated with your plan to a group alias, ### Plan upgrades -If you are on the Essential plan and reach 5,000 editor loads, you will not be automatically upgraded to the Professional plan. Instead, you will be charged a standard charging rate for each additional block of 1,000 editor loads. To avoid these charges, regularly review your editor load count and consider upgrading your plan if needed. Plan upgrades are available anytime in the `Customer portal` → `Subscription management`. +If you are on the Essential plan and reach 5,000 editor loads, you will not be automatically upgraded to the Professional plan. Instead, you will be charged a standard charging rate for each additional block of 1,000 editor loads. To avoid these charges, regularly review your editor load count and consider upgrading your plan if needed. Plan upgrades are available anytime in the `Customer Portal` → `Subscription management`. For plan upgrades, we charge prorated value immediately to enable all needed features after the upgrade. diff --git a/docs/updating/update-to-44.md b/docs/updating/update-to-44.md index 1ec65652040..d4d240f871d 100644 --- a/docs/updating/update-to-44.md +++ b/docs/updating/update-to-44.md @@ -1,7 +1,7 @@ --- category: update-guides -meta-title: Update to version 43.x | CKEditor 5 Documentation -menu-title: Update to v43.x +meta-title: Update to version 44.x | CKEditor 5 Documentation +menu-title: Update to v44.x order: 80 modified_at: 2024-11-28 --- @@ -22,4 +22,43 @@ For the entire list of changes introduced in version 44.0.0, see the [release no Below are the most important changes that require your attention when upgrading to CKEditor 5 v44.0.0. -### First heading +### Required license key configuration + +Version 44.0.0 introduced a change in the license configuration. The `config.licenseKey` is now a required property in the editor configuration. Whether you are using CKEditor 5 commercially or under open-source terms, you will need to specify this property in your configuration. + +* **Commercial licenses**: For current users with a commercial license, you must retrieve your license key from the [Customer Portal](https://portal.ckeditor.com/) and add it to your editor configuration. [Format of the key has changed](#new license-key-format) +* **Open-Source installations**: If you are self-hosting CKEditor 5 under the GPL terms, you will need to set `config.licenseKey` to `'GPL'` in your configuration. +* **Cloud CDN setups**: If you are using cloud-distributed CKEditor 5 delivered via our CDN, you need a license key. You can create a [free account](https://portal.ckeditor.com/checkout?plan=free). All accounts are granted a 14-day trial for Premium Features (no credit card required). + +```js +ClassicEditor + .create( document.querySelector( '#editor' ), { + licenseKey: '' // Or 'GPL'. + + // ... Other configuration options ... + + } ) + .then( /* ... */ ) + .catch( /* ... */ ); +``` + +Read more in our guides about {@link getting-started/licensing/license-key-and-activation license keys} and {@link getting-started/licensing/usage-based-billing usage-based billing}. + +### New license key format + +A new license key format has been introduced. Previous license keys **will no longer work** after updating the editor to version 44.0.0 and above. + +Acquiring new keys: + +1. **Access the Customer Portal**: Log in to the [Customer Portal](https://portal.ckeditor.com/) to obtain your new license key. +2. **Update configuration**: Replace the old license key in your editor configuration with the new key. + +For more information or assistance, please refer to our {@link getting-started/licensing/license-key-and-activation documentation} or [contact our support team](https://ckeditor.com/contact/). + +### Self-service plans and new Customer Portal + +The new self-service plans make accessing CKEditor Premium Features easier than ever. You can now choose the plan that best suits your needs and get started quickly with commitment-free trials. + +Plans are managed through a new, dedicated [Customer Portal](https://portal.ckeditor.com/), where you can access license keys, track usage, manage billing, and submit support requests-all from one place. + +Learn more about the [different plans available](https://ckeditor.com/pricing/) or start your [14-day free trial](https://portal.ckeditor.com/checkout?plan=free). From a0103c62476e2babedb7ff13bbfc76be42485ca4 Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Thu, 28 Nov 2024 18:28:00 +0100 Subject: [PATCH 3/5] Update docs/updating/update-to-44.md --- docs/updating/update-to-44.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/updating/update-to-44.md b/docs/updating/update-to-44.md index d4d240f871d..4bba234ad3c 100644 --- a/docs/updating/update-to-44.md +++ b/docs/updating/update-to-44.md @@ -26,7 +26,7 @@ Below are the most important changes that require your attention when upgrading Version 44.0.0 introduced a change in the license configuration. The `config.licenseKey` is now a required property in the editor configuration. Whether you are using CKEditor 5 commercially or under open-source terms, you will need to specify this property in your configuration. -* **Commercial licenses**: For current users with a commercial license, you must retrieve your license key from the [Customer Portal](https://portal.ckeditor.com/) and add it to your editor configuration. [Format of the key has changed](#new license-key-format) +* **Commercial licenses**: For current users with a commercial license, you must retrieve your license key from the [Customer Portal](https://portal.ckeditor.com/) and add it to your editor configuration. [Format of the key has changed](#new-license-key-format) in this release. * **Open-Source installations**: If you are self-hosting CKEditor 5 under the GPL terms, you will need to set `config.licenseKey` to `'GPL'` in your configuration. * **Cloud CDN setups**: If you are using cloud-distributed CKEditor 5 delivered via our CDN, you need a license key. You can create a [free account](https://portal.ckeditor.com/checkout?plan=free). All accounts are granted a 14-day trial for Premium Features (no credit card required). From d1e6a4bac695b4fcf04cdf944bad2cd77e207e14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotrek=20Koszuli=C5=84ski?= Date: Thu, 28 Nov 2024 22:59:39 +0100 Subject: [PATCH 4/5] Improved various aspects of that guide. * I moved the code block for better readability. When after the list, it made things below invisible. * I added notion of UBB. * I elaborated a bit more regarding the 3 options. Especially about the CDN users. --- docs/updating/update-to-44.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/updating/update-to-44.md b/docs/updating/update-to-44.md index 4bba234ad3c..d1bb62d7f32 100644 --- a/docs/updating/update-to-44.md +++ b/docs/updating/update-to-44.md @@ -26,22 +26,25 @@ Below are the most important changes that require your attention when upgrading Version 44.0.0 introduced a change in the license configuration. The `config.licenseKey` is now a required property in the editor configuration. Whether you are using CKEditor 5 commercially or under open-source terms, you will need to specify this property in your configuration. -* **Commercial licenses**: For current users with a commercial license, you must retrieve your license key from the [Customer Portal](https://portal.ckeditor.com/) and add it to your editor configuration. [Format of the key has changed](#new-license-key-format) in this release. -* **Open-Source installations**: If you are self-hosting CKEditor 5 under the GPL terms, you will need to set `config.licenseKey` to `'GPL'` in your configuration. -* **Cloud CDN setups**: If you are using cloud-distributed CKEditor 5 delivered via our CDN, you need a license key. You can create a [free account](https://portal.ckeditor.com/checkout?plan=free). All accounts are granted a 14-day trial for Premium Features (no credit card required). - ```js ClassicEditor - .create( document.querySelector( '#editor' ), { - licenseKey: '' // Or 'GPL'. + .create( document.querySelector( '#editor' ), { + licenseKey: '' // Or 'GPL'. // ... Other configuration options ... - } ) + } ) .then( /* ... */ ) - .catch( /* ... */ ); + .catch( /* ... */ ); ``` +* **Commercial licenses**: When upgrading to version 44.0.0 or later, users with a commercial license must update their license key to the [new format](#new-license-key-format). To update your license key, log in to the [Customer Portal](https://portal.ckeditor.com/) and copy the key associated with your subscription into your editor's configuration. +* **Open-source installations**: + * **Self-hosted (npm/ZIP) installations**: If you are self-hosting CKEditor 5 under the {@link getting-started/licensing/license-and-legal GPL 2+ terms}, you need to set `config.licenseKey` to `'GPL'` in your configuration. + * **Cloud (CDN) installations**: For cloud-distributed CKEditor 5 served via [our CDN](https://cdn.ckeditor.com), you must obtain a license key from the Customer Portal. Create a [free account](https://portal.ckeditor.com/checkout?plan=free) and add the provided license key to your editor configuration. + + During the 14-day trial (automatically activated upon signup), you can explore all Premium Features. After the trial ends, usage metering and editor load limits specific to your chosen plan will apply. Learn more about [available plans](https://ckeditor.com/pricing/) and {@link getting-started/licensing/usage-based-billing usage-based billing}. + Read more in our guides about {@link getting-started/licensing/license-key-and-activation license keys} and {@link getting-started/licensing/usage-based-billing usage-based billing}. ### New license key format From b2dff0421f3184525673542c700b028e0411cd97 Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Fri, 29 Nov 2024 07:22:23 +0100 Subject: [PATCH 5/5] One more detail. --- docs/updating/update-to-44.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/updating/update-to-44.md b/docs/updating/update-to-44.md index d1bb62d7f32..ce480bd1023 100644 --- a/docs/updating/update-to-44.md +++ b/docs/updating/update-to-44.md @@ -40,7 +40,7 @@ ClassicEditor * **Commercial licenses**: When upgrading to version 44.0.0 or later, users with a commercial license must update their license key to the [new format](#new-license-key-format). To update your license key, log in to the [Customer Portal](https://portal.ckeditor.com/) and copy the key associated with your subscription into your editor's configuration. * **Open-source installations**: - * **Self-hosted (npm/ZIP) installations**: If you are self-hosting CKEditor 5 under the {@link getting-started/licensing/license-and-legal GPL 2+ terms}, you need to set `config.licenseKey` to `'GPL'` in your configuration. + * **Self-hosted (npm/ZIP) installations**: If you are self-hosting CKEditor 5 under the {@link getting-started/licensing/license-and-legal GPL 2+ terms} or as a part of our [Open Source support project](https://ckeditor.com/wysiwyg-editor-open-source/), you need to set `config.licenseKey` to `'GPL'` in your configuration. * **Cloud (CDN) installations**: For cloud-distributed CKEditor 5 served via [our CDN](https://cdn.ckeditor.com), you must obtain a license key from the Customer Portal. Create a [free account](https://portal.ckeditor.com/checkout?plan=free) and add the provided license key to your editor configuration. During the 14-day trial (automatically activated upon signup), you can explore all Premium Features. After the trial ends, usage metering and editor load limits specific to your chosen plan will apply. Learn more about [available plans](https://ckeditor.com/pricing/) and {@link getting-started/licensing/usage-based-billing usage-based billing}.