Repository: incubator-streams-master Updated Branches: refs/heads/master fe4a2f69a -> d0fff9488
remove the tutorial menu as all relevant information has been re-organized under the examples section Project: http://git-wip-us.apache.org/repos/asf/incubator-streams-master/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-streams-master/commit/d0fff948 Tree: http://git-wip-us.apache.org/repos/asf/incubator-streams-master/tree/d0fff948 Diff: http://git-wip-us.apache.org/repos/asf/incubator-streams-master/diff/d0fff948 Branch: refs/heads/master Commit: d0fff94888e95622a57c596b58bcec4786fda71c Parents: fe4a2f6 Author: Steve Blackmon @steveblackmon <[email protected]> Authored: Wed Oct 12 13:00:56 2016 -0500 Committer: Steve Blackmon @steveblackmon <[email protected]> Committed: Wed Oct 12 13:00:56 2016 -0500 ---------------------------------------------------------------------- src/site/markdown/tutorial/build.md | 81 -------------------------- src/site/markdown/tutorial/database.md | 43 -------------- src/site/markdown/tutorial/docker.md | 18 ------ src/site/markdown/tutorial/environment.md | 34 ----------- src/site/site.xml | 9 +-- src/site/site_en.xml | 13 +---- 6 files changed, 4 insertions(+), 194 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/d0fff948/src/site/markdown/tutorial/build.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/tutorial/build.md b/src/site/markdown/tutorial/build.md deleted file mode 100644 index a940bdc..0000000 --- a/src/site/markdown/tutorial/build.md +++ /dev/null @@ -1,81 +0,0 @@ -## Build streams and streams-examples from source - -This tutorial assumes you are using linux or Mac OS X. - -### Setup Tools - -You'll need the following tools installed in your command line: - -* Git -* Java SDK -* Maven -* Docker - -#### 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 | - -#### Maven and Java SDK - -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 | - -#### 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 | - -See [streams-project-index.html](http://streams.incubator.apache.org/site/0.2-incubating/streams-project/index.html "streams-project/index.html") for more information. - -### Download Sources - -Run from your command line: - - git clone https://github.com/apache/incubator-streams - git clone https://github.com/apache/incubator-streams-examples - -### Build Projects - -Run from your command line: - - export MAVEN_OPTS="-Xmx2G" - cd incubator-streams - mvn clean install -Dmaven.test.skip.exec=true - -| Possible result | Explanation | -|-----------------|-------------| -| BUILD SUCCESSFUL | You are all good | -| BUILD FAILED | Check yourself | - - cd ../incubator-streams-examples - mvn clean package - -| Possible result | Explanation | -|-----------------|-------------| -| BUILD SUCCESSFUL | You are all good | -| BUILD FAILED | Check yourself | \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/d0fff948/src/site/markdown/tutorial/database.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/tutorial/database.md b/src/site/markdown/tutorial/database.md deleted file mode 100644 index 1d7d752..0000000 --- a/src/site/markdown/tutorial/database.md +++ /dev/null @@ -1,43 +0,0 @@ -## Set up databases to store and analyze streams content - -This tutorial assumes you are using linux or Mac OS X. - -### Confirm Docker is healthy - -We'll assume you've got docker up and running. - -Run from your command line: - - docker ps - -If you see a (possibly empty) list of running containers, you are good. - -### Run Elasticsearch - -Elasticsearch is a great database for storing content from your streams. - - docker run -d --name elasticsearch elasticsearch - -### Add Elasticsearch container details to your configuration - - echo $(docker-machine ip) - -Put the following into elasticsearch.conf (in the same directory as reference.conf) - - include "reference.conf" - elasticsearch { - hosts = [ - # paste the response from echo $(docker-machine ip) on this line - ] - protocol = "tcp" - port = 9300 - index = "streams" - indexes = [ - "streams" - ] - types = [ - "page" - "post" - ] - } - http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/d0fff948/src/site/markdown/tutorial/docker.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/tutorial/docker.md b/src/site/markdown/tutorial/docker.md deleted file mode 100644 index 132986b..0000000 --- a/src/site/markdown/tutorial/docker.md +++ /dev/null @@ -1,18 +0,0 @@ -## Set up a local environment to run streams - -Streams components can be embedded in a variety of data processing frameworks based on the problem and performance requirements at hand. - -A great way to get started collecting and indexing data is with streams-runtime-local and Docker. - -Several example streams are available from docker hub for tutorial purposes. - -### Confirm Docker is healthy - -We'll assume you've got docker up and running. - -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-master/blob/d0fff948/src/site/markdown/tutorial/environment.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/tutorial/environment.md b/src/site/markdown/tutorial/environment.md deleted file mode 100644 index 902c330..0000000 --- a/src/site/markdown/tutorial/environment.md +++ /dev/null @@ -1,34 +0,0 @@ -## Create a local folder to configure streams - -Pick a place on your file system that's easy to remember and reference with an absolution path. - -Create a new empty folder there and export the path to a variables. - - mkdir ~/streams - export STREAMS=$(cd ~streams; pwd) - -Next, create a configuration file to hold secrets for your streams to use. - - cd $STREAMS - touch reference.conf - -To get started, put the following into reference.conf - - twitter { - oauth { - consumerKey = "" - consumerSecret = "" - accessToken = "" - accessTokenSecret = "" - } - } - -Visit developer.twitter.com and create an application to obtain the above fields. - -The consumerKey and consumerSecret are application-wide. - -The accessToken and accessTokenSecret are per-user. They 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 - - http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/d0fff948/src/site/site.xml ---------------------------------------------------------------------- diff --git a/src/site/site.xml b/src/site/site.xml index 3e63fb7..2e969a8 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -80,18 +80,11 @@ <item name="streams-project" href="http://streams.incubator.apache.org/site/latest/streams-project"; /> <item name="streams-examples" href="http://streams.incubator.apache.org/site/latest/streams-examples/"; /> </menu> - <menu name="Tutorial"> - <item name="Build streams and streams-examples from source" href="tutorial/build.html" /> - <item name="Create a local folder to configure streams" href="tutorial/environment.html"/> - <item name="Set up a local docker environment" href="tutorial/docker.html" /> - <item name="Run a local database to store activity documents" href="tutorial/database.html" /> - <item name="Run twitter-history-elasticsearch" href="http://streams.incubator.apache.org/site/latest/streams-examples/streams-examples-local/twitter-history-elasticsearch/index.html"; /> - </menu> <menu name="Learn More"> + <item name="Run some official examples" href="http://streams.incubator.apache.org/site/latest/streams-examples/index.html"; /> <item name="Browse streams providers, processors, and persisters" href="http://streams.incubator.apache.org/site/latest/streams-project/streams-contrib/index.html"; /> <item name="View the official Apache Streams jsonschema files" href="http://streams.incubator.apache.org/site/latest/streams-project/streams-pojo/index.html"; /> <item name="View java POJOs generated from the official Apache Streams jsonschema files" href="http://streams.incubator.apache.org/site/latest/streams-project/streams-pojo/apidocs/org/apache/streams/pojo/json/package-summary.html"; /> - <item name="Check out some additional examples" href="http://streams.incubator.apache.org/site/latest/streams-examples/index.html"; /> </menu> <menu name="Other Resources"> <item name="ActivityStreams Homepage" href="http://activitystrea.ms"; /> http://git-wip-us.apache.org/repos/asf/incubator-streams-master/blob/d0fff948/src/site/site_en.xml ---------------------------------------------------------------------- diff --git a/src/site/site_en.xml b/src/site/site_en.xml index 5e612eb..1f68ba9 100644 --- a/src/site/site_en.xml +++ b/src/site/site_en.xml @@ -54,7 +54,7 @@ </script> ]]> </head> - <menu name="Overview" inherit="top"> + <menu name="Overview"> <item name="Overview" href="index.html" /> <item name="Architecture" href="architecture.html" /> <item name="Concepts" href="concepts.html" /> @@ -76,23 +76,16 @@ <item name="Release Process" href="release.html" /> <item name="Website Management" href="website.html" /> </menu> - <menu name="Projects" inherit="top"> + <menu name="Projects"> <item name="streams-master" href="http://streams.incubator.apache.org/site/latest/streams-master"; /> <item name="streams-project" href="http://streams.incubator.apache.org/site/latest/streams-project"; /> <item name="streams-examples" href="http://streams.incubator.apache.org/site/latest/streams-examples/"; /> </menu> - <menu name="Tutorial"> - <item name="Build streams and streams-examples from source" href="tutorial/build.html" /> - <item name="Create a local folder to configure streams" href="tutorial/environment.html"/> - <item name="Set up a local docker environment" href="tutorial/docker.html" /> - <item name="Run a local database to store activity documents" href="tutorial/database.html" /> - <item name="Run twitter-history-elasticsearch" href="http://streams.incubator.apache.org/site/latest/streams-examples/streams-examples-local/twitter-history-elasticsearch/index.html"; /> - </menu> <menu name="Learn More"> + <item name="Run some official examples" href="http://streams.incubator.apache.org/site/latest/streams-examples/index.html"; /> <item name="Browse streams providers, processors, and persisters" href="http://streams.incubator.apache.org/site/latest/streams-project/streams-contrib/index.html"; /> <item name="View the official Apache Streams jsonschema files" href="http://streams.incubator.apache.org/site/latest/streams-project/streams-pojo/index.html"; /> <item name="View java POJOs generated from the official Apache Streams jsonschema files" href="http://streams.incubator.apache.org/site/latest/streams-project/streams-pojo/apidocs/org/apache/streams/pojo/json/package-summary.html"; /> - <item name="Check out some additional examples" href="http://streams.incubator.apache.org/site/latest/streams-examples/index.html"; /> </menu> <menu name="Other Resources"> <item name="ActivityStreams Homepage" href="http://activitystrea.ms"; />
