generator-electrode: [major] yeoman 1.1 and yarn support

ISSUE_TEMPLATE.md

@@ -0,0 +1,43 @@
+<!--
+Thanks for taking the time to submit an issue.
+Please keep in mind, that GitHub issues are meant to be used for reporting bugs and to
+request new features.
+
+Use Stack Overflow for support: http://stackoverflow.com/questions/tagged/electrode
+Head over to one of our Gitter rooms (https://gitter.im/electrode-io/electrode) and ask for help if you’re unsure if you ran into a bug or if you have any other question.
+
+You would like to report a bug?
+Use the search feature to ensure that the bug hasn't been reported before.
+Please ensure to provide the following information to make sure we have all we need to address your issue.
+-->
+
+## Type of issue
+
+<!-- Feature request or bug -->
+
+<!-- Please delete the rest of the template in case of a feature request -->
+
+----
+
+## My environment
+
+* *OS version/details*: `eg. Windows 10 64-bit`
+* *Node version:* `x.x.x` (run `node --version` in your terminal)
+* *npm version:* `x.x.x` (run `npm --version` in your terminal)
+* *Version of yo :* `x.x.x` (run `yo --version` in your terminal)
+
+## Expected behavior
+
+<!-- Description over here -->
+
+## Current behavior
+
+<!-- Description over here -->
+
+## Steps to reproduce the behavior
+
+## Command line output
+
+```
+Paste your error output over here
+```

docs/SUMMARY.md

@@ -7,6 +7,7 @@
     -   [What is Electrode](overview/what-is-electrode.md)
     -   [Why Use Electrode](overview/why-use-electrode.md)
     -   [Requirements](overview/requirements.md)
+    -   [What are Archetypes](/overview/what-are-archetypes.md)
 
 ### Quick Start
 -   [Start With Electrode App](/chapter1/quick-start/start-with-app.md)
@@ -31,7 +32,6 @@
 -   [Intermediate](chapter1/Intermediate.md)
 -   [Application Archetype](/chapter1/intermediate/app-archetype/README.md)
 
-    -   [What are Archetypes](/chapter1/intermediate/app-archetype/what-are-archetypes.md)
     -   [Eslint Config](/chapter1/intermediate/app-archetype/eslint.md)
     -   [Webpack Config](/chapter1/intermediate/app-archetype/webpack-config.md)
     -   [Environment Variables](/chapter1/intermediate/app-archetype/env-vars.md)

docs/chapter1/intermediate/app-archetype/README.md

@@ -1,8 +1,7 @@
 # Electrode React Application Archetype
 
-You've seen how quickly you can create a React application with Electrode's application archetype. The defaults generally are well suited for many people, but it is possible to customize some aspects for your specific needs.
+The application archetype is a pair of npm modules that provide common patterns and configurations for developing a Universal React application.  With the application generator, you can quickly create and start developing a React application.  The defaults generally are well suited for many people, but it is possible to customize some aspects and enable more advanced features for your specific needs.
 
--   [What Are Archetypes](/chapter1/intermediate/app-archetype/what-are-archetypes.md)
 -   [Eslint Config](/chapter1/intermediate/app-archetype/eslint.md)
 -   [Webpack Config](/chapter1/intermediate/app-archetype/webpack-config.md)
 -   [Environment Variables](/chapter1/intermediate/app-archetype/env-vars.md)

docs/chapter1/quick-start/start-with-component.md

@@ -35,7 +35,9 @@ A webserver will be started on localhost:3000. Your new component will be used i
 
 ## Further: Adding More Components to the Packages
 
-If you want to add more components to your project, go to `packages` directory and run `yo electrode:component-add` within the packages directory. You can skip this section if you do not need extra components.
+> Note: You can skip this section if you do not need extra components.
+
+If you want to add more components to your project, go to `packages` directory and run `yo electrode:component-add` within the packages directory.
 
 ```bash
 $ cd packages
@@ -48,6 +50,8 @@ Follow the prompts as above, for example:
 
 This will generate a new package and also update the demo-app. Don't get panic if you saw conflicts, the `demo-app/src/client/components/home.jsx` and `demo-app/package.json` expected to be overwritten during the update.
 
+> Note: If you have installed `yo` at version 2.0.0 or higher, you can specify the `a` option for `overwrite this and all others`, or you need to specify the `y` option for `overwrite` each time.
+
 After finished installation, you can preview the multi-components by using demo-app again.
 
 ```bash

docs/overview/requirements.md

@@ -2,27 +2,59 @@
 
 First, let's quickly check your development environment. You will need to have the following set up to generate and deploy your Electrode app|component in under five minutes:
 
-## For Development On Your Local machine
+## For Development On Your Local Machine
 
 1.  Install the latest [NodeJS LTS binary](https://nodejs.org/) in your machine. (at least v4.2 required, >= 6 recommended).
-    -   Recommend a tool like [nvm](https://github.com/creationix/nvm#install-script) for managing NodeJS installations.
-2.  Install latest (v3) of [npm](https://www.npmjs.com/) with `npm install -g npm`.
-    -   Note: NodeJS v6.x already comes with npm@3 by default.
-    -   **Electrode requires npm version >= 3**
-3.  Install [yo] with `npm install -g yo`.
-4.  Install [generator-electrode] with `npm install -g generator-electrode`.
-5.  Install [xclap] with `npm install -g xclap-cli`.
-6.  The text editor of your choice downloaded with CLI tools installed.
-
-> **We write NodeJS code with ES6 features that NodeJS >= 4.2 supports.**
->
-> yo is a generic scaffolding system allowing the creation of any kind of app.
-> generator-electrode is a generator for Universal React App with NodeJS backend or a React component with useful clap tasks for development, building and publishing.
-> xclap is a Javascript build tool that lets us automate tasks.
+
+    -   We recommend a tool like [nvm](https://github.com/creationix/nvm#install-script) for managing NodeJS installations, but see [info here](#globally-installed-nodejs) for cautionary notes.
+
+2.  Install [yo], [generator-electrode], and [xclap-cli] globally:
+
+```bash
+npm install -g yo generator-electrode xclap-cli
+```
+
+### Globally Installed NodeJS
+
+IMPORTANT: If you install NodeJS globally on your system, then please make sure you re-install `yo` if it's already exist in your Node installation.  A bug in `yo` was causing it to always load generators from your system folders.  The fix was released on 7-31-2017.
+
+### Keep `generator-electrode` Up To Date
+
+We release new version of [generator-electrode] when we add new features.  So make sure you check the versions and update it periodically with the command:
+
+```bash
+npm install -g generator-electrode
+```
+
+### NPM Verion 3
+
+**Electrode requires npm version >= 3**
+
+NodeJS v6.x already comes with npm@3 by default, but if you are using NodeJS 4 for some reason, make sure you install npm@3 with the following command:
+
+```bash
+npm install -g npm@3
+```
+
+### Headless Chrome
+
+Headless chrome brings all modern web platform features provided by Chromium and the Blink rendering engine to the command line. It is a great tool for automated testing and server environments where you don't need a visible UI shell.
+
+In the Electrode Archetype App and Component, we are using Chrome Headless as the default option for automated testing. Please go to your Chrome browser, update Google Chrome if you see the option, and relaunch.
+
+> Note: Headless mode is available on Mac and Linux in Chrome 59. Windows support is coming in Chrome 60. To check what version of Chrome you have, open chrome://version.
 
 ## For Online Deployments
 
 -   A [Heroku](https://signup.heroku.com/dc) account + [CLI tools](https://devcenter.heroku.com/articles/heroku-command-line).
 -   A [Github](https://github.com/) account.
 
 Ready? Let's [build](/chapter1/quick-start/build-component.md).
+
+[yo]: http://yeoman.io/
+
+[yeoman]: http://yeoman.io/
+
+[xclap-cli]: https://www.npmjs.com/package/xclap-cli
+
+[generator-electrode]: https://www.npmjs.com/package/generator-electrode

package.json

@@ -13,7 +13,8 @@
     "nuke-packages": "rm -rf packages/*/node_modules packages/*/coverage",
     "nuke-samples": "rm -rf samples/*/node_modules samples/*/coverage samples/*/dist samples/*/.isomorphic-loader-config.json samples/*/.etmp",
     "test-reporter": "if lerna updated | grep electrode-webpack-reporter; then cd packages/electrode-webpack-reporter && npm install && npm test; fi",
-    "update-changelog": "node tools/update-changelog.js"
+    "update-changelog": "node tools/update-changelog.js",
+    "gitbook-serve": "gitbook serve --no-watch --no-live"
   },
   "devDependencies": {
     "bluebird": "^3.5.0",