update doc

Author: xdegenne

developer_guide/index.html

@@ -38,7 +38,7 @@ <h3 id="install-prerequisites">Install Prerequisites</h3>
 <p>Alien4Cloud is written in Java for the backend and requires a JDK 8 or newer (note that we test it using JDK 8 only for now).</p>
 
 <ul>
-  <li>make sure you have a JDK 8 installed  </li>
+  <li>make sure you have a JDK 8 installed</li>
   <li>make sure you have Maven installed (team is using v3.0.5)</li>
   <li>install Ruby</li>
   <li>install Python</li>

developer_guide/model.html

@@ -138,7 +138,7 @@ <h2 id="plugin-configuration">Plugin configuration</h2>
 
 <p>ALIEN provides an easy way to configure a plugin by generating the UI based on a configuration object using introspection. It also manages persistency of the configuration.</p>
 
-<p>In order to enable plugin configuration, one of the bean in your spring context must implements the _IPluginConfigurator<t>_ interface. This interface (see signature below) allow to provide a POJO that will act as the configuration object for the whole plugin.</t></p>
+<p>In order to enable plugin configuration, one of the bean in your spring context must implements the _IPluginConfigurator<T>_ interface. This interface (see signature below) allow to provide a POJO that will act as the configuration object for the whole plugin.</T></p>
 
 <div data-gist="https://gist.github.com/lucboutier/134921b861cf8b0fd44a.js"></div>
 

developer_guide/model_audit.html

@@ -39,11 +39,11 @@ <h5>UI plugins isolation</h5>
 <p>We have found some issues in 1.1.0 version in isolation of ui plugins that we resolved in 1.2.0 version. This however requires that your plugin defines a namespace in the require configuration. We have updated our plugin sample in order to take that update into account.</p>
 </div>
 
-<h1 id="understanding-aliens-ui-plugin-packaging">Understanding alien’s ui plugin packaging</h1>
+<h1 id="understanding-aliens-ui-plugin-packaging">Understanding alien&#8217;s ui plugin packaging</h1>
 
 <p>Our sample ui plugin ships with a packaging process that is similar to alien4cloud and that we recommend you to follow. On top of the packaging process we leverage <strong>maven</strong> as every plugin requires a minimal java configuration spring bean (see the <a href="#/developer_guide/plugin.html">main plugin documentation</a>).</p>
 
-<p><strong>Maven</strong> delegates to <strong>Grunt</strong> the packaging of the ui part of the plugin. Grunt basically does a few things but the most important from a packaging perspective is the usage of <strong>requirejs</strong> to create a single script that contains the plugin and it’s dependencies.</p>
+<p><strong>Maven</strong> delegates to <strong>Grunt</strong> the packaging of the ui part of the plugin. Grunt basically does a few things but the most important from a packaging perspective is the usage of <strong>requirejs</strong> to create a single script that contains the plugin and it&#8217;s dependencies.</p>
 
 <p><strong>Requirejs</strong> grunt plugin configuration files lies in <em>src/main/build/config/requirejs.js</em>.</p>
 
@@ -53,16 +53,16 @@ <h2 id="configuring-your-module-entry-point">Configuring your module entry point
 
 <ul>
   <li>The <strong>mainConfigFile</strong> (<em>./src/main/webapp/scripts/plugin-require.config.js</em>) in our sample plugin.</li>
-  <li>The module(s) to package, in our case it is called <em>‘a4c-plugin-sample’</em>:</li>
+  <li>The module(s) to package, in our case it is called <em>&#8216;a4c-plugin-sample&#8217;</em>:</li>
 </ul>
 
 <div data-gist="https://gist.github.com/lucboutier/ef213dab0190659cd25e.js"></div>
 
-<p>Of course the <em>‘a4c-plugin-sample’</em> is defined in the main config file to point to our entry point script:</p>
+<p>Of course the <em>&#8216;a4c-plugin-sample&#8217;</em> is defined in the main config file to point to our entry point script:</p>
 
 <div data-gist="https://gist.github.com/lucboutier/206f1388fcd00e3e945d.js"></div>
 
