regen docs

esatterwhite · Jan 3, 2017 · 486455b · 486455b
1 parent 6b6086b
commit 486455b
Show file tree

Hide file tree

Showing 27 changed files with 95 additions and 37 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -86,7 +86,7 @@
 
 
     <section class="readme-section">
-        <article><p><img src="https://github.com/esatterwhite/skyring/raw/master/assets/skyring-inverted.png" alt="skyring"></p>
+        <article><p><img src="https://github.com/esatterwhite/skyring/raw/master/assets/skyring.png" alt="skyring"></p>
 <p><a href="https://travis-ci.org/esatterwhite/skyring"><img src="https://img.shields.io/travis/esatterwhite/skyring.svg?style=flat-square" alt="Travis"></a>
 <a href="https://www.npmjs.com/package/skyring"><img src="https://img.shields.io/npm/v/skyring.svg?style=flat-square" alt="npm"></a>
 <a href="https://www.npmjs.com/package/skyring"><img src="https://img.shields.io/npm/l/skyring.svg?style=flat-square" alt="npm"></a>
@@ -196,7 +196,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>
@@ -287,4 +287,4 @@ <h4 class="modal-title">Search results</h4>
 
 
 </body>
-</html>
+</html>
diff --git a/docs/index.js.html b/docs/index.js.html
@@ -157,7 +157,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_json.js.html b/docs/lib_json.js.html
@@ -147,7 +147,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_nats.js.html b/docs/lib_nats.js.html
@@ -208,7 +208,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_index.js.html b/docs/lib_server_index.js.html
@@ -295,7 +295,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_mock.js.html b/docs/lib_server_mock.js.html
@@ -288,7 +288,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_node.js.html b/docs/lib_server_node.js.html
@@ -309,7 +309,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_router.js.html b/docs/lib_server_router.js.html
@@ -286,7 +286,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_timer.js.html b/docs/lib_timer.js.html
@@ -335,7 +335,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_transports_callback.js.html b/docs/lib_transports_callback.js.html
@@ -127,7 +127,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_transports_http.js.html b/docs/lib_transports_http.js.html
@@ -166,7 +166,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_transports_index.js.html b/docs/lib_transports_index.js.html
@@ -149,7 +149,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-keef.html b/docs/module-keef.html
@@ -98,15 +98,40 @@ <h3>Command Line Arguments</h3><p>Command line arguments are the highest level o
    &quot;foo&quot;:{
       &quot;bar&quot;: 1
    }
-}</code></pre><h3>Conf File</h3><p>The <code>conf</code> options can be set to read specific configuration from a file(s). The value should be a full path. If the path points to a directory, the conf loader will read all json files, sort them and load their values in an overriding order. Sorting is done in a descending, lexigraphical order.</p>
+}</code></pre><h3>Conf Options</h3><p>The <code>conf</code> option can be set to read specific configuration from a file(s). The value should be a full path. If the path points to a directory, the conf loader will read all json files, sort them and load their values in an overriding order. Sorting is done in a descending, lexigraphical order.</p>
 <pre class="prettyprint source lang-sh"><code>└── conf
     ├── 20-keef.json
     ├── 10-keef.json
     └── 30-keef.json</code></pre><p>Given the above directory of conf files, the server can be configured by pointing the <code>conf</code> arguments at the directory</p>
 <pre class="prettyprint source lang-sh"><code>node server --conf=$HOME/conf</code></pre><p>The configruation would be read in the following priority
 <code>10-keef.json &lt; 20-keef.json &lt; 30-keef.json</code></p>
 <p>where 20 overrides 10, and 30 overrides 20.</p>
