Repository: incubator-streams-examples Updated Branches: refs/heads/master 97fca1ac5 -> 34c1a7be2
root level example reference pages 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/e949f585 Tree: http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/tree/e949f585 Diff: http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/diff/e949f585 Branch: refs/heads/master Commit: e949f58545aab00e922b3e928d2b080d1ac49553 Parents: 97fca1a Author: Steve Blackmon @steveblackmon <sblack...@apache.org> Authored: Tue Oct 11 16:24:48 2016 -0500 Committer: Steve Blackmon @steveblackmon <sblack...@apache.org> Committed: Tue Oct 11 16:24:48 2016 -0500 ---------------------------------------------------------------------- src/site/markdown/credentials/twitter.md | 22 ++++++++++++++++ src/site/markdown/install/docker.md | 23 +++++++++++++++++ src/site/markdown/install/git.md | 13 ++++++++++ src/site/markdown/install/java.md | 17 ++++++++++++ src/site/markdown/install/maven.md | 20 ++++++++++++++ src/site/markdown/install/sbt.md | 15 +++++++++++ src/site/markdown/services/elasticsearch.md | 33 ++++++++++++++++++++++++ src/site/markdown/services/mongo.md | 33 ++++++++++++++++++++++++ src/site/markdown/services/neo4j.md | 28 ++++++++++++++++++++ src/site/site.xml | 25 +++++++++--------- 10 files changed, 217 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/e949f585/src/site/markdown/credentials/twitter.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/credentials/twitter.md b/src/site/markdown/credentials/twitter.md new file mode 100644 index 0000000..098dabd --- /dev/null +++ b/src/site/markdown/credentials/twitter.md @@ -0,0 +1,22 @@ +## Twitter Credentials + +Create a local file `twitter.conf` with valid twitter credentials + + twitter { + oauth { + consumerKey = "" + consumerSecret = "" + accessToken = "" + accessTokenSecret = "" + } + } + +Log into developer.twitter.com + +Visit https://apps.twitter.com and create an application. + +Select your application and click into 'Keys and Access Tokens' + +The consumerKey and consumerSecret are application-wide. + +The accessToken and accessTokenSecret are per-user. http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/e949f585/src/site/markdown/install/docker.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/install/docker.md b/src/site/markdown/install/docker.md new file mode 100644 index 0000000..539b4df --- /dev/null +++ b/src/site/markdown/install/docker.md @@ -0,0 +1,23 @@ +## Docker + +Run from your command line: + + docker version + +| Possible result | Explanation | +|-----------------|-------------| +| bash: docker: No such file or directory | You need to install docker | +| Client: Version: < 1.0.0 | You need a newer version of docker | +| Server: Version: < 1.0.0 | You need a newer version of docker | +| Client: Version: > 1.0.0\nServer: Version: > 1.0.0 | You are all good | + +If you need to install docker, start here: + +[https://docs.docker.com/engine/installation/](https://docs.docker.com/engine/installation/) + +Run from your command line: + + docker ps + +If you see a (possibly empty) list of running containers, you are good. + http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/e949f585/src/site/markdown/install/git.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/install/git.md b/src/site/markdown/install/git.md new file mode 100644 index 0000000..42a1d2e --- /dev/null +++ b/src/site/markdown/install/git.md @@ -0,0 +1,13 @@ +#### Git + + git -version + +| Possible result | Explanation | +|-----------------|-------------| +| bash: git: No such file or directory | You need to install git | +| git version < 2.7 | You should upgrade git for security reasons | +| git version > 2.7 | You are all good | + +If you need to install docker, start here: + +[https://git-scm.com/book/en/v2/Getting-Started-Installing-Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/e949f585/src/site/markdown/install/java.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/install/java.md b/src/site/markdown/install/java.md new file mode 100644 index 0000000..05c79fd --- /dev/null +++ b/src/site/markdown/install/java.md @@ -0,0 +1,17 @@ +#### Java SDK + +Run from your command line: + + java -version + +| Possible result | Explanation | +|-----------------|-------------| +| Java Version >= 1.7.0u72) | You're all good | +| Java Version >= 1.8.0u25) | You're all good | +| Java Version < 1.7.0u72 | You need a newer JDK | +| Java Version < 1.8.0u25 | You need a newer JDK | + +If you need to install or upgrade Java, start here: + +[http://www.oracle.com/technetwork/java/javase/downloads/index.html](http://www.oracle.com/technetwork/java/javase/downloads/index.html) + http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/e949f585/src/site/markdown/install/maven.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/install/maven.md b/src/site/markdown/install/maven.md new file mode 100644 index 0000000..de620f2 --- /dev/null +++ b/src/site/markdown/install/maven.md @@ -0,0 +1,20 @@ +#### Maven + +Run from your command line: + + mvn -version + +| Possible result | Explanation | +|-----------------|-------------| +| -bash: mvn: command not found | You need to install maven | +| Error: JAVA_HOME is not defined correctly. | You need to install JDK | +| Apache Maven >= 3.2.5+\nJava Version >= 1.7.0u72) | You're all good | +| Apache Maven >= 3.2.5+\nJava Version >= 1.8.0u25) | You're all good | +| Apache Maven < 3.2.5 | You need a newer version of maven | +| Java Version < 1.7.0u72 | You need a newer version of maven | +| Java Version < 1.8.0u25 | You need a newer JDK | + +If you need to install maven, start here: + +[http://maven.apache.org/install.html](http://maven.apache.org/install.html) + http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/e949f585/src/site/markdown/install/sbt.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/install/sbt.md b/src/site/markdown/install/sbt.md new file mode 100644 index 0000000..8fa3d88 --- /dev/null +++ b/src/site/markdown/install/sbt.md @@ -0,0 +1,15 @@ +## SBT + +Run from your command line: + + sbt + +| Possible result | Explanation | +|-----------------|-------------| +| bash: sbt: command not found | You need to install sbt | + +You should really install sbt-extras, like this: + + curl -s https://raw.githubusercontent.com/paulp/sbt-extras/master/sbt > /usr/bin/sbtx && chmod 0755 /usr/bin/sbtx + +Now you can easily run the streams examples using SBT, like a boss. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/e949f585/src/site/markdown/services/elasticsearch.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/services/elasticsearch.md b/src/site/markdown/services/elasticsearch.md new file mode 100644 index 0000000..14454a7 --- /dev/null +++ b/src/site/markdown/services/elasticsearch.md @@ -0,0 +1,33 @@ +## Elasticsearch + +Start elasticsearch via docker with the docker maven plugin: + + docker -PdockerITs docker:start + +Confirm that elasticsearch is running: + + docker ps + +Confirm that host and post(s) are in property file: + + cat elasticsearch.properties + +Create a local file `elasticsearch.conf` with cluster details: + + elasticsearch { + hosts += ${es.tcp.host} + port = ${es.tcp.port} + clusterName = "elasticsearch" + } + +When configuring a stream, include these files: + + include "elasticsearch.properties" + include "elasticsearch.conf" + +Supply application-specific configuration as well: + + elasticsearch { + index: "" + type: "" + } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/e949f585/src/site/markdown/services/mongo.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/services/mongo.md b/src/site/markdown/services/mongo.md new file mode 100644 index 0000000..002c12d --- /dev/null +++ b/src/site/markdown/services/mongo.md @@ -0,0 +1,33 @@ +## Mongo + +Start mongo via docker with the docker maven plugin: + + docker -PdockerITs docker:start + +Confirm that elasticsearch is running: + + docker ps + +Confirm that host and post(s) are in property file: + + cat mongo.properties + +Create a local file `elasticsearch.conf` with cluster details: + + mongo { + host = ${mongo.tcp.host} + port = ${mongo.tcp.port} + } + +When configuring a stream, include these files: + + include "mongo.properties" + include "mongo.conf" + +Supply application-specific configuration as well: + + mongo { + db: "", + collection: "" + } + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/e949f585/src/site/markdown/services/neo4j.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/services/neo4j.md b/src/site/markdown/services/neo4j.md new file mode 100644 index 0000000..9d5895f --- /dev/null +++ b/src/site/markdown/services/neo4j.md @@ -0,0 +1,28 @@ +## Neo4j + +Start mongo via docker with the docker maven plugin: + + docker -PdockerITs docker:start + +Confirm that elasticsearch is running: + + docker ps + +Confirm that host and post(s) are in property file: + + cat neo4j.properties + +Create a local file `neo4j.conf` with cluster details: + + neo4j { + hostname = ${neo4j.tcp.host} + port = ${neo4j.tcp.port} + type = "neo4j" + graph = "data" + } + +When configuring a stream, include these files: + + include "neo4j.properties" + include "neo4j.conf" + http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/e949f585/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 5cde002..b85609c 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -19,19 +19,20 @@ <project> <custom> <fluidoSkin> - <topBarEnabled>true</topBarEnabled> + <topBarEnabled>false</topBarEnabled> <navBarStyle>navbar-inverse</navBarStyle> - <sideBarEnabled>false</sideBarEnabled> - <gitHub> - <projectId>apache/incubator-streams-examples</projectId> - <ribbonOrientation>right</ribbonOrientation> - <ribbonColor>black</ribbonColor> - </gitHub> - <twitter> - <user>ApacheStreams</user> - <showUser>true</showUser> - <showFollowers>true</showFollowers> - </twitter> + <sideBarEnabled>true</sideBarEnabled> </fluidoSkin> </custom> + <body> + <menu name="Overview" /> + <menu name="Projects" /> + <menu name="Resources" inherit="bottom" > + <item name="Install Git" href="install/git.html"/> + <item name="Install Java" href="install/java.html"/> + <item name="Install Maven" href="install/maven.html"/> + <item name="Install Docker" href="install/docker.html"/> + <item name="Install SBT" href="install/sbt.html"/> + </menu> + </body> </project> \ No newline at end of file