-<p>Our Require JS configuration specifies the application root directory to be <em>appDir: ‘&lt;%= yeoman.app %&gt;’,</em> which is defined in our main gruntfile <em>Gruntfile.js</em> to <em>src/main/webapp</em>. Hence require js will look for the <strong>src/main/webappscripts/plugin.js</strong> file as your module entry point. Note that the <em>.js</em> extension is added automatically by requirejs.</p>
+<p>Our Require JS configuration specifies the application root directory to be <em>appDir: &#8216;&lt;%= yeoman.app %&gt;&#8217;,</em> which is defined in our main gruntfile <em>Gruntfile.js</em> to <em>src/main/webapp</em>. Hence require js will look for the <strong>src/main/webappscripts/plugin.js</strong> file as your module entry point. Note that the <em>.js</em> extension is added automatically by requirejs.</p>
 
 <div class="note">
 <p>It is a best practice to use a module name that will be the same as the plugin id (as defined in your plugin descriptor) even if that is not required.</p>
@@ -76,17 +76,17 @@ <h2 id="referencing-alien4cloud-existing-modules-and-dependencies">Referencing a
 
 <div data-gist="https://gist.github.com/lucboutier/ef02c6cc8aec37cfd2fe.js"></div>
 
-<p>When requirejs will build the project and package all script within a single file it will try to find some modules called <em>lodash</em> <em>jquery</em> and <em>d3</em>. Such have not been defined yet and the build will fail with the following error: <em>Error: ENOENT: no such file or directory, open ‘/path_to_your_project_directory/alien4cloud-plugin-sample/target/webapp/lodash.js’</em>. In order to avoid that we must instruct requirejs that there is no need to look for this file in package phase (requirejs will try to get it only at runtime - so it has to exists within alien4cloud core ;)). In the requirejs grunt task config file (<em>src/main/build/config/requirejs.js</em>) we will add the following information:</p>
+<p>When requirejs will build the project and package all script within a single file it will try to find some modules called <em>lodash</em> <em>jquery</em> and <em>d3</em>. Such have not been defined yet and the build will fail with the following error: <em>Error: ENOENT: no such file or directory, open &#8216;/path_to_your_project_directory/alien4cloud-plugin-sample/target/webapp/lodash.js&#8217;</em>. In order to avoid that we must instruct requirejs that there is no need to look for this file in package phase (requirejs will try to get it only at runtime - so it has to exists within alien4cloud core ;)). In the requirejs grunt task config file (<em>src/main/build/config/requirejs.js</em>) we will add the following information:</p>
 
 <div data-gist="https://gist.github.com/lucboutier/59ebdd98c0a2b7fa41c1.js"></div>
 
 <p>Now requirejs know that these files are provided and should not be packaged within the plugin!</p>
 
 <h2 id="referencing-new-dependencies">Referencing new dependencies</h2>
 
-<p>Well now we know how to reference alien4cloud scripts in our plugin but your plugin may also require some dependencies that are not already packaged within alien4cloud core. So first of all let’s get the dependency in our project!</p>
+<p>Well now we know how to reference alien4cloud scripts in our plugin but your plugin may also require some dependencies that are not already packaged within alien4cloud core. So first of all let&#8217;s get the dependency in our project!</p>
 
-<p>Let’s suppose that we want to use the <em>angular-ui-sortable</em> library that is not included in alien4cloud core.</p>
+<p>Let&#8217;s suppose that we want to use the <em>angular-ui-sortable</em> library that is not included in alien4cloud core.</p>
 
 <p>We use bower to manage javascript dependencies so the first thing will be to edit the <em>bower.json</em> configuration file to add our dependency.</p>
 
@@ -102,7 +102,7 @@ <h2 id="referencing-new-dependencies">Referencing new dependencies</h2>
 
 <h2 id="referencing-your-own-scripts">Referencing your own scripts</h2>
 
