seperate stream markdowns from module markdowns

Project: http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/commit/bed4b0f0
Tree: 
http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/tree/bed4b0f0
Diff: 
http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/diff/bed4b0f0

Branch: refs/heads/master
Commit: bed4b0f0db1f4b34ed9f39f78957f85ce5cabcab
Parents: 5b96588
Author: Steve Blackmon @steveblackmon <sblack...@apache.org>
Authored: Tue Oct 11 16:39:55 2016 -0500
Committer: Steve Blackmon @steveblackmon <sblack...@apache.org>
Committed: Tue Oct 11 16:39:55 2016 -0500

----------------------------------------------------------------------
 .../src/site/markdown/ElasticsearchHdfs.md      | 38 +++++------
 .../src/site/markdown/HdfsElasticsearch.md      | 38 +++++------
 .../src/site/markdown/index.md                  | 26 ++------
 .../src/site/markdown/ElasticsearchReindex.md   | 33 ++++++++++
 .../src/site/markdown/index.md                  | 49 +++-----------
 .../src/site/markdown/MongoElasticsearchSync.md | 32 +++++++++
 .../src/site/markdown/index.md                  | 69 +++-----------------
 .../markdown/TwitterHistoryElasticsearch.md     | 38 +++++++++++
 .../src/site/markdown/index.md                  | 56 +++-------------
 .../markdown/TwitterUserstreamElasticsearch.md  | 32 +++++++++
 .../src/site/markdown/index.md                  | 53 ++-------------
 11 files changed, 209 insertions(+), 255 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/elasticsearch-hdfs/src/site/markdown/ElasticsearchHdfs.md
----------------------------------------------------------------------
diff --git a/local/elasticsearch-hdfs/src/site/markdown/ElasticsearchHdfs.md 
b/local/elasticsearch-hdfs/src/site/markdown/ElasticsearchHdfs.md
index 6db4329..ad8ad4a 100644
--- a/local/elasticsearch-hdfs/src/site/markdown/ElasticsearchHdfs.md
+++ b/local/elasticsearch-hdfs/src/site/markdown/ElasticsearchHdfs.md
@@ -1,36 +1,32 @@
-elasticsearch-hdfs
-==============================
+### ElasticsearchHdfs
 
-Description:
------------------
+#### Description:
 
 Copies documents from elasticsearch to hdfs.
 
-Specification:
------------------
+#### Configuration:
 
-[ElasticsearchHdfs.dot](ElasticsearchHdfs.dot "ElasticsearchHdfs.dot" )
-
-Diagram:
------------------
+[ElasticsearchHdfsIT.conf](ElasticsearchHdfsIT.conf "ElasticsearchHdfsIT.conf" 
)
 
-![ElasticsearchHdfs.dot.svg](./ElasticsearchHdfs.dot.svg)
+#### Run (SBT):
 
-Example Configuration:
-----------------------
+    sbtx -210 -sbt-create
+    set resolvers += "Local Maven Repository" at 
"file://"+Path.userHome.absolutePath+"/.m2/repository"
+    set libraryDependencies += "org.apache.streams" % "elasticsearch-hdfs" % 
"0.4-incubating-SNAPSHOT"
+    set fork := true
+    set javaOptions +="-Dconfig.file=application.conf"
+    run elasticsearch-hdfs org.apache.streams.example.ElasticsearchHdfs
 
-[testBackup.json](testBackup.json "testBackup.json" )
+#### Run (Docker):
 
-Run (Local):
-------------
+    docker run apachestreams/elasticsearch-hdfs java -cp 
elasticsearch-hdfs-jar-with-dependencies.jar 
-Dconfig.url=http://<location_of_config_file> 
org.apache.streams.example.ElasticsearchHdfs
 
-    java -cp dist/elasticsearch-hdfs-jar-with-dependencies.jar 
-Dconfig.file=file://<location_of_config_file> 
org.apache.streams.elasticsearch.example.ElasticsearchHdfs
+#### Specification:
 
-Run (Docker):
--------------
+[ElasticsearchHdfs.dot](ElasticsearchHdfs.dot "ElasticsearchHdfs.dot" )
 
