Kaynağa Gözat

Docs: Development guides revised. [skip ci]

Anna Tomanek 8 yıl önce
ebeveyn
işleme
69d9f0878e

+ 11 - 11
docs/builds/guides/development/custom-builds.md

@@ -17,8 +17,8 @@ Some of the reasons for creating custom builds are:
 * Adding features which are not included in the existing builds, either from a third party or custom developed.
 * Adding features which are not included in the existing builds, either from a third party or custom developed.
 * Removing unnecessary features present in a build.
 * Removing unnecessary features present in a build.
 * Changing the {@link builds/guides/integration/basic-api#Creators editor creator}.
 * Changing the {@link builds/guides/integration/basic-api#Creators editor creator}.
-* Changing the editor theme.
-* Changing the localization language of the editor.
+* Changing the {@link framework/guides/theme-customization editor theme}.
+* Changing the {@link features/ui-language localization language} of the editor.
 * Enabling bug fixes which are still not a part of any public release.
 * Enabling bug fixes which are still not a part of any public release.
 
 
 ## Forking an existing build
 ## Forking an existing build
@@ -36,7 +36,7 @@ git remote add upstream https://github.com/ckeditor/ckeditor5-build-classic.git
 ```
 ```
 
 
 <info-box hint>
 <info-box hint>
-	If you do not want to fork the official build, you can just clone it. However, you will not be able to commit and push your customizations back to [GitHub](https://github.com).
+	If you do not want to fork the official build, you can just clone it. However, you will not be able to commit and push your customizations back to GitHub.
 </info-box>
 </info-box>
 
 
 ## Build anatomy
 ## Build anatomy
@@ -44,17 +44,17 @@ git remote add upstream https://github.com/ckeditor/ckeditor5-build-classic.git
 Every build contains the following files:
 Every build contains the following files:
 
 
 * `build/ckeditor.js` &ndash; The ready-to-use editor bundle, containing the editor and all plugins.
 * `build/ckeditor.js` &ndash; The ready-to-use editor bundle, containing the editor and all plugins.
-* `src/ckeditor.js` &ndash; The source entry point of the build. It can be used for complex bundling and development. Based on it the `build/ckeditor.js` is created (by [webpack](https://webpack.js.org)).
+* `src/ckeditor.js` &ndash; The source entry point of the build. It can be used for complex bundling and development. Based on it the `build/ckeditor.js` file is created by [webpack](https://webpack.js.org).
 * `build-config.js` &ndash; The configuration of this particular CKEditor 5 build, based on which the `src/ckeditor.js` file is created.
 * `build-config.js` &ndash; The configuration of this particular CKEditor 5 build, based on which the `src/ckeditor.js` file is created.
-* `webpack-config.js` &ndash; Webpack configuration used to build the editor.
+* `webpack-config.js` &ndash; webpack configuration used to build the editor.
 
 
 ## Customizing a build
 ## Customizing a build
 
 
 In order to customize a build you need to:
 In order to customize a build you need to:
 
 
 * Install missing dependencies.
 * Install missing dependencies.
-* Update the `build-config.js`.
-* Update the builds (which includes updating `src/ckeditor.js` and editor bundle in `build/`).
+* Update the `build-config.js` file.
+* Update the builds (which includes updating `src/ckeditor.js` and the editor bundle in `build/`).
 
 
 ### Installing dependencies
 ### Installing dependencies
 
 
@@ -107,7 +107,7 @@ module.exports = {
 	// UI language. Language codes follow the https://en.wikipedia.org/wiki/ISO_639-1 format.
 	// UI language. Language codes follow the https://en.wikipedia.org/wiki/ISO_639-1 format.
 	language: 'en',
 	language: 'en',
 
 
-	// Editor config.
+	// Editor configuration.
 	config: {
 	config: {
 		toolbar: [ 'headings', 'bold', 'italic', 'custombutton' ]
 		toolbar: [ 'headings', 'bold', 'italic', 'custombutton' ]
 	}
 	}
@@ -118,15 +118,15 @@ module.exports = {
 
 
 After you changed the build configuration or updated some dependencies, it is time to rebuild the bundle. This will run a bundler (webpack) with a proper configuration (see `webpack.config.js`).
 After you changed the build configuration or updated some dependencies, it is time to rebuild the bundle. This will run a bundler (webpack) with a proper configuration (see `webpack.config.js`).
 
 
-If you wish to create the bundle based on the build configuration (`build-config.js`) run:
+If you wish to create a bundle based on the build configuration (`build-config.js`), run:
 
 
 ```bash
 ```bash
 npm run build
 npm run build
 ```
 ```
 
 
-This command will update the entry file (`src/ckeditor.js`) and create the bundle  `build/ckeditor.js`.
+This command will update the entry file (`src/ckeditor.js`) and create the bundle &mdash; `build/ckeditor.js`.
 
 
-If you want to skip updating the entry file (in case you modified it manually) run:
+If you want to skip updating the entry file (in case you modified it manually), run:
 
 
 ```bash
 ```bash
 npm run build-ckeditor
 npm run build-ckeditor

+ 7 - 7
docs/builds/guides/development/plugins.md

@@ -2,7 +2,7 @@
 # Scope:
 # Scope:
 # * Introduction to plugins.
 # * Introduction to plugins.
 # * Exemplify use cases.
 # * Exemplify use cases.
-# * Point to resources to learn plugins development.
+# * Point to resources to learn plugin development.
 
 
 category: builds-development
 category: builds-development
 order: 40
 order: 40
@@ -16,13 +16,13 @@ Plugins provided by the CKEditor core team are available in [npm](https://www.np
 
 
 ## Common use cases
 ## Common use cases
 
 
-Plugins can be pretty much anything. They are simply code, initialized by the editor if they are configured to be loaded. They can use the richness of the {@linkTODO CKEditor 5 Framework API} to enhance the editor or to better integrate it with your application.
+Plugins can be pretty much anything. They are simply pieces of code, initialized by the editor if they are configured to be loaded. They can use the richness of the {@linkTODO CKEditor 5 Framework API} to enhance the editor or to better integrate it with your application.
 
 
 Common use cases for plugins are:
 Common use cases for plugins are:
 
 
-* **Editing features**, like bold, heading, linking or whichever feature that the user can use to manipulate the content.
+* **Editing features**, like bold, heading, linking or any other feature that the user can use to manipulate the content.
 * **Adding semantic value** to the content, like annotations or accessibility features.
 * **Adding semantic value** to the content, like annotations or accessibility features.
-* **Third-party services integration**, for injecting external resources inside the content, like videos or social network posts.
+* **Third-party services integration**, for injecting external resources into the content, like videos or social network posts.
 * **Handling image upload** and image manipulation features.
 * **Handling image upload** and image manipulation features.
 * **Providing widgets** for easy integration with application structured data.
 * **Providing widgets** for easy integration with application structured data.
 * **Injecting analysis tools** that help enhancing the quality of the content.
 * **Injecting analysis tools** that help enhancing the quality of the content.
@@ -32,13 +32,13 @@ Common use cases for plugins are:
 
 
 Creating your own plugins is a straightforward task but it requires good knowledge about a few aspects of the CKEditor 5 development environment. The following resources are recommended as a starting point:
 Creating your own plugins is a straightforward task but it requires good knowledge about a few aspects of the CKEditor 5 development environment. The following resources are recommended as a starting point:
 
 
-* {@linkTODO Plugin development guide} in the CKEditor 5 Framework documentation.
+* The {@linkTODO Plugin development guide} in the CKEditor 5 Framework documentation.
 * {@link builds/guides/development/custom-builds Creating custom builds} which is necessary to have your plugin included inside a CKEditor 5 build.
 * {@link builds/guides/development/custom-builds Creating custom builds} which is necessary to have your plugin included inside a CKEditor 5 build.
 
 
-A good understanding of the {@linkTODO CKEditor 5 Framework} is also very welcome when it comes to creating plugins.
+A good understanding of the {@link framework/index CKEditor 5 Framework} is also very welcome when it comes to creating plugins.
 
 
 ## Using third-party plugins
 ## Using third-party plugins
 
 
 A great way to enhance your builds with additional features is by using plugins created by the community. Such plugins are generally available as npm packages, so a quick [search on the "ckeditor5" keyword in npm](https://www.npmjs.com/search?q=ckeditor5) should work as a starting point.
 A great way to enhance your builds with additional features is by using plugins created by the community. Such plugins are generally available as npm packages, so a quick [search on the "ckeditor5" keyword in npm](https://www.npmjs.com/search?q=ckeditor5) should work as a starting point.
 
 
-Once you have plugins to be included, just {@link builds/guides/development/custom-builds create a custom build} configured to include them.
+Once you have plugins to be included, {@link builds/guides/development/custom-builds create a custom build} configured to include them.