Răsfoiți Sursa

Docs: Builds Overview, What's new, Migration reviewed.

Anna Tomanek 8 ani în urmă
părinte
comite
1f1e27f9bd
3 a modificat fișierele cu 53 adăugiri și 46 ștergeri
  1. 11 11
      docs/builds/guides/migrate.md
  2. 18 18
      docs/builds/guides/overview.md
  3. 24 17
      docs/builds/guides/whats-new.md

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

@@ -9,47 +9,47 @@ category: builds-guides
 order: 30
 ---
 
-When compared to its previous versions, CKEditor 5 can be considered a totally new editor. Every single aspect of it has been redesigned, from installation, to integration, to features, to its data model, to its API. Therefore, moving applications using previous version to version 5 cannot be called simply “upgrade”. It is something bigger, so the “migration” term fits better.
+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.
 
-There is no “drop in” solution for migrating. In this guide we hope to summarize the most important aspects to be taken in consideration.
+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 TODO When NOT to use CKEditor 5 Builds}?
 
 ## 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 TODO Installation} for more details.
+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 TODO Installation} for more details.
 
-Once installed, the API for integrating CKEditor in your pages also changed. It's worth checking Basic API for an introduction.
+Once installed, the API for integrating CKEditor with your pages also changed. It is worth checking {@link TODO Basic API} for an introduction.
 
 ## Features
 
-When it comes to features, there are two aspects to be taken in consideration:
+When it comes to features, there are two aspects to be taken into consideration:
 
 * CKEditor 5 may still not have the same features available in CKEditor 4.
 * Existing features may behave differently.
 
-Therefore, it is worth spending good time analysing required features.
+Therefore, it is worth spending some time analyzing required features.
 
-CKEditor 5 has been designed with focus on creating quality content. Therefore, there are good reasons for it to not support some old features. You should take this chance to rethink features in your application, many times having to switch the approach towards a more modern reasoning.
+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.
 
 <!-- TODO 4 -->
 
 ## Plugins
 
-The trickiest migration challenge to be faced may be related to custom plugins you could have had 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 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 same may apply for third party plugins, which may not have been yet ported to CKEditor 5.
+The same may apply for third party plugins which may not have been ported to CKEditor 5 yet.
 
 Check the {@link TODO Plugins guide} for more information on the development of plugins.
 
 ## Themes (skins)
 
-In CKEditor 5, the previous concept of "skins” has been reviewed and is now called “themes”.
+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. For more information, check how to {@link TODO create new themes in the CKEditor 5 Framework documentation}.
 
 ## Existing data
 
-An extremely important aspect to be remembered is that, because of the difference on features, 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.

+ 18 - 18
docs/builds/guides/overview.md

@@ -10,35 +10,35 @@ category: builds-guides
 order: 10
 ---
 
-CKEditor 5 Builds are comprised by a set of ready to use rich-text editors, so called "builds", in different configurations. Our goal is providing easy to use solutions that can satisfy good part of the editing use cases out there.
+CKEditor 5 Builds are comprised of a set of ready to use rich-text editors, so called "builds", with different configurations. Our goal is to provide easy to use solutions that can satisfy a good part of the editing use cases out there.
 
 ## Builds
 
 ### Classic editor
 
-The classic "boxed" editing interface, with toolbar at the top:
+The classic "boxed" editing interface, with a toolbar at the top:
 
-[ TODO: Classic Editor screenshot or sample ]
+[ TODO: Classic editor screenshot or sample ]
 
-### Inline Editor
+### Inline editor
 
-It leaves the contents as part of the page, attaching a floating toolbar to it:
+The edited content remains a part of the page, with a floating toolbar attached:
 
-[ TODO: Inline Editor screenshot ]
+[ TODO: Inline editor screenshot ]
 
 ## How builds are designed
 
-Each build has been designed to satisfy as many use cases as possible. They differ on their UI/UX and features, based on the following approach:
+Each build was designed to satisfy as many use cases as possible. They differ in their UI, UX and features, and are based on the following approach:
 
-* Include the set of features proposed by the Editor Recommendations project.
+* Include the set of features proposed by the {@link TODO Editor Recommendations} project.
 * Include features that contribute to creating quality content. In other words, features like fonts, colors and alignment are excluded.
 * Provide setups as generic as possible, based on research and community feedback.
 
-### Builds customization
+### Build customization
 
 Although the default builds try to fit many cases, they may still not be perfect in some integrations. They may have either too many or too few features. They may not have your preferred theme or UI implementation. Customization is required then.
 
-Check Customize and extend for in-depth details on how to change the default builds to match your needs and preferences.
+Check {@link TODO Custom builds} for details on how to change the default builds to match your preferences.
 
 ## Use cases
 
@@ -54,9 +54,9 @@ The following are **some** common use cases:
 	* Composing e-mail campaigns.
 	* Creating templates.
 * In forum applications:
-	* For the creation of topics and their replies.
-* In team collaboration application:
-	* For the creation of shared documents.
+	* Creation of topics and their replies.
+* In team collaboration applications:
+	* Creation of shared documents.
 * Other uses:
 	* User profile editing pages.
 	* Book writing applications.
@@ -67,13 +67,13 @@ The following are **some** common use cases:
 
 The {@link TODO CKEditor 5 Framework} should be used, instead of builds, in the following cases:
 
-* When you want to create your own text editor, having full control on every aspect of it, from UI to features.
-* When the solution proposed by the builds don't fit your specific use case.
+* When you want to create your own text editor and have full control over every aspect of it, from UI to features.
+* When the solution proposed by the builds does not fit your specific use case.
 
