Explorar o código

Docs: Minor corrections to Migration, Compatibility and Reporting Issues guides. [skip ci]

Anna Tomanek %!s(int64=8) %!d(string=hai) anos
pai
achega
97235f007a

+ 14 - 9
docs/builds/guides/browser-compatibility.md

@@ -1,4 +1,9 @@
 ---
+# Scope:
+# * Explain browser compatibility of CKEditor 5.
+# * Document known compatibility issues and missing features.
+# * Discuss support for mobile environments.
+
 category: builds-guides
 order: 310
 ---
@@ -17,22 +22,22 @@ CKEditor 5 is currently supported on the following desktop browsers:
 * 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 tools are enabled.
+		* The editor becomes unstable when F12 developer tools are enabled.
 
-Not yet supported:
+Not supported yet:
 
-* Internet Explorer 11 is not yet supported. See the [Compatibility with IE11](https://github.com/ckeditor/ckeditor5/issues/330) ticket.
+* 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 (IME) – Input Method Engine is a mechanism which allows inputting text in languages such as Japanese and Chinese. It's so called "text composition". This mechanism is not yet fully supported and we'll be polishing that feature after 1.0.0.
-* Drag and drop inside editor doesn't work yet. It is possible to drop images from your system if the {@link module:upload/imageupload~ImageUpload} feature is enabled.
+* 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 after 1.0.0.
+* Drag and drop inside the editor does not work yet. It is possible to drop images from your system if the {@link module:upload/imageupload~ImageUpload} feature is enabled.
 
 ## Mobile environment
 
-Although CKEditor 5 works on 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.
+Although CKEditor 5 works on 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:
 
@@ -40,10 +45,10 @@ When working on mobile support we need to consider two complex aspects:
 
 	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 begun 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.
+	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 issues with which we need to deal with.
+	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've worked with W3C on [fixing contentEditable](https://medium.com/content-uneditable/fixing-contenteditable-1a9a5073c35d) – 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/)  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.
+	For several years we have worked with W3C on [fixing `contentEditable`](https://medium.com/content-uneditable/fixing-contenteditable-1a9a5073c35d) — 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/) — 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.

+ 11 - 11
docs/builds/guides/migrate.md

@@ -10,23 +10,23 @@ order: 260
 
 # Migration from CKEditor 4
 
-When compared to its previous versions, CKEditor 5 should be considered **a totally new editor**. Every single aspect of it was redesigned, from installation, to integration, to features, to its data model, and finally to its API. Therefore, moving applications using a previous version to version 5 cannot be simply called an "upgrade". It is something bigger, so the "migration" term fits better.
+When compared to its predecessor, CKEditor 5 should be considered **a totally new editor**. Every single aspect of it was redesigned — from installation, to integration, to features, to its data model, and finally to its API. Therefore, moving applications using a previous CKEditor version to version 5 cannot be simply called an "upgrade". It is something bigger, so the "migration" term fits better.
 
 There is no "drop in" solution for migrating. In this guide we hope to summarize the most important aspects to be taken into consideration before you proceed with installing CKEditor 5.
 
-Before starting, be sure that migrating is your best choice. Check {@link builds/guides/overview#When-NOT-to-use-builds When NOT to use CKEditor 5 Builds?}
+Before starting, be sure that migrating is your best choice. Refer to {@link builds/guides/overview#When-NOT-to-use-builds When NOT to use CKEditor 5 Builds?} for more information.
 
 ## Installation and integration
 
-The very first aspect that changed with CKEditor 5 is its installation procedure. It became much more modern with introduction of modular patterns, UMD, npm, etc. Check {@link builds/guides/integration/installation Installation} for more details.
+The very first aspect that changed with CKEditor 5 is its installation procedure. It became much more modern with the introduction of modular patterns, UMD, npm, etc. Check {@link builds/guides/integration/installation Installation} for more details.
 
 The API for integrating CKEditor with your pages also changed. It is worth checking {@link builds/guides/integration/basic-api Basic API} for an introduction.
 
 ## Features
 
-When it comes to features, there are two aspects to be taken into consideration:
+When it comes to features, there are two aspects that need to be taken into consideration:
 
-* CKEditor 5 may still not have the same features available in CKEditor 4.
+* CKEditor 5 may still not have the same features available as CKEditor 4.
 * Existing features may behave differently.
 
 Therefore, it is worth spending some time analyzing required features.
@@ -34,16 +34,16 @@ Therefore, it is worth spending some time analyzing required features.
 CKEditor 5 was designed with focus on creating quality content. There are thus good reasons for it to not support some old features. You should take this chance to rethink the features available in your application and in turn perhaps switch the approach towards a more modern reasoning.
 
 <info-box>
-Features like fonts, colors and alignment will be introduced in the future, when the new types of builds will be introduced with the purpose of satisfying document editing scenarios.
+Features like fonts, colors and alignment will be added in the future, when new types of builds will be introduced with the purpose of satisfying document editing scenarios.
 </info-box>
 
 <!-- TODO 4 -->
 
 ## Plugins
 
-The trickiest migration challenge to be faced may be related to custom plugins you could have developed for CKEditor 4. Although their concept may stay the same, their implementation is certainly different and will require rewriting them from scratch.
+The trickiest migration challenge to be faced may be related to custom plugins you have developed for CKEditor 4. Although their concept may stay the same, their implementation is certainly different and will require rewriting them from scratch.
 
-The same may apply for third party plugins which may not have been ported to CKEditor 5 yet.
+The same may apply for third-party plugins which may not have been ported to CKEditor 5 yet.
 
 Check the {@link builds/guides/development/plugins#Creating-plugins Creating plugins guide} for more information on the development of plugins.
 
@@ -51,7 +51,7 @@ Check the {@link builds/guides/development/plugins#Creating-plugins Creating plu
 
 In CKEditor 5, the previous concept of "skins" was reviewed and is now called "themes".
 
-If you have custom skins for CKEditor 4, these skins need to be recreated for CKEditor 5. Fortunately custom theming in CKEditor 5 is much more powerful and simpler than before.
+If you have custom skins for CKEditor 4, these skins need to be recreated for CKEditor 5. Fortunately {@link framework/guides/theme-customization custom theming} in CKEditor 5 is much more powerful and simpler than before.
 
 <!--
 For more information, check how to {@linkTODO create new themes in the CKEditor 5 Framework documentation}.
@@ -59,6 +59,6 @@ For more information, check how to {@linkTODO create new themes in the CKEditor
 
 ## Existing data
 
-An extremely important aspect to be remembered is that &mdash; because of the difference in features &mdash; the data produced with CKEditor 4 may not be compatible with CKEditor 5.
+An extremely important aspect to be remembered is that &mdash; because of the difference in features &mdash; the **data produced with CKEditor 4 may not be compatible with CKEditor 5**.
 
-Extensive analysis, data verification and tests should be performed on existing data. If necessary, conversion procedures should be developed to avoid data loss. A relatively simple yet efficient strategy of adopting CKEditor 5 into existing systems might be using CKEditor 5 for creating new content and the old editor for editing legacy content.
+Extensive analysis, data verification and tests should be performed on existing data. If necessary, you will need to develop conversion procedures to avoid data loss. A relatively simple yet efficient strategy of adopting CKEditor 5 into existing systems might be using CKEditor 5 for creating new content and the old editor for editing legacy content.

+ 2 - 3
docs/builds/guides/reporting-issues.md

@@ -24,7 +24,6 @@ Most of the issues are reproducible on the demo. If you have a different case th
 
 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 take steps to 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.
+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.