-<h3>System defaults</h3><p>defaults are what they sound like. Sane defaults for values that are needed to get the application running. They are located in the Defaults module and are used only as fallback values.</p>
+<h3>Static File Defaults</h3><p>To Simplify configuration for deployments, <code>keef</code> will look for configuration files in fixed locations eliminating the need for run time configuration. File Locations are as follows:</p>
+<ol>
+<li>a file in the rooot of your project with the name <code>&lt;package.name&gt;</code>.<code>NODE_ENV</code>.<code>json</code> For example, if the <code>name</code> attribute in your package.json is <code>foobar</code>, and the environment var <code>NODE_ENV</code> is set as <code>production</code>, the file look up is <code>foobar.production.json</code>. If <code>NODE_ENV</code> is not set, it would be <code>foobar.development.json</code></li>
+<li>A json file named after your project name in the root of your project - <code>foobar.json</code></li>
+<li>A json file named after your project in a <code>.config</code> directory in the current users home directory - <code>.config/foobar.json</code></li>
+<li>A json file named after your project in the <code>/etc</code> directory - `/etc/foobar.json</li>
+</ol>
+<h3>ETCD2 Clusters</h3><p>For distributed deployments, An etcd2 cluster may be used for configuration purposes. To enable <code>etcd2</code> configuration loading, 2 environment variables should be set:</p>
+<ol>
+<li><code>etcd__hosts</code> - A comma separated list of <code>host</code>:<code>port</code> addresses - <code>etcd1.domain.com:4001,etcd2.domain.com:4001</code>.</li>
+<li><code>etcd__namespace</code> - a keyspace to keep data separate from everything else.</li>
+</ol>
+<p>Any configuration that is stored as object, we be translated into <code>etcd</code> directories automatically</p>
+<pre class="prettyprint source lang-js"><code>keef.set('a:b:c', 1)
+
+// Object data
+{
+  &quot;a&quot;: {
+    &quot;b&quot;: {
+      &quot;c&quot;: 1
+    }
+  }
+}
+
+// etc data
+/a/b/c 1</code></pre><h3>System defaults</h3><p>defaults are what they sound like. Sane defaults for values that are needed to get the application running. They are located in the Defaults module and are used only as fallback values.</p>
 <h3>Option Shorthands</h3><p>Top level options can be aliased. Short hand aliases can be found and defined in the Shorthands module of <code>keef-conf</code></p>
 <table>
 <thead>
@@ -285,7 +310,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring.html b/docs/module-skyring.html
@@ -225,7 +225,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_json.html b/docs/module-skyring_lib_json.html
@@ -501,7 +501,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_nats.html b/docs/module-skyring_lib_nats.html
@@ -426,7 +426,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server.html b/docs/module-skyring_lib_server.html
@@ -1174,7 +1174,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_mock.html b/docs/module-skyring_lib_server_mock.html
@@ -226,7 +226,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_node.html b/docs/module-skyring_lib_server_node.html
@@ -1574,7 +1574,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_router.html b/docs/module-skyring_lib_server_router.html
@@ -1813,7 +1813,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_timer.html b/docs/module-skyring_lib_timer.html
@@ -1846,7 +1846,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_transports.html b/docs/module-skyring_lib_transports.html
@@ -344,7 +344,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_transports_http.html b/docs/module-skyring_lib_transports_http.html
@@ -374,7 +374,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_transports_timer.html b/docs/module-skyring_lib_transports_timer.html
@@ -212,7 +212,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/modules.list.html b/docs/modules.list.html
@@ -208,7 +208,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/node_modules_keef_index.js.html b/docs/node_modules_keef_index.js.html
@@ -110,8 +110,8 @@ <h1 class="page-title">Source: node_modules/keef/index.js</h1>
 }
 ```
 
-### Conf File
-The `conf` options can be set to read specific configuration from a file(s). The value should be a full path. If the path points to a directory, the conf loader will read all json files, sort them and load their values in an overriding order. Sorting is done in a descending, lexigraphical order.
+### Conf Options
+The `conf` option can be set to read specific configuration from a file(s). The value should be a full path. If the path points to a directory, the conf loader will read all json files, sort them and load their values in an overriding order. Sorting is done in a descending, lexigraphical order.
 
 ```sh
 └── conf
@@ -131,6 +131,39 @@ <h1 class="page-title">Source: node_modules/keef/index.js</h1>
 
 where 20 overrides 10, and 30 overrides 20.
 
+### Static File Defaults
+
+To Simplify configuration for deployments, `keef` will look for configuration files in fixed locations eliminating the need for run time configuration. File Locations are as follows:
+
+1. a file in the rooot of your project with the name `&lt;package.name>`.`NODE_ENV`.`json` For example, if the `name` attribute in your package.json is `foobar`, and the environment var `NODE_ENV` is set as `production`, the file look up is `foobar.production.json`. If `NODE_ENV` is not set, it would be `foobar.development.json`
+2. A json file named after your project name in the root of your project - `foobar.json`
+3. A json file named after your project in a `.config` directory in the current users home directory - `.config/foobar.json`
+4. A json file named after your project in the `/etc` directory - `/etc/foobar.json
+
+### ETCD2 Clusters
+
+For distributed deployments, An etcd2 cluster may be used for configuration purposes. To enable `etcd2` configuration loading, 2 environment variables should be set:
+1. `etcd__hosts` - A comma separated list of `host`:`port` addresses - `etcd1.domain.com:4001,etcd2.domain.com:4001`.
+2. `etcd__namespace` - a keyspace to keep data separate from everything else.
+
+Any configuration that is stored as object, we be translated into `etcd` directories automatically
+
+```js
+keef.set('a:b:c', 1)
+
+// Object data
+{
+  "a": {
+    "b": {
+      "c": 1
+    }
+  }
+}
+
+// etc data
+/a/b/c 1
+```
+
 ### System defaults
 defaults are what they sound like. Sane defaults for values that are needed to get the application running. They are located in the {@link module:keef-conf/lib/defaults|Defaults} module and are used only as fallback values.
 
@@ -202,11 +235,11 @@ <h1 class="page-title">Source: node_modules/keef/index.js</h1>
          .defaults( defaults );
 
 try{
-   pkg     = path.join(overrides.PROJECT_ROOT, 'package.json')
-   pkgname = require(pkg).name.replace('-','.')
+   pkg     = path.join(overrides.PROJECT_ROOT, 'package.json');
+   pkgname = require(pkg).name.trim();
 } catch( e ){
-   debug('package error ', e.message)
-   pkgname = 'megadoomer'
+   debug('package error ', e.message);
+   pkgname = 'default';
 }
 
 pkgfile = pkgname +'.json'
@@ -350,7 +383,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-02T20:02:53-06:00
+		on 2017-01-02T20:53:53-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/quicksearch.html b/docs/quicksearch.html