Browse Source

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

Piotrek Koszuliński 7 years ago
parent
commit
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:

File diff suppressed because it is too large
+ 12 - 0
docs/builds/guides/integration/advanced-setup.md