You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streams.apache.org by sb...@apache.org on 2018/01/18 18:20:13 UTC
[streams] branch master updated: STREAMS-574: some missing website-related files

This is an automated email from the ASF dual-hosted git repository.

sblackmon pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/streams.git


The following commit(s) were added to refs/heads/master by this push:
     new 3eb7edf  STREAMS-574: some missing website-related files
3eb7edf is described below

commit 3eb7edf263306e6614cc21891dac15da7ca28dda
Author: Steve Blackmon @steveblackmon <sb...@apache.org>
AuthorDate: Thu Jan 18 12:20:04 2018 -0600

    STREAMS-574: some missing website-related files
---
 src/site/site.xml                                  |  4 +-
 streams-examples/src/site/markdown/index.md        | 57 ++++++++++++++++++++++
 .../src/site/site.xml                              | 23 +++++++--
 .../flink-twitter-collection/src/site/site.xml     |  2 +-
 .../src/site/markdown/flink.md                     | 12 +++++
 .../src/site/site.xml                              |  4 +-
 .../elasticsearch-hdfs/src/site/site.xml           |  2 +-
 .../elasticsearch-reindex/src/site/site.xml        |  2 +-
 .../mongo-elasticsearch-sync/src/site/site.xml     |  4 +-
 .../twitter-follow-neo4j/src/site/site.xml         |  4 +-
 .../src/site/site.xml                              |  4 +-
 .../src/site/site.xml                              |  4 +-
 12 files changed, 104 insertions(+), 18 deletions(-)

diff --git a/src/site/site.xml b/src/site/site.xml
index 9556854..ece305f 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -50,7 +50,7 @@
     </custom>
     <body>
         <breadcrumbs>
