Răsfoiți Sursa

Merge branch 'stable'

Piotrek Koszuliński 7 ani în urmă
părinte
comite
9567dadc4e

+ 2 - 3
docs/builds/guides/support/browser-compatibility.md

@@ -23,7 +23,6 @@ CKEditor 5 is currently supported in the following desktop browsers:
 	* Edge (latest stable release). Known issues:
 		* Minor issues with selection: [1](https://github.com/ckeditor/ckeditor5-engine/issues/974), [2](https://github.com/ckeditor/ckeditor5-engine/issues/928).
 		* The editor becomes unstable when F12 developer tools are enabled.
-		* Clipboard integration is broken due to [Edge bugs](https://github.com/ckeditor/ckeditor5-clipboard/issues/20).
 
 Not supported yet:
 
@@ -44,7 +43,7 @@ When working on mobile support we need to consider two complex aspects:
 
 * **Special UI, designed for mobile.**
 
-	During the design phase we understood that creating a responsive and touch-friendly UI will not guarantee a desired UX level by itself. Also, that the "mobile first" approach has no application in this case due to constraints of the mobile environment and specific editing method. Therefore, we plan to introduce a completely customized, mobile-oriented UI.
+	During the design phase we understood that creating a responsive and touch-friendly UI will not guarantee a desired UX level by itself. Also, that the "mobile first" approach has no application in this case due to constraints of the mobile environment and the specific editing method. Therefore, we plan to introduce a completely customized, mobile-oriented UI.
 
 	We began research on how to display necessary UI controls on the screen and, sadly, it turned out that mobile Safari's viewport mechanics makes it extremely complicated to display the UI in a reliable way. You can read more in the [UX: Mobile editing](https://github.com/ckeditor/ckeditor5-design/issues/149) ticket.
 
@@ -56,6 +55,6 @@ When working on mobile support we need to consider two complex aspects:
 
 ## Quality assurance
 
-To ensure the highest quality, we maintain a complete test suite with a stable 100% of code coverage for each of the packages. As of December 2017, this means over 7000 tests and the number is growing.
+To ensure the highest quality, we maintain a complete test suite with a stable 100% of code coverage for each of the packages. As of April 2018, this means over 8200 tests and the number is growing.
 
 Such an extensive test suite requires a proper continuous integration service. We use [Travis CI](https://travis-ci.com/) as a build platform and [BrowserStack](https://www.browserstack.com/) to be able to run tests on all browsers. These services ensure seamless and fast developer experience and allow us to focus on the job.

+ 3 - 3
docs/builds/guides/support/getting-support.md

@@ -10,7 +10,7 @@ menu-title: Getting support
 
 You can report issues and feature requests on [GitHub](https://github.com/ckeditor/ckeditor5). This is also a good place to discuss architecture decisions and things which are not yet covered by the documentation.
 
-[Each CKEditor 5 repository](https://github.com/ckeditor?utf8=%E2%9C%93&q=ckeditor5&type=&language=) handles its issues independently. Unless you are sure where your ticket belongs, it is best to report it in the [main repository](https://github.com/ckeditor/ckeditor5).
+[Each CKEditor 5 repository](https://github.com/ckeditor?utf8=%E2%9C%93&q=ckeditor5&type=&language=) handles its issues independently. If you are not sure where your ticket belongs, it is best to report it in the [main repository](https://github.com/ckeditor/ckeditor5).
 
 Refer to {@link builds/guides/support/reporting-issues Reporting issues} guide for more details.
 
@@ -22,7 +22,7 @@ Make sure to tag your questions with ["ckeditor"](https://stackoverflow.com/ques
 
 ## Gitter
 
-[CKEditor 5 Gitter channel](https://gitter.im/ckeditor/ckeditor5) is the place where you can discuss all matters which do not fit GitHub and Stack Overflow.
+[CKEditor 5 Gitter channel](https://gitter.im/ckeditor/ckeditor5) is the place where you can discuss all matters that do not fit GitHub or Stack Overflow.
 
 Gitter is convenient for asking quick questions, however, it is not the best place for more complex topics which might interest other developers (Gitter logs are indexed via Google but rather poorly). Therefore, try to avoid lengthy discussions on topics which would make sense to be reported either on GitHub or Stack Overflow.
 
@@ -38,7 +38,7 @@ DON'Ts:
 * How to extend the selection to the end of the block?
 * Could you implement support for XYZ?
 * I can't make X and Y work together in my app. I developed this plugin and...
-* The editor crashes if I press Enter. Please help.
+* The editor crashes if I press <kbd>Enter</kbd>. Please help.
 
 And most importantly, be kind to everyone.
 

+ 1 - 1
docs/builds/guides/support/license-and-legal.md

@@ -8,7 +8,7 @@ order: 20
 
 # License and legal
 
-The following legal notices apply to CKEditor 5 Builds and all software from the CKEditor 5 Ecosystem included with it.
+The following legal notices apply to CKEditor 5 Builds and all software from CKEditor 5 Ecosystem included with it.
 
 Copyright (c) 2003-2018, CKSource Frederico Knabben. All rights reserved.
 

+ 1 - 1
docs/builds/guides/support/reporting-issues.md

@@ -10,7 +10,7 @@ order: 40
 
 # Reporting issues
 
-If you feel you found an issue in CKEditor 5, we will be grateful for letting us know. Before you create a bug report, however, please read our guidelines on how to do it properly and most efficiently.
+If you feel you found an issue in CKEditor 5, we will be grateful for letting us know. Before you create a bug report, please read the guidelines on how to do it properly and most efficiently.
 
 ## Reproduce on official examples
 

+ 1 - 51
docs/framework/guides/support/browser-compatibility.md

@@ -8,54 +8,4 @@ category: framework-support
 order: 10
 ---
 
-# Browser compatibility
-
-## Desktop environment
-
-CKEditor 5 is currently supported in the following desktop browsers:
-
-* Full support (see [notes below](#notes)):
-	* Chrome (latest stable release).
-	* Firefox (latest stable release).
-	* Safari (latest stable release).
-	* Opera (latest stable release).
-* Good support:
-	* Edge (latest stable release). Known issues:
-		* Minor issues with selection: [1](https://github.com/ckeditor/ckeditor5-engine/issues/974), [2](https://github.com/ckeditor/ckeditor5-engine/issues/928).
-		* The editor becomes unstable when F12 developer tools are enabled.
-		* Clipboard integration is broken due to [Edge bugs](https://github.com/ckeditor/ckeditor5-clipboard/issues/20).
-
-Not supported yet:
-
-* Internet Explorer 11. See the [Compatibility with IE11](https://github.com/ckeditor/ckeditor5/issues/330) ticket.
-
-### Notes
-
-Features known to not be fully supported yet:
-
-* Text composition. Input Method Engine (IME) is a mechanism that allows the users to input text in languages such as Japanese and Chinese. This mechanism is not fully supported yet and we will be polishing that feature in a close future.
-* Drag and drop inside the editor does not work yet. It is possible to drop images from your system if the {@link module:image/imageupload~ImageUpload} feature is enabled.
-
-## Mobile environment
-
-Although CKEditor 5 works in Safari for iOS and Chrome for Android, it has not been fully tested yet and there are known bugs and inconveniences. Full support for mobile browsers will be our goal after releasing 1.0.0.
-
-When working on mobile support we need to consider two complex aspects:
-
-* **Special UI, designed for mobile.**
-
-	During the design phase we understood that creating a responsive and touch-friendly UI will not guarantee a desired UX level by itself. Also, that the "mobile first" approach has no application in this case due to constraints of the mobile environment and specific editing method. Therefore, we plan to introduce a completely customized, mobile-oriented UI.
-
-	We began research on how to display necessary UI controls on the screen and, sadly, it turned out that mobile Safari's viewport mechanics makes it extremely complicated to display the UI in a reliable way. You can read more in the [UX: Mobile editing](https://github.com/ckeditor/ckeditor5-design/issues/149) ticket.
-
-* **Handling mobile browsers' quirks.**
-
-	Mobile browsers (especially mobile Safari) work differently than their desktop equivalents. [Chrome's incomplete `keydown` event](https://bugs.chromium.org/p/chromium/issues/detail?id=118639) is just one of the issues that we need to deal with.
-
-	For several years we have worked with W3C on [fixing `contentEditable`](https://medium.com/content-uneditable/fixing-contenteditable-1a9a5073c35d) &mdash; a technology on which the entire browser-based editing is based. Recently, browser vendors started implementing the core part of [the new specifications](http://w3c.github.io/editing/) &mdash; the `beforeinput` event which has a chance to improve the situation. CKEditor 5's architecture was designed with this event in mind, so we will start taking advantage of it as soon as it proves to be stable enough.
-
-## Quality assurance
-
-To ensure the highest quality, we maintain a complete test suite with a stable 100% of code coverage for each of the packages. As of December 2017, this means over 7000 tests and the number is growing.
-
-Such an extensive test suite requires a proper continuous integration service. We use [Travis CI](https://travis-ci.com/) as a build platform and [BrowserStack](https://www.browserstack.com/) to be able to run tests on all browsers. These services ensure seamless and fast developer experience and allow us to focus on the job.
+{@importguide builds/guides/support/browser-compatibility}

+ 1 - 43
docs/framework/guides/support/getting-support.md

@@ -4,46 +4,4 @@ order: 30
 menu-title: Getting support
 ---
 
-# Getting support
-
-## GitHub
-
-You can report issues and feature requests on [GitHub](https://github.com/ckeditor/ckeditor5). This is also a good place to discuss architecture decisions and things which are not yet covered by the documentation.
-
-[Each CKEditor 5 repository](https://github.com/ckeditor?utf8=%E2%9C%93&q=ckeditor5&type=&language=) handles its issues independently. Unless you are sure where your ticket belongs, it is best to report it in the [main repository](https://github.com/ckeditor/ckeditor5).
-
-Refer to {@link framework/guides/support/reporting-issues Reporting issues} guide for more details.
-
-## Stack Overflow
-
-[Stack Overflow](https://stackoverflow.com) is the best place for developers to share their problems and solutions.
-
-Make sure to tag your questions with ["ckeditor"](https://stackoverflow.com/questions/tagged/ckeditor) and ["ckeditor5"](https://stackoverflow.com/questions/tagged/ckeditor5) to reach the widest audience.
-
-## Gitter
-
-[CKEditor 5 Gitter channel](https://gitter.im/ckeditor/ckeditor5) is the place where you can discuss all matters which do not fit GitHub and Stack Overflow.
-
-Gitter is convenient for asking quick questions, however, it is not the best place for more complex topics which might interest other developers (Gitter logs are indexed via Google but rather poorly). Therefore, try to avoid lengthy discussions on topics which would make sense to be reported either on GitHub or Stack Overflow.
-
-DOs:
-
-* Is it a known bug that "..."?
-* Do you plan to tag the new release this week?
-* I can't find XYZ's documentation. Is it available somewhere?
-* I'm in Warsaw. Anyone for a coffee?
-
-DON'Ts:
-
-* How to extend the selection to the end of the block?
-* Could you implement support for XYZ?
-* I can't make X and Y work together in my app. I developed this plugin and...
-* The editor crashes if I press Enter. Please help.
-
-And most importantly, be kind to everyone.
-
-## Commercial support
-
-CKEditor 5 also comes with commercial licensing benefits, such as direct support from the core CKEditor development team. Commercial licenses are designed with professionals and enterprises in mind.
-
-For more information, check the [CKEditor 5 Pricing page](https://ckeditor.com/ckeditor-5-builds/pricing/).
+{@importguide builds/guides/support/getting-support}

+ 1 - 1
docs/framework/guides/support/license-and-legal.md

@@ -8,7 +8,7 @@ order: 20
 
 # License and legal
 
-The following legal notices apply to CKEditor 5 Framework and all software from the CKEditor 5 Ecosystem included with it.
+The following legal notices apply to CKEditor 5 Framework and all software from CKEditor 5 Ecosystem included with it.
 
 Copyright (c) 2003-2018, CKSource Frederico Knabben. All rights reserved.
 

+ 1 - 19
docs/framework/guides/support/reporting-issues.md

@@ -8,22 +8,4 @@ category: framework-support
 order: 40
 ---
 
-# Reporting issues
-
-If you feel you found an issue in CKEditor 5, we will be grateful for letting us know. Before you create a bug report, however, please read our guidelines on how to do it properly and most efficiently.
-
-## Reproduce on official examples
-
-To eliminate the chance that the issue might be caused by some third-party software or your customizations, try to reproduce the issue on the {@link examples/index official examples} first.
-
-The examples are always running the latest editor version. Please note that if the problem was fixed in one of the releases that succeeded the version you are using, you will need to upgrade your CKEditor 5 installation as we do not backport fixes.
-
-Most of the issues are reproducible on the demo. If you have a different case though, no problem. Go ahead with the next steps.
-
-## Reporting issues
-
-All issues should be reported in the [CKEditor 5 repositories](https://github.com/ckeditor?q=ckeditor5) on GitHub.
-
-Issues related to builds are usually caused by issues in the CKEditor 5 Framework components and plugins included in the build. You may report issues directly into the repositories that you think are related to them (like plugins) but, if you are unsure, the [`ckeditor5` issues page](https://github.com/ckeditor/ckeditor5/issues) should be used as the fallback place for any issue. The CKEditor 5 team will then move the issue to the right place or give you further instructions, if necessary.
-
-Issues with third-party plugins should be reported directly to their developers.
+{@importguide builds/guides/support/reporting-issues}