8
0
فهرست منبع

Docs: Added warnings about npm5 and webpack4. See #957.

Piotrek Koszuliński 7 سال پیش
والد
کامیت
9a42dcedcb

+ 15 - 1
docs/builds/guides/development/custom-builds.md

@@ -21,6 +21,14 @@ Some of the reasons for creating custom builds are:
 * Changing the {@link features/ui-language localization language} of the editor.
 * Enabling bug fixes which are still not a part of any public release.
 
+## Requirements
+
+In order to start developing CKEditor 5 you will require:
+
+* [Node.js](https://nodejs.org/en/) >= 6.0.0
+* npm 4.x (**note:** using npm 5 [causes](https://github.com/lerna/lerna/issues/938) some [problems](https://github.com/npm/npm/issues/16991))
+* [Git](https://git-scm.com/)
+
 ## Forking an existing build
 
 Start with [forking](https://help.github.com/articles/fork-a-repo/) one of the official builds (it will serve as the starting point for your custom one) and then clone your fork:
@@ -64,7 +72,13 @@ In order to customize a build you need to:
 
 ### Installing dependencies
 
-The easiest way to install missing dependencies is by typing:
+First, you need to install dependencies which are already specified in build's `package.json`:
+
+```bash
+npm install
+```
+
+Then, you can add missing depencies (i.e. packages you want to add to your build). The easiest way to do so is by typing:
 
 ```bash
 npm install --save-dev <package-name>

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

@@ -13,6 +13,13 @@ In this guide you can learn how to add plugins to your editor in the two most co
 * When you use an {@link builds/guides/overview editor build},
 * When you {@link framework/guides/quick-start build your editor from source}.
 
+## Requirements
+
+In order to start developing CKEditor 5 you will require:
+
+* [Node.js](https://nodejs.org/en/) >= 6.0.0
+* npm 4.x (**note:** using npm 5 [causes](https://github.com/lerna/lerna/issues/938) some [problems](https://github.com/npm/npm/issues/16991))
+
 ## Adding a plugin to a build
 
 Adding plugins to existing builds is done through their customization. Editor builds are maintained in their respective GitHub repositories. Therefore, assuming that you want to customize the [classic editor build](https://npmjs.com/package/@ckeditor/ckeditor5-build-classic) you need to:

+ 12 - 0
docs/builds/guides/integration/advanced-setup.md

@@ -9,12 +9,24 @@ The {@link builds/guides/integration/installation Installation} guide describes
 
 In this guide, we would like to show you ways to closer integrate CKEditor with your application. Thanks to that, you will be able to optimize the bundling process of your project and customize the builds in a more convenient way.
 
+## Requirements
+
+In order to start developing CKEditor 5 you will require:
+
+* [Node.js](https://nodejs.org/en/) >= 6.0.0
+* npm 4.x (**note:** using npm 5 [causes](https://github.com/lerna/lerna/issues/938) some [problems](https://github.com/npm/npm/issues/16991))
+* [Git](https://git-scm.com/)
+
 ## Bundler
 
 CKEditor 5 is currently built using [webpack](https://webpack.js.org) (>=3.x.x). All builds, examples and demos are generated using this bundler. It should also be possible to build CKEditor using other bundlers (if they are configured properly), such as [Rollup](https://github.com/rollup/rollup) or [Browserify](http://browserify.org/) but these setups are not officially supported yet. Also, the [`@ckeditor/ckeditor5-dev-webpack-plugin`](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-webpack-plugin) that allows to localize the editor is only available for webpack. More work on this subject will be done after v1.0.0.
 
 Therefore, **a prerequisite to this guide is that you are using webpack as your build tool**.
 
+<info-box warning>
+	Unfortunately, at the moment of writing this note, [webpack@4.x causes issues](https://github.com/ckeditor/ckeditor5-dev/issues/371) so the recommended version is webpack@3.x.
+</info-box>
+
 ## Scenario 1: Integrating existing builds
 
 This is the simplest scenario. It assumes that you want to use {@link builds/guides/overview#available-builds one of the existing builds} "as-is" (you can, of course, still {@link builds/guides/integration/configuration configure the editor}). It also gives the fastest build times.