-    docker run elasticsearch-hdfs java -cp 
elasticsearch-hdfs-jar-with-dependencies.jar 
-Dconfig.url=http://<location_of_config_file> 
org.apache.streams.elasticsearch.example.ElasticsearchHdfs
+#### Diagram:
 
-[JavaDocs](apidocs/index.html "JavaDocs")
+![ElasticsearchHdfs.dot.svg](./ElasticsearchHdfs.dot.svg)
 
 ###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/elasticsearch-hdfs/src/site/markdown/HdfsElasticsearch.md
----------------------------------------------------------------------
diff --git a/local/elasticsearch-hdfs/src/site/markdown/HdfsElasticsearch.md 
b/local/elasticsearch-hdfs/src/site/markdown/HdfsElasticsearch.md
index 2f90e44..136b110 100644
--- a/local/elasticsearch-hdfs/src/site/markdown/HdfsElasticsearch.md
+++ b/local/elasticsearch-hdfs/src/site/markdown/HdfsElasticsearch.md
@@ -1,36 +1,32 @@
-hdfs-elasticsearch
-==============================
+### HdfsElasticsearch
 
-Description:
------------------
+#### Description:
 
 Copies documents from hdfs to elasticsearch.
 
-Specification:
------------------
+#### Configuration:
 
-[HdfsElasticsearch.dot](HdfsElasticsearch.dot "HdfsElasticsearch.dot" )
-
-Diagram:
------------------
+[HdfsElasticsearchIT.conf](HdfsElasticsearchIT.conf "HdfsElasticsearchIT.conf" 
)
 
-![HdfsElasticsearch.dot.svg](./HdfsElasticsearch.dot.svg)
+#### Run (SBT):
 
-Example Configuration:
-----------------------
+    sbtx -210 -sbt-create
+    set resolvers += "Local Maven Repository" at 
"file://"+Path.userHome.absolutePath+"/.m2/repository"
+    set libraryDependencies += "org.apache.streams" % "elasticsearch-hdfs" % 
"0.4-incubating-SNAPSHOT"
+    set fork := true
+    set javaOptions +="-Dconfig.file=HdfsElasticsearchIT.conf"
+    run elasticsearch-hdfs org.apache.streams.example.ElasticsearchHdfs
 
-[testRestore.json](testRestore.json "testRestore.json" )
+#### Run (Docker):
 
-Run (Local):
-------------
+    docker run elasticsearch-hdfs java -cp 
elasticsearch-hdfs-jar-with-dependencies.jar 
-Dconfig.file=`pwd`/HdfsElasticsearchIT.conf 
org.apache.streams.example.HdfsElasticsearch
 
-    java -cp dist/elasticsearch-hdfs-jar-with-dependencies.jar 
-Dconfig.file=file://<location_of_config_file> 
org.apache.streams.elasticsearch.example.HdfsElasticsearch
+#### Specification:
 
-Run (Docker):
--------------
+[HdfsElasticsearch.dot](HdfsElasticsearch.dot "HdfsElasticsearch.dot" )
 
-    docker run elasticsearch-hdfs java -cp 
elasticsearch-hdfs-jar-with-dependencies.jar 
-Dconfig.url=http://<location_of_config_file> 
org.apache.streams.elasticsearch.example.HdfsElasticsearch
+#### Diagram:
 
-[JavaDocs](apidocs/index.html "JavaDocs")
+![HdfsElasticsearch.dot.svg](./HdfsElasticsearch.dot.svg)
 
 ###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/elasticsearch-hdfs/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/local/elasticsearch-hdfs/src/site/markdown/index.md 
b/local/elasticsearch-hdfs/src/site/markdown/index.md
index b014a19..d789a2f 100644
--- a/local/elasticsearch-hdfs/src/site/markdown/index.md
+++ b/local/elasticsearch-hdfs/src/site/markdown/index.md
@@ -1,28 +1,19 @@
-elasticsearch-hdfs
-==============================
+### elasticsearch-hdfs
 
-Requirements:
--------------
- - A running ElasticSearch 1.0.0+ instance
+#### Requirements:
+ - A running ElasticSearch 2.0.0+ instance
 
-Description:
-------------
-Copies documents between elasticsearch and file system using the hdfs persist 
module.
-
-Streams:
---------
+#### Streams:
 
 <a href="HdfsElasticsearch.html" target="_self">HdfsElasticsearch</a>
 
 <a href="ElasticsearchHdfs.html" target="_self">ElasticsearchHdfs</a>
 
