diff --git a/docs/assets/img/ckeditor-dashboard.png b/docs/assets/img/ckeditor-dashboard.png new file mode 100644 index 000000000..4e9f82904 Binary files /dev/null and b/docs/assets/img/ckeditor-dashboard.png differ diff --git a/docs/assets/img/ckeditor-key.png b/docs/assets/img/ckeditor-key.png new file mode 100644 index 000000000..7f3f017b8 Binary files /dev/null and b/docs/assets/img/ckeditor-key.png differ diff --git a/docs/guide/dev/a11y/README.md b/docs/guide/dev/a11y/README.md index a5c3ea4d1..5047aafe9 100644 --- a/docs/guide/dev/a11y/README.md +++ b/docs/guide/dev/a11y/README.md @@ -1,5 +1,5 @@ --- -category: compatibility-compliance-license +category: accessibility order: 40 url: guide/dev_a11y menu-title: Accessibility Support diff --git a/docs/guide/dev/browsers/README.md b/docs/guide/dev/browsers/README.md index 401bb3c31..2cabfa600 100644 --- a/docs/guide/dev/browsers/README.md +++ b/docs/guide/dev/browsers/README.md @@ -1,5 +1,5 @@ --- -category: compatibility-compliance-license +category: support order: 20 url: guide/dev_browsers menu-title: Browser Compatibility diff --git a/docs/guide/dev/howtos/bugs_and_features/README.md b/docs/guide/dev/howtos/bugs_and_features/README.md deleted file mode 100644 index 78e4ae027..000000000 --- a/docs/guide/dev/howtos/bugs_and_features/README.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -category: howtos -order: 200 -url: guide/dev_howtos_bugs_and_features -menu-title: Bugs and New Features -meta-title-short: Bugs and New Features ---- - - -# Bugs and New Features - -The following article contains tips about reporting CKEditor 4 issues and proposing new features. - -## How Do I Report CKEditor 4 Bugs? - -The {@link guide/dev/issues_readme/README Reporting Issues} article contains all the information about reporting CKEditor 4 issues. - -## How Do I Request New CKEditor 4 Features? - -If you feel there is an interesting feature missing in CKEditor 4, go to our [GitHub issues page](https://github.com/ckeditor/ckeditor4/issues) and file a new issue. - -Please make sure you read the {@link guide/dev/issues_tracker/README Issues Tracker Site} article beforehand in order to make it easier for the developers to examine the issue. It is also recommended to start from a search at the [CKEditor Add-ons Repository](https://ckeditor.com/cke4/addons/plugins/all) to see whether the proposed functionality has not been implemented yet and offered as a plugin, either an official one or a community-provided add-on. - -When submitting a new ticket, feel free to attach your code suggestions or patches that can serve as a prototype for the requested feature. - -You are also most welcome to propose code changes with pull requests submitted to the official [ckeditor4](https://github.com/ckeditor/ckeditor4/pulls) repository. Do note that your code should meet some minimum requirements for code style or included tests, so please refer to the {@link guide/dev/contributing_code/README Contributing Code} article for more information. diff --git a/docs/guide/dev/howtos/support/README.md b/docs/guide/dev/howtos/support/README.md deleted file mode 100644 index 4a0081da0..000000000 --- a/docs/guide/dev/howtos/support/README.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -category: howtos -order: 40 -url: guide/dev_howtos_support -menu-title: Support -meta-title-short: Support ---- - - -# Licensing and Support - -The following article contains tips about the resources that you can refer to when you need some help with CKEditor 4. - -## Long Term Support (LTS) - -CKEditor 4 is a stable and mature application, backed by 20 years of our experience working on WYSIWYG editors. The CKEditor 4.x line is under a "Long Term Support" (LTS) programme which means that its development and support is guaranteed until 2023. If you are looking for a proven solution that will be fully supported for years, consider CKEditor 5. - -## How Do I Get Support? - -If you are having trouble installing, configuring, or integrating CKEditor 4 to your application, there are a few solutions that you can try. - -### Documentation - -First of all, CKEditor 4 comes with really extensive {@link guide/index documentation} that you should read and {@linkexample index plenty of samples} that you can try out and even download to copy and implement in your own environment. - -### Stack Overflow - -The ["ckeditor"](http://stackoverflow.com/questions/tagged/ckeditor) and ["ckeditor4.x"](http://stackoverflow.com/questions/tagged/ckeditor4.x) tags at Stack Overflow are where CKEditor developers and integrators can share their problems and solutions. CKEditor 4 has grown as an Open Source product, thanks to the amazing community of developers and users. The `ckeditor` and `ckeditor4.x` tags at Stack Overflow work in an Open Source way, too, so you are encouraged to not only ask questions, but also answer them and help fellow developers. It will be much appreciated! - -### Professional Support Channel - -There are times and situations, however, when you are unable to get going by yourself. If this is a case, you will be happy to know that you can [purchase a commercial CKEditor license](https://ckeditor.com/ckeditor-4/pricing/) which includes professional assistance directly from CKEditor 4 core developers. The dedicated support channel is available for you and responses to your inquiries come in one business day, or even in the same day. [CKSource](https://cksource.com/), the company behind CKEditor, also offers some Enterprise solutions such as Assistance Package and Custom Development for more advanced needs. [Contact us for more information](https://ckeditor.com/contact/)! - -## How Do I Support the Development of CKEditor 4? - -CKEditor 4 is and has always been an Open Source product. We are proud to be a part of the [Open Source](http://en.wikipedia.org/wiki/Open_source) movement and are happy that we can offer the result of long hours of work and dedicated contribution **completely for free** to everyone who wants to use the editor. - -If you also want to support the development of CKEditor, it will be most welcome. Here are a couple of things that you can do: - -* {@link guide/dev/issues_readme/README Report bugs} or feature requests on our [GitHub issues page](https://github.com/ckeditor/ckeditor4/issues). - -* {@link guide/dev/contributing_code/README Submit code patches} through pull requests in the [official CKEditor repository](https://github.com/ckeditor/ckeditor4). - -* Help [localize CKEditor](http://docs.cksource.com/CKEditor_3.x/Developers_Guide/Localization) into your native language and update existing localizations by joining us at the [CKEditor UI Translation Center](https://www.transifex.com/ckeditor/ckeditor/). - -* Create CKEditor plugins with new functionality and publish them in the [CKEditor Add-Ons Repository](https://ckeditor.com/cke4/addons/plugins/all). - -* Join Stack Overflow and share your knowledge with fellow CKEditor users and developers using the ["ckeditor"](http://stackoverflow.com/questions/tagged/ckeditor) and ["ckeditor4.x"](http://stackoverflow.com/questions/tagged/ckeditor4.x) tags. - -* Buy a [commercial CKEditor license](https://ckeditor.com/ckeditor-4/pricing/). This will not only let you support the development of new editor features, but it will also give you access to a dedicated support channel where core CKEditor developers are available to help you solve any issues you might have. - -**Thank you for your support and for helping us make CKEditor better every day!** - - -## How Does a Commercial CKEditor 4 License Work? - -[Contact us directly](https://ckeditor.com/contact/) if you want to learn more about our Enterprise offer or if you are interested in services such as custom development. diff --git a/docs/guide/dev/license/README.md b/docs/guide/dev/license/README.md deleted file mode 100644 index 6c983f980..000000000 --- a/docs/guide/dev/license/README.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -category: compatibility-compliance-license -order: 100 -url: guide/dev_license -menu-title: License -meta-title-short: License ---- - - -# License - -## CKEditor 4 Open Source Licenses - -CKEditor 4 is distributed under the [GPL](http://www.gnu.org/licenses/gpl.html), [LGPL](http://www.gnu.org/licenses/lgpl.html) and [MPL](http://www.mozilla.org/MPL/1.1/) Open Source licenses. This triple copyleft licensing model is flexible and allows you to choose the license that is best suited for your needs. - -### Why Choose CKEditor Open Source? - -Because CKEditor 4 has an active community that openly develops and shares add-ons, which you are welcome to take part in. Open Source applications are totally free! They do not include adware or limited trial periods, and can be used in commercial projects. - -If you are wondering whether you can use CKEditor 4 under an Open Source license in your project, check the appropriate [FAQ](https://ckeditor.com/ckeditor-4/support//faq/open%20source) section. - -## Commercial License - -**CKEditor 4 Premium** is a commercial option that brings additional licensing benefits. It is designed with professionals and enterprises in mind. Apart from a closed-source license it also offers support from the core CKEditor development team. - -For more information, check the [CKEditor Premium website](http://cksource.com/ckeditor). diff --git a/docs/guide/dev/section508/README.md b/docs/guide/dev/section508/README.md index 2d7fdeb22..1159298c3 100644 --- a/docs/guide/dev/section508/README.md +++ b/docs/guide/dev/section508/README.md @@ -1,5 +1,5 @@ --- -category: compatibility-compliance-license +category: accessibility order: 60 url: guide/dev_section508 menu-title: Section 508 Compliance diff --git a/docs/guide/dev/upgrade/README.md b/docs/guide/dev/upgrade/README.md index d51ae6f7c..e90be0575 100644 --- a/docs/guide/dev/upgrade/README.md +++ b/docs/guide/dev/upgrade/README.md @@ -14,10 +14,6 @@ For licensing, see LICENSE.md. This article describes the steps you need to take when you want to upgrade your CKEditor 4.x installation to the latest version. - - The latest CKEditor is always the greatest CKEditor. New releases add cool new features, support for the latest browser versions, and bug fixes. The changelog is published here and you can also learn about new releases by following our blog, Facebook, Google+, or Twitter pages. - - To upgrade CKEditor, proceed as follows: 1. **Rename** your existing editor folder to a backup folder, for example `ckeditor_old`. diff --git a/docs/guide/dev/wcag/README.md b/docs/guide/dev/wcag/README.md index 1a612a92b..958110c3b 100644 --- a/docs/guide/dev/wcag/README.md +++ b/docs/guide/dev/wcag/README.md @@ -1,5 +1,5 @@ --- -category: compatibility-compliance-license +category: accessibility order: 80 url: guide/dev_wcag menu-title: WCAG 2.0 Compliance diff --git a/docs/index.md b/docs/index.md index e70a3d948..2ff629658 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,7 @@ meta-description: Learn how to install, integrate, configure and develop CKEdito # CKEditor 4 Documentation - CKEditor 4 reached its End of Life (EOL) in June 2023. From then on, it will receive no more updates, new features, bug fixes, and most importantly, security patches. + CKEditor 4 reached its End of Life (EOL) in June 2023. From then on, it will receive no more updates, new features, bug fixes, and most importantly – no security patches. Please refer to the [Migration from CKEditor 4](https://ckeditor.com/docs/ckeditor5/latest/updating/ckeditor4/migration-from-ckeditor-4.html) guide to learn what steps you should take to switch to CKEditor 5. diff --git a/docs/support/extended-support-model.md b/docs/support/extended-support-model.md new file mode 100644 index 000000000..18f1e0fcc --- /dev/null +++ b/docs/support/extended-support-model.md @@ -0,0 +1,32 @@ +--- +category: licensing +order: 10 +menu-title: Extended Support Model +meta-title: CKEditor 4 Extended Support model +--- + +# Extended Support Model + +## Commercial support + +CKEditor 4 was launched in 2012 and reached its End of Life (EOL) on June 30, 2023. + +A special edition, **[CKEditor 4 LTS](https://ckeditor.com/ckeditor-4-support/)** ("Long Term Support"), is available under commercial terms (["Extended Support Model"](https://ckeditor.com/ckeditor-4-support/)) for anyone looking to **extend the coverage of security updates and critical bug fixes**. + +This limited-time-only package guarantees that your editor remains secure, with uninterrupted access to all functionality until December 2026. + +* Security Vulnerability Assurance (standard inclusion) + +Ensures security fixes are provided for any CKEditor 4 bugs which threaten the security of your application. + +* Third-party API Changes Assurance (optional extra) + +CKSource resolves any critical/high-severity issues in CKEditor 4 caused by changes in third-party apps (e.g. browser, MS Word) that CKEditor 4 depends on for its functionality (time limitations apply). + +* Standard Support (optional extra) + +Access the CKSource Customer Support team for ongoing support requests as per your standard contract terms. + +## Purchasing a license + +If you wish to purchase a commercial CKEditor 4 LTS license, [contact us](https://ckeditor.com/contact/?sales=true#contact-form) to receive an offer tailored to your needs. diff --git a/docs/support/index.md b/docs/support/index.md new file mode 100644 index 000000000..0e93ddf46 --- /dev/null +++ b/docs/support/index.md @@ -0,0 +1,31 @@ +--- +category: support +order: 10 +toc: false +meta-title: CKEditor 4 support documentation +meta-description: Learn how to get help and support +--- + +# Getting support + +The following article contains tips about the resources that you can refer to when you need some help with CKEditor 4. + +## Extended Support Model + +**CKEditor 4 reached its End of Life (EOL) in June 2023**. From then on, it will receive no more updates, new features, bug fixes, and most importantly, security patches. + +Please refer to the [Migration from CKEditor 4](https://ckeditor.com/docs/ckeditor5/latest/updating/ckeditor4/migration-from-ckeditor-4.html) guide to learn what steps you should take to switch to CKEditor 5. + +If you have an active CKEditor 4 subscription and need help, you can contact [our support team](https://ckeditor.com/contact/). If you are not ready to migrate yet, for a limited time we are offering a paid [Extended Support Model](https://ckeditor.com/ckeditor-4-support/) that will protect you against security vulnerabilities and/or breaking third-party API changes. + +## Commercial support + +If you have an active commercial license, like Extended Support Model, please [contact us directly](https://ckeditor.com/contact/). + +## Documentation + +CKEditor 4 comes with really extensive {@link guide/index documentation} that you should read and {@linkexample index plenty of samples} that you can try out and even download to copy and implement in your own environment. + +## Stack Overflow + +The ["ckeditor"](http://stackoverflow.com/questions/tagged/ckeditor) and ["ckeditor4.x"](http://stackoverflow.com/questions/tagged/ckeditor4.x) tags at Stack Overflow are where CKEditor developers and integrators can share their problems and solutions. CKEditor 4 has grown as an Open Source product, thanks to the amazing community of developers and users. The `ckeditor` and `ckeditor4.x` tags at Stack Overflow work in an Open Source way, too, so you are encouraged to not only ask questions but also answer them and help fellow developers. It will be much appreciated! diff --git a/docs/support/license-and-legal.md b/docs/support/license-and-legal.md new file mode 100644 index 000000000..253b228ef --- /dev/null +++ b/docs/support/license-and-legal.md @@ -0,0 +1,35 @@ +--- +category: licensing +order: 20 +menu-title: License and legal +--- + +# License and legal + +The following legal notices apply to CKEditor 4 and all software from CKEditor 5 Ecosystem included with it. + +Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved. + +## Software License Agreement for CKEditor 4 LTS (4.23.0 and above) + +CKEditor 4 LTS ("Long Term Support") is available under exclusive terms of the [Extended Support Model](https://ckeditor.com/ckeditor-4-support/). [Contact us](https://ckeditor.com/contact/) to obtain a commercial license. + +## Free for Open Source (CKEditor 4.22.* and below) + +Licensed under the terms of any of the following licenses at your choice: + +* GNU General Public License Version 2 or later (the "GPL") https://www.gnu.org/licenses/gpl.html (See Appendix A) + +* GNU Lesser General Public License Version 2.1 or later (the "LGPL") https://www.gnu.org/licenses/lgpl.html (See Appendix B) + +* Mozilla Public License Version 1.1 or later (the "MPL") https://www.mozilla.org/MPL/MPL-1.1.html (See Appendix C) + +You are not required to, but if you want to explicitly declare the license you have chosen to be bound to when using, reproducing, modifying, and distributing this software, just include a text file titled "legal.txt" in your version of this software, indicating your license choice. In any case, your choice will not restrict any recipient of your version of this software to use, reproduce, modify, and distribute this software under any of the above licenses. + +## Sources of intellectual property included in CKEditor + +Where not otherwise indicated, all CKEditor 4 content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission. + +## Trademarks + +CKEditor is a trademark of [CKSource Holding sp. z o.o.](http://cksource.com/) All other brand and product names are trademarks, registered trademarks, or service marks of their respective holders. diff --git a/docs/support/license-key-and-activation.md b/docs/support/license-key-and-activation.md new file mode 100644 index 000000000..490cc410b --- /dev/null +++ b/docs/support/license-key-and-activation.md @@ -0,0 +1,46 @@ +--- +category: licensing +order: 30 +menu-title: License key and activation +--- + +# License key and activation + +This article explains how to activate a license of CKEditor 4 LTS ("Long Term Support") under commercial terms (["Extended Support Model"](https://ckeditor.com/ckeditor-4-support/)). + +## Purchasing a commercial license + +To activate CKEditor 4 LTS ("Long Term Support"), you will need a paid [Extended Support Model](https://ckeditor.com/ckeditor-4-support/) that will protect you against security vulnerabilities and/or breaking third-party API changes. + +If you wish to purchase a commercial CKEditor 4 LTS license, [contact us](https://ckeditor.com/contact/?sales=true#contact-form) to receive an offer tailored to your needs. + +## Obtaining a license key + +Follow this guide to get the license key necessary to activate the CKEditor 4 LTS ("Long Term Support") version, guaranteeing that your editor remains secure. + +### Log in to the CKEditor Ecosystem dashboard + +Log in to the [CKEditor Ecosystem dashboard](https://dashboard.ckeditor.com). If this is the very first time you do it, you will receive a confirmation email and will be asked to create a password for your account. Keep it safe. + +### Access the account dashboard + +After logging in, click "CKEditor" under the "Your products" header on the left. You will see the overview of the subscription parameters together with the management area below. + +{@img assets/img/ckeditor-dashboard.png 832 Your CKEditor subscriptions in the customer dashboard.} + +### Copy the license key + +After clicking "Manage", you can access the license key needed to run the editor under the LTS version. + +{@img assets/img/ckeditor-key.png 797 License key in the management console.} + +## Activating the product + +You need to add the license key to your CKEditor 4 configuration. + +```js +CKEDITOR.replace( 'editor', { + // Provide the activation key. + licenseKey: 'your-license-key', +} ); +``` diff --git a/umberto.json b/umberto.json index 97fa560a9..8f8730a08 100644 --- a/umberto.json +++ b/umberto.json @@ -142,9 +142,9 @@ "order": 60 }, { - "name": "Compatibility, Compliance, License", - "id": "compatibility-compliance-license", - "slug": "compatibility-compliance-license", + "name": "Accessibility", + "id": "accessibility", + "slug": "accessibility", "order": 70 }, { @@ -446,6 +446,20 @@ } ] }, + { + "name": "Support", + "id": "support", + "navigationIncludeIndex": true, + "slug": "support", + "categories": [ + { + "name": "Licensing and activation", + "id": "licensing", + "slug": "licensing", + "order": 20 + } + ] + }, { "name": "API", "id": "api-reference", @@ -511,6 +525,9 @@ "guide/dev_react_v1.html": "guide/dev_react_deprecated.html", "guide/dev_react_v2.html": "guide/dev_react_current.html", "guide/dev_spreadsheets.html": "features/table.html", + "guide/dev_howtos_support.html": "support/index.html", + "guide/dev_license.html": "support/licensing/license-and-legal.html", + "guide/dev_howtos_bugs_and_features.html": "support/licensing/extended-support-model.html", "features/spreadsheets.html": "features/table.html", "examples/spreadsheets.html": "examples/table.html", "features.html": "features/index.html",