Merge pull request #142 from damien-carcel/doc-improvements

Doc improvements

Author: damien-carcel

.gitignore

@@ -5,3 +5,5 @@
 .DS_Store
 /tmp/
 config.json
+package-lock.json
+yarn.lock

content/img/illustrations/illus--Attributeoptions.svg

@@ -43,7 +43,7 @@ $client = new \Akeneo\Pim\AkeneoPimClientBuilder('http://akeneo.com/')->buildAut
 $product = $client->getProductApi()->get('top');
 ```
 
-You can get more information about the returned format of the product values [here](/documentation/resources.html#product).
+You can get more information about the returned format of the product values [here](/documentation/resources.html#product-values).
 
 ### Get a list of products 
 
@@ -178,7 +178,7 @@ $client->getProductApi()->create('top', [
 );
 ```
 
-You can get more information about the expected format of the product values [here](/documentation/resources.html#product).
+You can get more information about the expected format of the product values [here](/documentation/resources.html#product-values).
 
 ### Upsert a product 
 
@@ -226,7 +226,7 @@ $client->getProductApi()->upsert('top', [
 );
 ```
 
-You can get more information about the expected format of the product values [here](/documentation/resources.html#product).
+You can get more information about the expected format of the product values [here](/documentation/resources.html#product-values).
 
 ### Upsert a list of products 
 

content/img/illustrations/illus--Authentication.svg

@@ -14,14 +14,11 @@ gulp.task('clean-dist', function () {
 // so as to relaunch the build into dist directory
 // Should be used for dev purpose
 gulp.task('watch', ['create-dist'], function() {
-  gulp.watch('content/*.md', ['create-dist']);
-  gulp.watch('content/php-client/*.md', ['create-dist']);
-  gulp.watch('content/misc/*.md', ['create-dist']);
-  gulp.watch('styles/*.less', ['create-dist']);
-  gulp.watch('src/*.handlebars', ['create-dist']);
-  gulp.watch('src/api-reference/*.handlebars',['create-dist']);
-  gulp.watch('content/img/*', ['create-dist']);
+  gulp.watch('content/**/*.md', ['create-dist']);
+  gulp.watch('content/img/**/*', ['create-dist']);
   gulp.watch('content/*.yaml', ['create-dist']);
+  gulp.watch('styles/*.less', ['create-dist']);
+  gulp.watch('src/**/*.handlebars', ['create-dist']);
 });
 
 // Launch a server with dist directory exposed on it

content/img/illustrations/illus--Overview.svg

@@ -1,5 +1,8 @@
 {
   "name": "pim-api-docs",
+  "scripts": {
+    "serve": "gulp serve"
+  },
   "dependencies": {
     "jquery": "3.1.1",
     "font-awesome": "4.7.0",

content/php-client/resources/products.md

@@ -6,22 +6,32 @@ The API documentation can be found here: [api.akeneo.com](http://api.akeneo.com)
 ## Installation for dev/preview purposes
 
 ### Requirements
-[Node](https://nodejs.org/en/) is required and [Gulp-cli](https://github.com/gulpjs/gulp-cli) as well.
+[Node.js](https://nodejs.org/en/) is required.
+You can optionally choose [Yarn](https://yarnpkg.com/lang/en/) as package manager instead of NPM (provided with NodeJS by default).
+
+### Run locally
+First, install the all dependencies with Yarn:
 
 ```bash
-sudo npm install --global n
-sudo n 7.2.0
-npm install
-sudo npm install --global gulp-cli
+yarn install
 ```
 
-### Run locally
-Once Node and gulp-cli installed, run:
+or with NPM:
 
 ```bash
 npm install
+```
+
+Then run the Gulp server, with Yarn: 
 
-gulp serve
+```bash
+yarn serve
+```
+
+or with NPM:
+
+```bash
+npm serve
 ```
 
 The API documentation site is then available on `localhost:8000`.