From 7905d9b78c81e4047ace42c7b3e81a603a33d036 Mon Sep 17 00:00:00 2001
From: Spencer Alger <spencer@spenceralger.com>
Date: Mon, 11 Nov 2013 15:41:48 -0700
Subject: [PATCH] added stubs for the different doc pages, [ci skip]

---
 README.md                         |  18 +-
 docs/api.md                       | 379 ++++++++++++++++++++++++++++++
 docs/replacing_core_components.md |  11 +
 docs/setting_up_logging.md        |   3 +
 4 files changed, 406 insertions(+), 5 deletions(-)
 create mode 100644 docs/api.md
 create mode 100644 docs/replacing_core_components.md
 create mode 100644 docs/setting_up_logging.md

diff --git a/README.md b/README.md
index 7835ad5f4..ed6b4e791 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@ Official *low-level* client for Elasticsearch.
 ## Features
 
  - One-to-one mapping with REST API and other language clients
- - Generalized, pluggable architecture. See [replacing core components](TODO: details the peices that are replaceable)
+ - Generalized, pluggable architecture. See [replacing core components](docs/replacing_core_components.md)
  - Configurable, automatic discovery of cluster nodes
  - Persistent, Keep-Alive connections
  - Load balancing (with pluggable selection strategy) across all available nodes.
@@ -16,7 +16,7 @@ elasticsearch.js works great in node, as well as modern browsers (many thanks to
 
  - Node:
 
-  [![Build Status](https://travis-ci.com/elasticsearch/elasticsearch-js)](https://magnum.travis-ci.com/spenceralger/elasticsearch-js)
+  [![Build Status](https://magnum.travis-ci.com/spenceralger/elasticsearch-js.png?token=tsFxSKHtVKG8EZavSjXY)](https://magnum.travis-ci.com/spenceralger/elasticsearch-js)
 
  - Browsers (see [browser builds](#browser-builds)):
 
@@ -59,6 +59,14 @@ bower install elasticsearch-angular
 bower install elasticsearch-jquery
 ```
 
+## Docs
+ - [Configuration](#configuration)
+ - [API](docs/api.md)
+ - [Replacing Core Components](docs/replacing_core_components.md)
+ - [Errors](docs/errors.md)
+ - [Setting Up Logging](docs/setting_up_logging.md)
+ - [FAQ](#faq)
+
 ## Configuration
 
 The `Client` constructor accepts a single object as it's argument, and the following keys can be used to configure that client instance:
@@ -95,7 +103,7 @@ log: {
 }
 ```
 
-Unless a constructor is specified, this sets the output settings for the bundled logger. See [setting up logging](TODO: detail logging why) for more information.
+Unless a constructor is specified, this sets the output settings for the bundled logger. See [setting up logging](docs/setting_up_logging.md) for more information.
 
 ### connectionClass
 Type: `String`, `Constructor`
@@ -148,7 +156,7 @@ Type: `Number`
 
 Defailt: `3`
 
-How many times should the client try to connect to other nodes before returning a [ConnectionFault](TODO: error types) error. (see [node death](#node-death))
+How many times should the client try to connect to other nodes before returning a [ConnectionFault](docs/error.md#connectionfault) error. (see [node death](#node-death))
 
 ### timeout
 Type: `Number`
@@ -202,7 +210,7 @@ The number of milliseconds this request has to complete. It defaults to the time
 
 ### Methods
 
-All the methods can be seen [here](TODO: api docs), or take a look at [api.js](src/lib/api.js).
+All the methods can be seen [here](docs/api.md), or take a look at [api.js](src/lib/api.js).
 
 ### Examples
 
diff --git a/docs/api.md b/docs/api.md
new file mode 100644
index 000000000..54132713d
--- /dev/null
+++ b/docs/api.md
@@ -0,0 +1,379 @@
+# API
+
+## Table Of Contents
+
+TODO: generate this when the js_api is generated
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
+
+### MethodName [more info](http://elasticsearch.com)
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Type</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+  <tr>
+    <td>Param Name</td>
+    <td>String</td>
+    <td>This is an important param</td>
+  </tr>
+</table>
diff --git a/docs/replacing_core_components.md b/docs/replacing_core_components.md
new file mode 100644
index 000000000..f219f32cd
--- /dev/null
+++ b/docs/replacing_core_components.md
@@ -0,0 +1,11 @@
+# Replacing Core Components
+
+TODO: detail the components that are replaceable
+
+## API
+
+## Connection
+
+## ConnectionPool
+
+## Log
diff --git a/docs/setting_up_logging.md b/docs/setting_up_logging.md
new file mode 100644
index 000000000..7f3cdbf82
--- /dev/null
+++ b/docs/setting_up_logging.md
@@ -0,0 +1,3 @@
+# Setting Up Logging
+
+TODO: what are loggers, how to use bunyan/winston