-            <item name="Streams" href="http://streams.apache.org/site/latest/streams-project"/>
+            <item name="Streams" href="http://streams.apache.org"/>
         </breadcrumbs>
         <head>
             <![CDATA[
@@ -70,7 +70,7 @@
             <item name="Architecture" href="architecture.html" />
             <item name="Concepts" href="concepts.html" />
             <item name="Downloads" href="downloads.html" />
-            <item name="Examples" href="http://streams.apache.org/site/latest/streams-examples/" />
+            <item name="Examples" href="streams-examples/index.html" />
             <item name="Frequently Asked Questions" href="faq.html" />
             <item name="Modules" href="modules.html" />
         </menu>
diff --git a/streams-examples/src/site/markdown/index.md b/streams-examples/src/site/markdown/index.md
new file mode 100644
index 0000000..f1dad19
--- /dev/null
+++ b/streams-examples/src/site/markdown/index.md
@@ -0,0 +1,57 @@
+## Overview
+Apache Streams unifies a diverse world of digital profiles and online activities into common formats and vocabularies, and makes these datasets accessible across a variety of databases, devices, and platforms for streaming, browsing, search, sharing, and analytics use-cases.
+
+### How do I use Streams?
+This repository contains officially maintained examples of how to compose and run streams in various contexts.
+
+### Getting Started
+
+Please visit the project website for the latest information:
+    http://streams.apache.org/
+
+Along with the developer mailing list archive:
+    https://lists.apache.org/list.html?dev@streams.apache.org
+
+### Building and running
+To build from source code:
+
+  - Requirements:
+    Sources compilation require Java SE 8 or higher.
+    Sources compilation require Apache Maven 3.3.9 or higher.
+    You need to download and install Maven 3 from: http://maven.apache.org/
+
+  - The Streams Examples project itself (this one) depends on the separate Streams project
+    which contains the source code and poms for Apache Streams.
+    As streams-project is already published to the Apache Releases repository,
+    there is no need to check it out manually and build it locally yourself,
+    unless you choose to checkout a SNAPSHOT branch.
+    
+    - If so needed, streams can be checked out from:
+      http://git-wip-us.apache.org/repos/asf/streams.git
+
+    - After check out, cd into streams and invoke maven to install it using:
+      
+            mvn install
+   
+  - To build all of the Streams examples, invoke maven with:
+      
+        mvn install
+
+### Integration Testing
+
+  *Integration Testing will fail unless you have a working docker installation and valid twitter credentials in local conf files.*
+  
+  - To run the full suite of integration tests, invoke maven with:
+        
+        mvn -N -PdockerITs docker:start
+        mvn clean verify -D
+        mvn -N -PdockerITs docker:stop
+
+  - To build and install a docker image containing a specific example, change to that example's directory then:
+      
+        mvn -Pdocker clean package docker:build
+
+### Disclaimer
+Apache Streams is an effort undergoing incubation at [The Apache Software Foundation (ASF)](http://apache.org) sponsored by the [Apache Incubator PMC](http://incubator.apache.org). Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or s [...]
+
+###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0
diff --git a/streams-examples/streams-examples-local/mongo-elasticsearch-sync/src/site/site.xml b/streams-examples/src/site/site.xml
similarity index 51%
copy from streams-examples/streams-examples-local/mongo-elasticsearch-sync/src/site/site.xml
copy to streams-examples/src/site/site.xml
index ddf50f2..0b15b63 100644
--- a/streams-examples/streams-examples-local/mongo-elasticsearch-sync/src/site/site.xml
+++ b/streams-examples/src/site/site.xml
@@ -17,10 +17,27 @@
   ~ under the License.
   -->
 <project>
+    <custom>
+        <fluidoSkin>
+            <topBarEnabled>true</topBarEnabled>
+            <navBarStyle>navbar-inverse</navBarStyle>
+            <sideBarEnabled>false</sideBarEnabled>
+            <gitHub>
+                <projectId>apache/streams-examples</projectId>
+                <ribbonOrientation>right</ribbonOrientation>
+                <ribbonColor>black</ribbonColor>
+            </gitHub>
+            <twitter>
+                <user>ApacheStreams</user>
+                <showUser>true</showUser>
+                <showFollowers>true</showFollowers>
+            </twitter>
+        </fluidoSkin>
+    </custom>
     <body>
-        <menu name="Services">
-            <item name="Elasticsearch" href="../../../streams-project/services/elasticsearch.html"/>
-            <item name="Mongo" href="../../../streams-project/services/mongo.html"/>
+        <menu name="Examples" inherit="top">
+            <item name="Flink" href="streams-examples-flink/index.html"/>
+            <item name="Local" href="streams-examples-local/index.html"/>
         </menu>
     </body>
 </project>
diff --git a/streams-examples/streams-examples-flink/flink-twitter-collection/src/site/site.xml b/streams-examples/streams-examples-flink/flink-twitter-collection/src/site/site.xml
index f801659..ecb2d87 100644
--- a/streams-examples/streams-examples-flink/flink-twitter-collection/src/site/site.xml
+++ b/streams-examples/streams-examples-flink/flink-twitter-collection/src/site/site.xml
@@ -19,7 +19,7 @@
 <project>
     <body>
         <menu name="Credentials">
-            <item name="Twitter" href="../../credentials/twitter.html"/>
+            <item name="Twitter" href="../../../credentials/twitter.html"/>
         </menu>
         <menu name="Runtime">
             <item name="Flink" href="../flink.html"/>
diff --git a/streams-examples/streams-examples-flink/src/site/markdown/flink.md b/streams-examples/streams-examples-flink/src/site/markdown/flink.md
new file mode 100644
index 0000000..151182b
--- /dev/null
+++ b/streams-examples/streams-examples-flink/src/site/markdown/flink.md
@@ -0,0 +1,12 @@
+## Flink
+
+Create a local file `flink.conf`
+
+    local = true
+    test = true
+
+When configuring a stream, include this file:
+
+    include "flink.conf"
+
+###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0
diff --git a/streams-examples/streams-examples-local/elasticsearch-hdfs/src/site/site.xml b/streams-examples/streams-examples-flink/src/site/site.xml
similarity index 86%
copy from streams-examples/streams-examples-local/elasticsearch-hdfs/src/site/site.xml
copy to streams-examples/streams-examples-flink/src/site/site.xml
index 5fb3b4d..3aba392 100644
--- a/streams-examples/streams-examples-local/elasticsearch-hdfs/src/site/site.xml
+++ b/streams-examples/streams-examples-flink/src/site/site.xml
@@ -18,8 +18,8 @@
   -->
 <project>
     <body>
-        <menu name="Services">
-            <item name="Elasticsearch" href="../../../streams-project/services/elasticsearch.html"/>
+        <menu name="Setup">
+            <item name="Flink" href="../flink.html"/>
         </menu>
     </body>
 </project>
diff --git a/streams-examples/streams-examples-local/elasticsearch-hdfs/src/site/site.xml b/streams-examples/streams-examples-local/elasticsearch-hdfs/src/site/site.xml
index 5fb3b4d..bd11fb0 100644
--- a/streams-examples/streams-examples-local/elasticsearch-hdfs/src/site/site.xml
+++ b/streams-examples/streams-examples-local/elasticsearch-hdfs/src/site/site.xml
@@ -19,7 +19,7 @@
 <project>
     <body>
         <menu name="Services">
-            <item name="Elasticsearch" href="../../../streams-project/services/elasticsearch.html"/>
+            <item name="Elasticsearch" href="../../../services/elasticsearch.html"/>
         </menu>
     </body>
 </project>
diff --git a/streams-examples/streams-examples-local/elasticsearch-reindex/src/site/site.xml b/streams-examples/streams-examples-local/elasticsearch-reindex/src/site/site.xml
index 5fb3b4d..bd11fb0 100644
--- a/streams-examples/streams-examples-local/elasticsearch-reindex/src/site/site.xml
+++ b/streams-examples/streams-examples-local/elasticsearch-reindex/src/site/site.xml
@@ -19,7 +19,7 @@
 <project>
     <body>
         <menu name="Services">
-            <item name="Elasticsearch" href="../../../streams-project/services/elasticsearch.html"/>
+            <item name="Elasticsearch" href="../../../services/elasticsearch.html"/>
         </menu>
     </body>
 </project>
diff --git a/streams-examples/streams-examples-local/mongo-elasticsearch-sync/src/site/site.xml b/streams-examples/streams-examples-local/mongo-elasticsearch-sync/src/site/site.xml
index ddf50f2..a7fee5e 100644
--- a/streams-examples/streams-examples-local/mongo-elasticsearch-sync/src/site/site.xml
+++ b/streams-examples/streams-examples-local/mongo-elasticsearch-sync/src/site/site.xml
@@ -19,8 +19,8 @@
 <project>
     <body>
         <menu name="Services">
-            <item name="Elasticsearch" href="../../../streams-project/services/elasticsearch.html"/>
-            <item name="Mongo" href="../../../streams-project/services/mongo.html"/>
+            <item name="Elasticsearch" href="../../../services/elasticsearch.html"/>
+            <item name="Mongo" href="../../../services/mongo.html"/>
         </menu>
     </body>
 </project>
diff --git a/streams-examples/streams-examples-local/twitter-follow-neo4j/src/site/site.xml b/streams-examples/streams-examples-local/twitter-follow-neo4j/src/site/site.xml
index e237768..b245040 100644
--- a/streams-examples/streams-examples-local/twitter-follow-neo4j/src/site/site.xml
+++ b/streams-examples/streams-examples-local/twitter-follow-neo4j/src/site/site.xml
@@ -19,10 +19,10 @@
 <project>
     <body>
         <menu name="Credentials">
-            <item name="Twitter" href="../../../streams-project/credentials/twitter.html"/>
+            <item name="Twitter" href="../../../credentials/twitter.html"/>
         </menu>
         <menu name="Services">
-            <item name="Neo4j" href="../../../streams-project/services/neo4j.html"/>
+            <item name="Neo4j" href="../../../services/neo4j.html"/>
         </menu>
     </body>
 </project>
diff --git a/streams-examples/streams-examples-local/twitter-history-elasticsearch/src/site/site.xml b/streams-examples/streams-examples-local/twitter-history-elasticsearch/src/site/site.xml
index 9033276..d5eacf3 100644
--- a/streams-examples/streams-examples-local/twitter-history-elasticsearch/src/site/site.xml
+++ b/streams-examples/streams-examples-local/twitter-history-elasticsearch/src/site/site.xml
@@ -19,10 +19,10 @@
 <project>
     <body>
         <menu name="Credentials">
-            <item name="Twitter" href="../../../streams-project/credentials/twitter.html"/>
+            <item name="Twitter" href="../../../credentials/twitter.html"/>
         </menu>
         <menu name="Services">
-            <item name="Elasticsearch" href="../../../streams-project/services/elasticsearch.html"/>
+            <item name="Elasticsearch" href="../../../services/elasticsearch.html"/>
         </menu>
     </body>
 </project>
diff --git a/streams-examples/streams-examples-local/twitter-userstream-elasticsearch/src/site/site.xml b/streams-examples/streams-examples-local/twitter-userstream-elasticsearch/src/site/site.xml
index 9033276..d5eacf3 100644
--- a/streams-examples/streams-examples-local/twitter-userstream-elasticsearch/src/site/site.xml
+++ b/streams-examples/streams-examples-local/twitter-userstream-elasticsearch/src/site/site.xml
@@ -19,10 +19,10 @@
 <project>
     <body>
         <menu name="Credentials">
-            <item name="Twitter" href="../../../streams-project/credentials/twitter.html"/>
+            <item name="Twitter" href="../../../credentials/twitter.html"/>
         </menu>
         <menu name="Services">
-            <item name="Elasticsearch" href="../../../streams-project/services/elasticsearch.html"/>
+            <item name="Elasticsearch" href="../../../services/elasticsearch.html"/>
         </menu>
     </body>
 </project>

-- 
To stop receiving notification emails like this one, please contact
['"commits@streams.apache.org" <co...@streams.apache.org>'].