8
0
Просмотр исходного кода

Docs: Fixed some links and reworded some parts of builds documentation.

Wiktor Walc 8 лет назад
Родитель
Сommit
b06b83ce15

+ 4 - 4
docs/builds/guides/integration/installation.md

@@ -15,11 +15,11 @@ The goal of installing any of the CKEditor 5 builds is to enable you to use its
 * [CDN](#CDN)
 * [CDN](#CDN)
 * [npm](#npm)
 * [npm](#npm)
 
 
-Each of the builds has independent release packages. Before starting, you must define which one you are interested in. Check the {@link builds/guides/overview Overview} page for the list of available builds.
+Each of the builds has independent release packages. Check the {@link builds/guides/overview#Builds Overview} page for the list of available builds.
 
 
 ### Zip download
 ### Zip download
 
 
-Go to http://ckeditor.com/ckeditor5-builds/download and download your preferred build. For example, you may download the `ckeditor5-build.classic-1.0.0.zip` file for the Classic Editor build.
+Go to https://ckeditor.com/ckeditor5-builds/download and download your preferred build. For example, you may download the `ckeditor5-build.classic-1.0.0.zip` file for the Classic editor build.
 
 
 Extract the above `.zip` file into a dedicated directory inside your website or application.
 Extract the above `.zip` file into a dedicated directory inside your website or application.
 
 
@@ -33,9 +33,9 @@ Check out the {@linkTODO CKEditor 5 Builds CDN website} for a list of URL entry
 
 
 ### npm
 ### npm
 
 
-All builds are released on npm. The following search shows all build packages available there: https://www.npmjs.com/search?q=%40ckeditor%2Fckeditor5-build
+All builds are released on npm. [Use this search link](https://www.npmjs.com/search?q=%40ckeditor%2Fckeditor5-build) to view all build packages available in npm.
 
 
-Installing a build with npm is as simple as calling the following inside your website or application:
+Installing a classic build with npm is as simple as calling the following inside your website or application:
 
 
 ```bash
 ```bash
 npm install --save @ckeditor/ckeditor5-build-classic
 npm install --save @ckeditor/ckeditor5-build-classic

+ 13 - 6
docs/builds/guides/migrate.md

@@ -9,17 +9,17 @@ category: builds-guides
 order: 30
 order: 30
 ---
 ---
 
 
-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 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 into consideration before you proceed with installing CKEditor 5.
 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 {@linkTODO When NOT to use CKEditor 5 Builds}?
+Before starting, be sure that migrating is your best choice. Check {@link builds/guides/overview#When-NOT-to-use-CKEditor-5-Builds When NOT to use CKEditor 5 Builds?}
 
 
 ## Installation and integration
 ## 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 introduction of modular patterns, UMD, npm, etc. Check {@link builds/guides/integration/installation Installation} for more details.
 
 
-Once installed, 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.
+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
 ## Features
 
 
@@ -32,6 +32,10 @@ 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.
 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.  
+</info-box>
+
 <!-- TODO 4 -->
 <!-- TODO 4 -->
 
 
 ## Plugins
 ## Plugins
@@ -40,16 +44,19 @@ The trickiest migration challenge to be faced may be related to custom plugins y
 
 
 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 {@linkTODO Plugins guide} for more information on the development of plugins.
+Check the {@link builds/guides/integration/plugins#Creating-plugins Creating plugins guide} for more information on the development of plugins.
 
 
 ## Themes (skins)
 ## Themes (skins)
 
 
 In CKEditor 5, the previous concept of "skins" was 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 {@linkTODO create new themes in the CKEditor 5 Framework documentation}.
+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 {@linkTODO create new themes in the CKEditor 5 Framework documentation}.
+-->
 
 
 ## Existing data
 ## 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.
+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. 

+ 14 - 6
docs/builds/guides/overview.md

@@ -37,16 +37,24 @@ The edited content remains a part of the page (like in the inline editor). The t
 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:
 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](https://ckeditor.github.io/editor-recommendations/).
 * Include the set of features proposed by the [Editor Recommendations project](https://ckeditor.github.io/editor-recommendations/).
-* Include features that contribute to creating quality content. In other words, features like fonts, colors and alignment are excluded.
+* Include features that contribute to creating quality content.
 * Provide setups as generic as possible, based on research and community feedback.
 * Provide setups as generic as possible, based on research and community feedback.
 
 
+<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.  
+</info-box>
+
 ### Build customization
 ### Build customization
 
 
-Every build comes with a default set of features and a default configuration of them. Although the builds try to fit many cases, they may still need to be adjusted in some integrations.
+Every build comes with a default set of features and a default configuration of them. Although the builds try to fit many cases, they may still need to be adjusted in some integrations. The following modifications are possible:
 
 
-You can override the default configuration of features when creating an instance of the editor. It's also possible to remove some of built-in features through the configuration (if the build comes with too many of them). Read more in the {@link builds/guides/integration/configuration Configuration guide}.
+ * You can override the default **configuration of features** (e.g. define different image styles or heading levels).
+ * You can change the default **toolbar configuration** (e.g. remove undo/redo buttons). 
+ * You can also **remove features** (plugins).
+ 
+Read more in the {@link builds/guides/integration/configuration Configuration guide}.
 
 
-If a build doesn't provide all the necessary features or you want create a highly optimized build of editor which will contain only the necessary features, then you need to customize the build or create a brand new one. Check {@linkTODO Custom builds} for details on how to change the default builds to match your preferences.
+If a build doesn't provide all the necessary features or you want create a highly optimized build of editor which will contain only the necessary features, then you need to customize the build or create a brand new one. Check {@link builds/guides/development/custom-builds Custom builds} for details on how to change the default builds to match your preferences.
 
 
 ## Use cases
 ## Use cases
 
 
@@ -73,12 +81,12 @@ The following are **some** common use cases:
 
 
 ### When NOT to use CKEditor 5 Builds?
 ### When NOT to use CKEditor 5 Builds?
 
 
-The {@linkTODO CKEditor 5 Framework} should be used, instead of builds, in the following cases:
+The {@link framework/index CKEditor 5 Framework} should be used, instead of builds, in the following cases:
 
 
 * When you want to create your own text editor and have full control over every aspect of it, from UI to features.
 * 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.
 * When the solution proposed by the builds does not fit your specific use case.
 
 
-In the following cases {@linkTODO CKEditor 4} should be used instead:
+In the following cases [CKEditor 4](https://ckeditor.com/ckeditor-4/) should be used instead:
 
 
 * When 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 contains features that are essential for you, which are not available in CKEditor 5 yet.

+ 10 - 7
docs/builds/guides/whats-new.md

@@ -20,7 +20,7 @@ Inserting images into the content is now very intuitive, with all technical aspe
 
 
 [ TODO Animated GIF of DnD ]
 [ TODO Animated GIF of DnD ]
 
 
-The outdated concept of image "alignment" was dropped in favor of image "styles":
+The outdated concept of image "alignment" was dropped in favor of {@link features/image#Image-styles image styles}:
 
 
 [ TODO Animated GIF of styles ]
 [ TODO Animated GIF of styles ]
 
 
@@ -32,10 +32,9 @@ No more complex dialogs for links.
 
 
 [ TODO Screenshot of a link with the edit balloon on it ]
 [ TODO Screenshot of a link with the edit balloon on it ]
 
 
-### Auto formatting
+### Autoformatting
 
 
-Start lists, headings and even bold text by typing, without the need to
-use toolbar buttons.
+Start lists, headings and even bold text by typing, without the need to use toolbar buttons. See {@link features/autoformat Autoformatting feature} for more details.
 
 
 [ TODO Animated GIF with auto formatting in action ]
 [ TODO Animated GIF with auto formatting in action ]
 
 
@@ -71,7 +70,7 @@ The editor is much more lightweight and fast. It brings a fantastic user experie
 
 
 ## Highly customizable
 ## Highly customizable
 
 
-CKEditor 5 Builds are based on the {@linkTODO CKEditor 5 Framework}, which gives powerful customizability and extensibility possibilities.
+CKEditor 5 Builds are based on the {@link framework/index CKEditor 5 Framework}, which gives powerful customizability and extensibility possibilities.
 
 
 ## Custom data model
 ## Custom data model
 
 
@@ -79,10 +78,14 @@ A much more efficient data model was designed for CKEditor 5. This makes the dev
 
 
 ## Collaborative editing
 ## Collaborative editing
 
 
-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 {@linkTODO 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 {@linkTODO collaboration in the CKEditor 5 Framework documentation}.
+ -->
 
 
 <!-- TODO 3 -->
 <!-- TODO 3 -->
 
 
 ## Modern
 ## 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.

+ 14 - 1
docs/builds/index.md

@@ -2,6 +2,19 @@
 title: Builds
 title: Builds
 category: builds
 category: builds
 order: 10
 order: 10
+toc: false
 ---
 ---
 
 
-Builds' starting page.
+# CKEditor 5 Builds
+
+CKEditor 5 Builds are the fastest and easiest way to use CKEditor 5 in your application.
+
+## Documentation 
+
+ * {@link builds/guides/overview Guides} &ndash; learn on how to install, integrate and configure CKEditor 5 Builds. More complex aspects, like creating custom builds are explained too.
+ * {@link examples/index Examples} &ndash; try the live demos of all available builds.
+ * {@link features/index Features} &ndash; learn about some of the features included in CKEditor 5 Builds.
+
+## Contribute
+
+CKEditor is an Open Source project so your contribution is welcome. Feel free to {@link builds/guides/reporting-issues report bugs} or improve the code on [GitHub](https://github.com/ckeditor/ckeditor5). Since CKEditor is localized, you can also help [translating it](https://www.transifex.com/ckeditor/ckeditor5/). You do not need to be a programmer to contribute to the project!