-Build:
----------
+#### Build:
 
     mvn clean install
 
-Testing:
----------
+#### Test:
 
 Start up elasticsearch with docker:
      
@@ -36,11 +27,6 @@ Shutdown elasticsearch when finished:
  
     mvn -PdockerITs docker:stop
 
-Deploy (Docker):
-----------------
-
-    mvn -Pdocker -Ddocker.repo=<your docker host>:<your docker repo> clean 
package docker:build docker:push
-
 [JavaDocs](apidocs/index.html "JavaDocs")
 
 ###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/elasticsearch-reindex/src/site/markdown/ElasticsearchReindex.md
----------------------------------------------------------------------
diff --git 
a/local/elasticsearch-reindex/src/site/markdown/ElasticsearchReindex.md 
b/local/elasticsearch-reindex/src/site/markdown/ElasticsearchReindex.md
new file mode 100644
index 0000000..2a2a6b2
--- /dev/null
+++ b/local/elasticsearch-reindex/src/site/markdown/ElasticsearchReindex.md
@@ -0,0 +1,33 @@
+### ElasticsearchReindex
+
+#### Description:
+
+Copies documents into a different index
+
+#### Configuration:
+
+[ElasticsearchReindexIT.conf](ElasticsearchReindexIT.conf 
"ElasticsearchReindexIT.conf" )
+
+#### Run (SBT):
+
+    sbtx -210 -sbt-create
+    set resolvers += "Local Maven Repository" at 
"file://"+Path.userHome.absolutePath+"/.m2/repository"
+    set libraryDependencies += "org.apache.streams" % "elasticsearch-reindex" 
% "0.4-incubating-SNAPSHOT"
+    set fork := true
+    set javaOptions +="-Dconfig.file=ElasticsearchReindexIT.conf"
+    run elasticsearch-hdfs org.apache.streams.example.ElasticsearchReindex
+
+#### Run (Docker):
+
+    docker run elasticsearch-reindex java -cp 
elasticsearch-reindex-jar-with-dependencies.jar 
-Dconfig.file=`pwd`/HdfsElasticsearchIT.conf 
org.apache.streams.example.ElasticsearchReindex
+
+#### Specification:
+
+[ElasticsearchReindex.dot](ElasticsearchReindex.dot "ElasticsearchReindex.dot" 
)
+
+#### Diagram:
+
+![ElasticsearchReindex.dot.svg](./ElasticsearchReindex.dot.svg)
+
+
+###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/elasticsearch-reindex/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/local/elasticsearch-reindex/src/site/markdown/index.md 
b/local/elasticsearch-reindex/src/site/markdown/index.md
index 8aa394d..87c3e04 100644
--- a/local/elasticsearch-reindex/src/site/markdown/index.md
+++ b/local/elasticsearch-reindex/src/site/markdown/index.md
@@ -1,35 +1,19 @@
-elasticsearch-reindex
-==============================
+### elasticsearch-reindex
 
-Requirements:
--------------
- - A running ElasticSearch 1.0.0+ cluster
+#### Requirements:
+ - A running ElasticSearch 2.0.0+ cluster
  - Transport client access to cluster
  - elasticsearch.version and lucene.version set to match cluster
 
-Description:
-------------
-Copies documents into a different index
+#### Streams:
 
-Specification:
------------------
+<a href="ElasticsearchReindex.html" target="_self">ElasticsearchReindex</a>
 
-[ElasticsearchReindex.dot](ElasticsearchReindex.dot "ElasticsearchReindex.dot" 
)
+#### Build:
 
-Diagram:
------------------
+    mvn clean install
 
-![ElasticsearchReindex.dot.svg](./ElasticsearchReindex.dot.svg)
-
-Example Configuration:
-----------------------
-
-[testReindex.json](testReindex.json "testReindex.json" )
-
-Populate source and destination in configuration with cluster / index / type 
details.
-
-Testing:
----------
+#### Testing:
 
 Start up elasticsearch with docker:
      
@@ -37,27 +21,12 @@ Start up elasticsearch with docker:
  
 Build with integration testing enabled, using your credentials
  