-{@link TODO CKEditor 4} should be used instead, in the following cases:
+In the following cases {@link TODO CKEditor 4} should be used instead:
 
-* When the compatibility with old browsers is a requirement.
+* When compatibility with old browsers is a requirement.
 * If CKEditor 4 contains features that are essential for you, which are not available in CKEditor 5 yet.
-* If CKEditor 4 is already in use in you application and you're still not ready to replace it with CKEditor 5.
+* If CKEditor 4 is already in use in you application and you are still not ready to replace it with CKEditor 5.
 
 <!-- TODO 1 -->

+ 24 - 17
docs/builds/guides/whats-new.md

@@ -1,7 +1,7 @@
 ---
 # Scope:
-# * Highlight new things, when compared to CKEditor 4.
-# * Emphasize cool new stuff were bringing, for those learning about CKEditor 5.
+# * Highlight new things when compared to CKEditor 4.
+# * Emphasize cool new stuff we are bringing, for those learning about CKEditor 5.
 
 title: What's new?
 category: builds-guides
@@ -10,33 +10,38 @@ order: 20
 
 ## Enhanced UX
 
+CKEditor 5 strives to provide a truly seamless, distraction-free editing experience to allow the users to focus on creating great content.
+
 ### Better images
 
-Inserting images inside the contents is now very intuitive, with all technical aspects (uploading, resizing) hidden from the user experience. No more complex dialogs.
+Inserting images into the content is now very intuitive, with all technical aspects (uploading, resizing) hidden from the user experience. No more complex dialogs.
 
-[ TODO Animated GIF of Pasting ]
+[ TODO Animated GIF of pasting ]
 
 [ TODO Animated GIF of DnD ]
 
-The outdated concept of image “alignment” has been dropped, introducing image “styles” instead:
+The outdated concept of image “alignment” was dropped in favor of image “styles”:
 
-[ TODO Animated GIF on styles ]
+[ TODO Animated GIF of styles ]
 
 <!-- TODO 2 -->
 
 ### Simple linking
 
-No more complex dialogs for linking.
+No more complex dialogs for links.
 
 [ TODO Screenshot of a link with the edit balloon on it ]
 
 ### Auto formatting
 
-Start lists, headings and even bold text by typing.
+Start lists, headings and even bold text by typing, without the need to
+use toolbar buttons.
 
 [ TODO Animated GIF with auto formatting in action ]
 
-## Enhancement in the classic editor
+## Enhanced classic editor
+
+For CKEditor 5 we reinvented the concept of the "boxed" editor.
 
 ### New toolbar
 
@@ -44,23 +49,25 @@ The toolbar is now always visible when the user scrolls the page down.
 
 [ TODO Animated GIF with scrolling and toolbar ]
 
-### Inlined contents
+### Inlined content
 
-The contents of the editor are now placed inline in the page. It’s much easier to style them. Additionally, the editor grows with the contents (or not, it’s up to you!).
+The editor content is now placed inline in the page &mdash; it is now much easier to style it. Additionally, the editor grows with the content (or not, it is up to you!).
 
 [ TODO Animated GIF of the editor growing when typing ]
 
-## Less features == Better content
+## Less features == better content
 
 We focused on creating a tool for writing quality content. At the same time, we simplified the integration of the editor into your system.
 
-We had way too many features and configurations, which were confusing developers and at the same time negatively impacting on the end user experience. Misleading formatting tools have been removed, dialogs stripped out or simplified and well designed features that require no configuration.
+We feel that in previous editor versions we had way too many features and configurations. This was confusing developers and at the same time negatively impacting the end-user experience.
+
+In CKEditor 5 misleading formatting tools were removed, dialogs were stripped out or simplified in favor of well designed features that require no configuration.
 
 [ TODO Screenshot of the toolbar ]
 
 ## Lightweight
 
-The editor is much more lightweight and fast. It brings a great user experience on both desktop and mobile devices.
+The editor is much more lightweight and fast. It brings a fantastic user experience on both desktop and mobile devices.
 
 ## Highly customizable
 
@@ -68,14 +75,14 @@ CKEditor 5 Builds are based on the {@link TODO CKEditor 5 Framework}, which give
 
 ## Custom data model
 
-A much more efficient data model has been designed in CKEditor 5, making the development of features a much more creative experience and enhancing features like undo and redo.
+A much more efficient data model was designed for CKEditor 5. This makes the development of features a much more creative experience and improves features such as undo and redo.
 
 ## Collaborative editing
 
-Another important benefit of our custom data model is that it enables the possibility of real-time collaborative editing inside CKEditor, by introducing the concepts of “operations” and “operational transformations”. Read more about {@link TODO collaboration in the CKEditor 5 Framework documentation}.
+Another important benefit of the custom data model is that it enables the possibility of real-time collaborative editing inside CKEditor by introducing the concepts of “operations” and “operational transformations”. Read more about {@link TODO collaboration in the CKEditor 5 Framework documentation}.
 
 <!-- TODO 3 -->
 
 ## Modern
 
-CKEditor 5 has been totally rewritten in ES6, using the power of modules. It provides all the necessary tools to easily integrate it with modern applications and technologies, like Angular, React, Node.js, npm, etc.
+CKEditor 5 has been totally rewritten in ES6, using the power of modules. It provides all the necessary tools to easily integrate it with modern applications and technologies like Angular, React, Node.js, npm, etc.