-<p>Well this is quite obvious but you will probably have more than one script, controller, service, directive within your plugin. As we have defined already our entry point we can reference another script from it (the other script will be able to also reference it’s dependencies etc.).</p>
+<p>Well this is quite obvious but you will probably have more than one script, controller, service, directive within your plugin. As we have defined already our entry point we can reference another script from it (the other script will be able to also reference it&#8217;s dependencies etc.).</p>
 
 <p>As you remember the base directory of the plugin application, as defined in requirejs, is the <em>src/main/webapp</em> folder. So loading a <em>hello-service.js</em> script, from the <em>src/main/webapp/scripts</em> directory, is just as easy as the following:</p>
 
@@ -112,7 +112,7 @@ <h1 id="accessing-plugin-static-resources">Accessing plugin static resources</h1
 
 <p>Now that you know how to manage your scripts and package them as a single file with requirejs, you may want to access the static resources of your plugin (images, html view, css, etc.).</p>
 
-<p>Our backend packaging system is a bit tricky and all plugin’s static files (basically all files within the <em>ui</em> folder of your plugin actually) can be accessed from a url that contains your plugin unique id as generated by alien4cloud. Long make short, you actually don’t know when writing the plugin how to access them.</p>
+<p>Our backend packaging system is a bit tricky and all plugin&#8217;s static files (basically all files within the <em>ui</em> folder of your plugin actually) can be accessed from a url that contains your plugin unique id as generated by alien4cloud. Long make short, you actually don&#8217;t know when writing the plugin how to access them.</p>
 
 <p>Hopefully we provides you with a way to easily retrieve them! The <strong>plugins</strong> module of alien4cloud allows you to get the base url of your plugin ui directory. For example, to get the <em>views/hello.html</em> resource you can just do the following:</p>
 

developer_guide/model_events.html

@@ -31,7 +31,7 @@ <h1 class="pull-left" style="margin-top: 0px;">Backup, restore and migrate data<
 <div class="row"><ul class="nav nav-pills" id="summarypanel"></ul></div>
 <hr style="margin-top:5px; margin-bottom:5px;" />
 
-<p>Find here informations about how to perform backup / restore your alien4cloud, and also, migrate from <code>alien4cloud 1.2.1</code> to <code>alien4cloud 1.3.x</code>.  </p>
+<p>Find here informations about how to perform backup / restore your alien4cloud, and also, migrate from <code>alien4cloud 1.2.1</code> to <code>alien4cloud 1.3.x</code>.</p>
 
 <h2 id="downloads">Downloads</h2>
 
@@ -150,7 +150,7 @@ <h5> Plugins migration </h5>
 <div class="note warning">
 <h5>Alien4Cloud and ElasticSearch states</h5>
 <p>We recommend to stop Alien4Cloud before performing the migration. <strong>ElasticSearch MUST be up and running</strong>. Alien4Cloud should be restarted once the process is completed.  This is quite trivial to do when running in a classical production setup where elasticsearch process is independant from Alien4Cloud ( See <a href="#/documentation/1.3.0/admin_guide/advanced_configuration.html">advanced configuration</a> for more details ).<br />
-However, if running in an embedded configuration, you can’t stop Alien4Cloud without stopping ElasticSearch. Then, just make sure the plateform is not used during the process.  </p>
+However, if running in an embedded configuration, you can’t stop Alien4Cloud without stopping ElasticSearch. Then, just make sure the plateform is not used during the process.</p>
 </div>
 
 <p>In order to migrate Alien4Cloud you must download the <a href="http://fastconnect.org/maven/service/local/artifact/maven/redirect?r=fastconnect&amp;g=alien4cloud&amp;a=alien4cloud-migration&amp;v=LATEST&amp;p=zip&amp;c=distrib" title="migration-tool"> migration tool </a> and copy it on the machine where Alien is running (or anywhere which has access to Alien’s data folders).<br />
@@ -242,7 +242,7 @@ <h2 id="perform-migration">perform migration</h2>
 
 <ul>
   <li>
-    <p>Verify that all plugins (excepts custom ones) have been re-uploaded properly else re-upload them.  </p>
+    <p>Verify that all plugins (excepts custom ones) have been re-uploaded properly else re-upload them.</p>
   </li>
   <li>
     <p>Refresh your browser by emptying its cache so that new plugins’ UI can be loaded.</p>

developer_guide/model_tosca.html

@@ -36,7 +36,7 @@ <h5>Premium feature</h5>
 <p>This section refers to a premium feature.</p>
 </div>
 
-<p>When deploying A4C in a production environment, you may want to be sure it will be available 24/7, even in case of crashes. We provide a plugin that manages high availability for A4C using a primary/backup mode. </p>
+<p>When deploying A4C in a production environment, you may want to be sure it will be available 24/7, even in case of crashes. We provide a plugin that manages high availability for A4C using a primary/backup mode.</p>
 
 <div class="note warning">
 <p>Note that this page focus only on A4C HA: we don’t consider HA for orchestrators components (managers …) in this page.</p>
@@ -46,14 +46,14 @@ <h1 id="architecture">Architecture</h1>
 
 <p>Our HA solution is based on a primary/backup mecanism: you’ll need to deploy several instances of A4C to ensure one will be available at a given time.</p>
 
-<p>The <em>alien4cloud-premium-ha</em> plugin leverages on <a href="https://www.consul.io">Consul</a> features: </p>
+<p>The <em>alien4cloud-premium-ha</em> plugin leverages on <a href="https://www.consul.io">Consul</a> features:</p>
 
 <ul>
-  <li>Key/Value Storage: a distrubuted key/value is used to determine which A4C instance is the leader. </li>
+  <li>Key/Value Storage: a distrubuted key/value is used to determine which A4C instance is the leader.</li>
   <li>Failure Detection: Consul is in charge of checking the liveness of A4C instances.</li>
 </ul>
 
-<p>As a consequence, to use this plugin you will need a Consul server (but you’ll probably use a consul cluster !). </p>
+<p>As a consequence, to use this plugin you will need a Consul server (but you’ll probably use a consul cluster !).</p>
 
 <p>Since A4C use ElasticSearch as a backend server, you’ll need to setup a remote server (instead of launching an embedded one), and you’ll probably prefer to setup an ElasticSearch cluster with replicated nodes.</p>
 
@@ -77,7 +77,7 @@ <h2 id="how-a4c-works-in-ha-mode">How A4C works in HA mode</h2>
 
 <p>A4C will then open a session onto consul and try to acquire a lock onto a consul key. If the lock is already acquired (by another instance), it will still in this boostrap mode and will wait for changes on this key. A health check is associated with the sesssion, so consul will check for the liveness of this A4C instance.</p>
 
-<p>When the lock is acquired, this means the current instance is elected as the leader. The whole application context is started, all REST endpoint are available and all the stuffs are waked up. This A4C instance is then fully usable. </p>
+<p>When the lock is acquired, this means the current instance is elected as the leader. The whole application context is started, all REST endpoint are available and all the stuffs are waked up. This A4C instance is then fully usable.</p>
 
 <p>If the JVM or the machine crash (or event if an A4C instance can’t reach ElasticSeach), the health check will fail, consul will disable the session, and the lock (if it is associated with this session) will be released. The primary will fall back in backup mode. Another instance will be elected.</p>
 

developer_guide/plugin.html

@@ -36,7 +36,7 @@ <h5>Premium feature</h5>
 <p>This section refers to a premium feature.</p>
 </div>
 
-<p>The Alien post-deployment web application is a Spring boot application, that helps managing patches or operations added to a node within a deployment. You MUST deploy it if you plan on providing to the users the ability to perform <a href="#/documentation/1.3.0/user_guide/post_deployment.html">post deployment operations</a> on an application.  </p>
+<p>The Alien post-deployment web application is a Spring boot application, that helps managing patches or operations added to a node within a deployment. You MUST deploy it if you plan on providing to the users the ability to perform <a href="#/documentation/1.3.0/user_guide/post_deployment.html">post deployment operations</a> on an application.</p>
 
 <div class="note info">
 <h5>Where to deploy</h5>