-    mvn clean test verify -DskipITs=false 
-DargLine="-Dconfig.file=`pwd`/application.conf"
+    mvn clean test verify -DskipITs=false
  
 Shutdown elasticsearch when finished:
  
     mvn -PdockerITs docker:stop
     
-Run (Local):
-------------
-
-    java -cp dist/elasticsearch-reindex-jar-with-dependencies.jar 
-Dconfig.file=file://<location_of_config_file> 
org.apache.streams.elasticsearch.example.ElasticsearchReindex
-
-Deploy (Docker):
-----------------
-
-    mvn -Pdocker -Ddocker.repo=<your docker host>:<your docker repo> 
docker:build docker:push
-
-Run (Docker):
--------------
-
-    docker run elasticsearch-reindex java -cp 
elasticsearch-reindex-jar-with-dependencies.jar 
-Dconfig.url=http://<location_of_config_file> 
org.apache.streams.elasticsearch.example.ElasticsearchReindex
-
 [JavaDocs](apidocs/index.html "JavaDocs")
 
 ###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/mongo-elasticsearch-sync/src/site/markdown/MongoElasticsearchSync.md
----------------------------------------------------------------------
diff --git 
a/local/mongo-elasticsearch-sync/src/site/markdown/MongoElasticsearchSync.md 
b/local/mongo-elasticsearch-sync/src/site/markdown/MongoElasticsearchSync.md
new file mode 100644
index 0000000..cdbdce1
--- /dev/null
+++ b/local/mongo-elasticsearch-sync/src/site/markdown/MongoElasticsearchSync.md
@@ -0,0 +1,32 @@
+### MongoElasticsearchSync
+
+#### Description:
+
+Copies documents from mongodb to elasticsearch
+
+#### Configuration:
+
+[MongoElasticsearchSyncIT.conf](MongoElasticsearchSyncIT.conf 
"MongoElasticsearchSyncIT.conf" )
+
+#### Run (SBT):
+
+    sbtx -210 -sbt-create
+    set resolvers += "Local Maven Repository" at 
"file://"+Path.userHome.absolutePath+"/.m2/repository"
+    set libraryDependencies += "org.apache.streams" % 
"mongo-elasticsearch-sync" % "0.4-incubating-SNAPSHOT"
+    set fork := true
+    set javaOptions +="-Dconfig.file=application.conf"
+    run mongo-elasticsearch-sync 
org.apache.streams.example.MongoElasticsearchSync
+
+#### Run (Docker):
+
+    docker run apachestreams/mongo-elasticsearch-sync java -cp 
mongo-elasticsearch-sync-jar-with-dependencies.jar 
org.apache.streams.example.MongoElasticsearchSync
+
+#### Specification:
+
+[MongoElasticsearchSync.dot](MongoElasticsearchSync.dot 
"MongoElasticsearchSync.dot" )
+
+#### Diagram:
+
+![MongoElasticsearchSync.dot.svg](./MongoElasticsearchSync.dot.svg)
+
+###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/mongo-elasticsearch-sync/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/local/mongo-elasticsearch-sync/src/site/markdown/index.md 
b/local/mongo-elasticsearch-sync/src/site/markdown/index.md
index 42512b6..526375b 100644
--- a/local/mongo-elasticsearch-sync/src/site/markdown/index.md
+++ b/local/mongo-elasticsearch-sync/src/site/markdown/index.md
@@ -1,80 +1,31 @@
-Apache Streams (incubating)
-Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0
---------------------------------------------------------------------------------
+### mongo-elasticsearch-sync
 
-mongo-elasticsearch-sync
-==============================
-
-Requirements:
--------------
+#### Requirements:
  - A running MongoDB 2.4+ instance
- - A running ElasticSearch 1.0.0+ instance
-
-Description:
-------------
-Copies documents from mongodb to elasticsearch
-
-Specification:
------------------
-
-[MongoElasticsearchSync.dot](MongoElasticsearchSync.dot 
"MongoElasticsearchSync.dot" )
+ - A running ElasticSearch 2.0+ instance
 
-Diagram:
------------------
+#### Streams:
 
-![MongoElasticsearchSync.dot.svg](./MongoElasticsearchSync.dot.svg)
+<a href="MongoElasticsearchSync.html" target="_self">MongoElasticsearchSync</a>
 
