habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added stubs for the different doc pages, [ci skip]

Browse Source
This commit is contained in:
Spencer Alger
2013-11-11 15:41:48 -07:00
parent 540035b93f
commit 7905d9b78c
4 changed files with 406 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

379
docs/api.md Normal file
View File

@ -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>

11
docs/replacing_core_components.md Normal file
View File

@ -0,0 +1,11 @@
# Replacing Core Components
TODO: detail the components that are replaceable
## API
## Connection
## ConnectionPool
## Log

3
docs/setting_up_logging.md Normal file
View File

@ -0,0 +1,3 @@
# Setting Up Logging
TODO: what are loggers, how to use bunyan/winston