-Example Configuration:
-----------------------
-
-[testSync.json](testSync.json "testSync.json" )
-
-Build:
----------
+#### Build:
 
     mvn clean package
 
-Testing:
----------
-
-Create a local file `application.conf` with valid twitter credentials
-
-    twitter {
-      oauth {
-        consumerKey = ""
-        consumerSecret = ""
-        accessToken = ""
-        accessTokenSecret = ""
-      }
-    }
+#### Test:
 
 Start up elasticsearch and mongodb with docker:
     
-        mvn -PdockerITs docker:start
+    mvn -PdockerITs docker:start
 
-Build with integration testing enabled, using your credentials
+Build with integration testing enabled:
 
-    mvn clean test verify -DskipITs=false 
-DargLine="-Dconfig.file=`pwd`/application.conf"
+    mvn clean test verify -DskipITs=false
 
 Shutdown elasticsearch and mongodb when finished:
 
     mvn -PdockerITs docker:stop
 
-Run (Local):
-------------
-
-    java -cp dist/mongo-elasticsearch-sync-jar-with-dependencies.jar 
-Dconfig.file=file://<location_of_config_file> 
org.apache.streams.example.elasticsearch.MongoElasticsearchSync
-
-Deploy (Docker):
-----------------
-
-    mvn -Pdocker -Ddocker.repo=<your docker host>:<your docker repo> 
docker:build docker:push
-
-Run (Docker):
--------------
-
-    docker run mongo-elasticsearch-sync java -cp 
mongo-elasticsearch-sync-jar-with-dependencies.jar 
-Dconfig.url=http://<location_of_config_file> 
org.apache.streams.elasticsearch.example.MongoElasticsearchSync
-
 [JavaDocs](apidocs/index.html "JavaDocs")
 
 ###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0

http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/twitter-history-elasticsearch/src/site/markdown/TwitterHistoryElasticsearch.md
----------------------------------------------------------------------
diff --git 
a/local/twitter-history-elasticsearch/src/site/markdown/TwitterHistoryElasticsearch.md
 
b/local/twitter-history-elasticsearch/src/site/markdown/TwitterHistoryElasticsearch.md
new file mode 100644
index 0000000..9b696c2
--- /dev/null
+++ 
b/local/twitter-history-elasticsearch/src/site/markdown/TwitterHistoryElasticsearch.md
@@ -0,0 +1,38 @@
+### TwitterHistoryElasticsearch
+
+#### Description:
+
+Retrieves as many posts from a known list of users as twitter API allows.
+
+Converts them to activities, and writes them in activity format to 
Elasticsearch.
+
+#### Configuration:
+
+[TwitterHistoryElasticsearchIT.conf](TwitterHistoryElasticsearchIT.conf 
"TwitterHistoryElasticsearchIT.conf" )
+
+In the Twitter section you should place all of your relevant authentication 
keys and whichever Twitter IDs you want to pull history for.
+
+Twitter IDs can be converted from screennames at http://www.gettwitterid.com
+
+#### Run (SBT):
+
+    sbtx -210 -sbt-create
+    set resolvers += "Local Maven Repository" at 
"file://"+Path.userHome.absolutePath+"/.m2/repository"
+    set libraryDependencies += "org.apache.streams" % 
"twitter-history-elasticsearch" % "0.4-incubating-SNAPSHOT"
+    set fork := true
+    set javaOptions +="-Dconfig.file=application.conf"
+    run org.apache.streams.example.TwitterHistoryElasticsearch
+
+#### Run (Docker):
+
+    docker run apachestreams/twitter-history-elasticsearch java -cp 
twitter-history-elasticsearch-jar-with-dependencies.jar 
-Dconfig.file=`pwd`/application.conf 
org.apache.streams.example.TwitterHistoryElasticsearch
+
+#### Specification:
+
+[TwitterHistoryElasticsearch.dot](TwitterHistoryElasticsearch.dot 
"TwitterHistoryElasticsearch.dot" )
+
+#### Diagram:
+
+![TwitterHistoryElasticsearch.dot.svg](./TwitterHistoryElasticsearch.dot.svg)
+
+###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0

http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/twitter-history-elasticsearch/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/local/twitter-history-elasticsearch/src/site/markdown/index.md 
b/local/twitter-history-elasticsearch/src/site/markdown/index.md
index 22eee99..e737a12 100644
--- a/local/twitter-history-elasticsearch/src/site/markdown/index.md
+++ b/local/twitter-history-elasticsearch/src/site/markdown/index.md
@@ -1,43 +1,18 @@
-twitter-history-elasticsearch
-==============================
+### twitter-history-elasticsearch
 
-Requirements:
--------------
+#### Requirements:
  - Authorized Twitter API credentials
- - A running ElasticSearch 1.0.0+ instance
+ - A running ElasticSearch 2.0.0+ instance
 
-Description:
-------------
-Retrieves as many posts from a known list of users as twitter API allows.
+#### Streams:
 
-Converts them to activities, and writes them in activity format to 
Elasticsearch.
+<a href="TwitterHistoryElasticsearch.html" 
target="_self">TwitterHistoryElasticsearch</a>
 
-Specification:
------------------
-
-[TwitterHistoryElasticsearch.dot](TwitterHistoryElasticsearch.dot 
"TwitterHistoryElasticsearch.dot" )
-
-Diagram:
------------------
-
-![TwitterHistoryElasticsearch.dot.svg](./TwitterHistoryElasticsearch.dot.svg)
-
-Example Configuration:
-----------------------
-
-[application.conf](application.conf "application.conf" )
-
-In the Twitter section you should place all of your relevant authentication 
keys and whichever Twitter IDs you want to pull history for.
-
-Twitter IDs can be converted from screennames at http://www.gettwitterid.com
-
-Build:
----------
+#### Build:
 
     mvn clean package
    
-Testing:
----------
+#### Test:
 
 Create a local file `application.conf` with valid twitter credentials
 
@@ -52,7 +27,7 @@ Create a local file `application.conf` with valid twitter 
credentials
     
 Start up elasticsearch with docker:
     
-        mvn -PdockerITs docker:start
+    mvn -PdockerITs docker:start
 
 Build with integration testing enabled, using your credentials
 
@@ -62,21 +37,6 @@ Shutdown elasticsearch when finished:
 
     mvn -PdockerITs docker:stop
 
-Run (Local):
-------------
-
-    java -cp dist/twitter-history-elasticsearch-jar-with-dependencies.jar 
-Dconfig.file=file://<location_of_config_file> 
org.apache.streams.example.twitter.TwitterHistoryElasticsearch
-
-Deploy (Docker):
-----------------
-
-    mvn -Pdocker -Ddocker.repo=<your docker host>:<your docker repo> 
docker:build docker:push
-
-Run (Docker):
--------------
-
-    docker run twitter-history-elasticsearch java -cp 
twitter-history-elasticsearch-jar-with-dependencies.jar 
-Dconfig.url=http://<location_of_config_file> 
org.apache.streams.example.twitter.TwitterHistoryElasticsearch
-
 [JavaDocs](apidocs/index.html "JavaDocs")
 
 ###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0

http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/twitter-userstream-elasticsearch/src/site/markdown/TwitterUserstreamElasticsearch.md
----------------------------------------------------------------------
diff --git 
a/local/twitter-userstream-elasticsearch/src/site/markdown/TwitterUserstreamElasticsearch.md
 
b/local/twitter-userstream-elasticsearch/src/site/markdown/TwitterUserstreamElasticsearch.md
new file mode 100644
index 0000000..36f4244
--- /dev/null
+++ 
b/local/twitter-userstream-elasticsearch/src/site/markdown/TwitterUserstreamElasticsearch.md
@@ -0,0 +1,32 @@
+### TwitterUserstreamElasticsearch
+
+#### Description:
+
+This example connects to an active twitter account and stores the userstream 
as activities in Elasticsearch
+
+#### Configuration:
+
+[TwitterUserstreamElasticsearchIT.conf](TwitterUserstreamElasticsearchIT.conf 
"TwitterUserstreamElasticsearchIT.conf" )
+
+#### Run (SBT):
+
+    sbtx -210 -sbt-create
+    set resolvers += "Local Maven Repository" at 
"file://"+Path.userHome.absolutePath+"/.m2/repository"
+    set libraryDependencies += "org.apache.streams" % 
"twitter-userstream-elasticsearch" % "0.4-incubating-SNAPSHOT"
+    set fork := true
+    set javaOptions +="-Dconfig.file=application.conf"
+    run org.apache.streams.example.TwitterUserstreamElasticsearch
+
+#### Run (Docker):
+
+    docker run apachestreams/twitter-userstream-elasticsearch java -cp 
twitter-userstream-elasticsearch-jar-with-dependencies.jar 
-Dconfig.file=`pwd`/application.conf 
org.apache.streams.example.TwitterUserstreamElasticsearch
+
+#### Specification:
+
+[TwitterUserstreamElasticsearch.dot](TwitterUserstreamElasticsearch.dot 
"TwitterUserstreamElasticsearch.dot" )
+
+#### Diagram:
+
+![TwitterUserstreamElasticsearch.dot.svg](./TwitterUserstreamElasticsearch.dot.svg)
+
+###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0

http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/bed4b0f0/local/twitter-userstream-elasticsearch/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/local/twitter-userstream-elasticsearch/src/site/markdown/index.md 
b/local/twitter-userstream-elasticsearch/src/site/markdown/index.md
index f5379c9..833efde 100644
--- a/local/twitter-userstream-elasticsearch/src/site/markdown/index.md
+++ b/local/twitter-userstream-elasticsearch/src/site/markdown/index.md
@@ -1,42 +1,18 @@
-twitter-userstream-elasticsearch
-==============================
+### twitter-userstream-elasticsearch
 
-Requirements:
--------------
+#### Requirements:
  - Authorized Twitter API credentials
  - A running ElasticSearch 1.0.0+ instance
 
-Description:
-------------
-This example connects to an active twitter account and stores the userstream 
as activities in Elasticsearch
+#### Streams:
 
-Specification:
------------------
+<a href="TwitterUserstreamElasticsearch.html" 
target="_self">TwitterUserstreamElasticsearch</a>
 
-[TwitterUserstreamElasticsearch.dot](TwitterUserstreamElasticsearch.dot 
"TwitterUserstreamElasticsearch.dot" )
-
-Diagram:
------------------
-
-![TwitterUserstreamElasticsearch.dot.svg](./TwitterUserstreamElasticsearch.dot.svg)
-
-Example Configuration:
-----------------------
-
-[application.conf](application.conf "application.conf" )
-
-The consumerKey and consumerSecret are set for our streams-example application
-The accessToken and accessTokenSecret can be obtained by navigating to:
-
-    
https://api.twitter.com/oauth/authenticate?oauth_token=UIJ0AUxCJatpKDUyFt0OTSEP4asZgqxRwUCT0AMSwc&oauth_callback=http%3A%2F%2Foauth.streamstutorial.w2odata.com%3A8080%2Fsocialauthdemo%2FsocialAuthSuccessAction.do
-
-Build:
----------
+#### Build:
 
     mvn clean package
 
-Testing:
----------
+#### Test:
 
 Create a local file `application.conf` with valid twitter credentials
 
@@ -51,7 +27,7 @@ Create a local file `application.conf` with valid twitter 
credentials
 
 Start up elasticsearch with docker:
     
-        mvn -PdockerITs docker:start
+    mvn -PdockerITs docker:start
 
 Build with integration testing enabled, using your credentials
 
@@ -61,21 +37,6 @@ Shutdown elasticsearch when finished:
 
     mvn -PdockerITs docker:stop
 
-Run (Local):
-------------
-
-    java -cp dist/twitter-userstream-elasticsearch-jar-with-dependencies.jar 
-Dconfig.file=file://<location_of_config_file> 
org.apache.streams.example.twitter.TwitterUserstreamElasticsearch
-
-Deploy (Docker):
-----------------
-
-    mvn -Pdocker -Ddocker.repo=<your docker host>:<your docker repo> 
docker:build docker:push
-
-Run (Docker):
--------------
-
-    docker run twitter-userstream-elasticsearch java -cp 
twitter-userstream-elasticsearch-jar-with-dependencies.jar 
-Dconfig.url=http://<location_of_config_file> 
org.apache.streams.example.twitter.TwitterUserstreamElasticsearch
-
 [JavaDocs](apidocs/index.html "JavaDocs")
 
 ###### Licensed under Apache License 2.0 - 
http://www.apache.org/licenses/LICENSE-2.0

Reply via email to