create index.md for most modules
Project: http://git-wip-us.apache.org/repos/asf/incubator-streams/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-streams/commit/6e5e5c20 Tree: http://git-wip-us.apache.org/repos/asf/incubator-streams/tree/6e5e5c20 Diff: http://git-wip-us.apache.org/repos/asf/incubator-streams/diff/6e5e5c20 Branch: refs/heads/STREAMS-389 Commit: 6e5e5c207269e77eabdbd8f9093f1f2db7132c24 Parents: 89e10dd Author: Steve Blackmon <sblack...@apache.org> Authored: Mon Mar 28 08:26:50 2016 -0500 Committer: Steve Blackmon <sblack...@apache.org> Committed: Mon Mar 28 08:26:50 2016 -0500 ---------------------------------------------------------------------- README.md | 2 + src/site/markdown/index.md | 22 +++----- .../src/site/markdown/index.md | 6 +-- .../streams-filters/src/src/markdown/index.md | 6 +++ .../streams-http/src/site/markdown/index.md | 24 +++++++++ streams-config/src/site/markdown/index.md | 6 +++ .../src/site/markdown/index.md | 19 +++++++ .../src/site/markdown/index.md | 19 +++++++ .../src/site/markdown/index.md | 39 ++++++++++++++ .../src/site/markdown/index.md | 14 +++++ .../src/site/markdown/index.md | 54 ++++++++++++++++++++ .../src/site/markdown/index.md | 21 ++++++++ .../src/site/markdown/index.md | 28 ++++++++++ .../src/site/markdown/index.md | 15 ++++++ .../src/site/markdown/index.md | 15 ++++++ .../src/site/markdown/index.md | 6 +++ .../src/site/markdown/index.md | 6 +++ .../src/site/markdown/index.md | 14 +++++ .../src/site/markdown/index.md | 6 +++ .../src/site/markdown/index.md | 6 +++ .../src/main/resources/datasift.conf | 8 +++ .../src/site/markdown/index.md | 10 ++-- .../src/main/resources/facebook.conf | 0 .../src/site/markdown/index.md | 5 +- .../gnip-powertrack/src/site/markdown/index.md | 13 +++++ .../google-gmail/src/site/markdown/index.md | 8 ++- .../google-gplus/src/site/markdown/index.md | 6 +-- .../src/site/markdown/index.md | 4 +- .../src/site/markdown/index.md | 5 +- .../src/site/markdown/index.md | 5 +- .../src/site/markdown/index.md | 5 +- .../src/site/markdown/index.md | 5 +- .../src/site/markdown/index.md | 19 +++++++ streams-core/src/site/markdown/index.md | 6 +++ streams-monitoring/src/site/markdown/index.md | 6 +++ streams-pojo-extensions/README.md | 7 +-- .../src/site/markdown/README.md | 6 +++ streams-pojo/src/site/markdown/index.md | 5 +- .../src/site/markdown/index.md | 14 +++++ .../src/site/markdown/index.md | 10 ++++ .../src/site/markdown/index.md | 6 +++ 41 files changed, 420 insertions(+), 61 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 32b3c03..92d2627 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,5 @@ Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 -------------------------------------------------------------------------------- [README.md](src/site/markdown/index.md "README") + + http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md index 7dc4e4f..ba6bab8 100644 --- a/src/site/markdown/index.md +++ b/src/site/markdown/index.md @@ -1,14 +1,3 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - -# org.apache.streams:streams-project - -Release Notes -============= - -[CHANGELOG.md](CHANGELOG.md "CHANGELOG.md") - System Requirements =================== You need a platform that supports Java SE 7 or later. @@ -29,11 +18,14 @@ To build from source code: `mvn install` -Additional Documentation +Modules ======================== -[Modules](modules.md "Modules") +[Modules](modules.html "Modules") -[JavaDocs](apidocs/index.html "JavaDocs") +Release Notes +============= + +[CHANGELOG.md](CHANGELOG.md "CHANGELOG.md") -[TestJavaDocs](testapidocs/index.html "TestJavaDocs") +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-components/streams-converters/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-components/streams-converters/src/site/markdown/index.md b/streams-components/streams-converters/src/site/markdown/index.md index 8d8701b..782b13b 100644 --- a/streams-components/streams-converters/src/site/markdown/index.md +++ b/streams-components/streams-converters/src/site/markdown/index.md @@ -1,8 +1,6 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - streams-converters ===================== Apply a filter to an activity stream, dropping any document that does not match the criteria + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-components/streams-filters/src/src/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-components/streams-filters/src/src/markdown/index.md b/streams-components/streams-filters/src/src/markdown/index.md new file mode 100644 index 0000000..f9703f9 --- /dev/null +++ b/streams-components/streams-filters/src/src/markdown/index.md @@ -0,0 +1,6 @@ +streams-processor-filters +===================== + +Apply a filter to an activity stream, dropping any document that does not match the criteria + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-components/streams-http/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-components/streams-http/src/site/markdown/index.md b/streams-components/streams-http/src/site/markdown/index.md new file mode 100644 index 0000000..9e0349a --- /dev/null +++ b/streams-components/streams-http/src/site/markdown/index.md @@ -0,0 +1,24 @@ +streams-processor-http +===================== + +Hit an http endpoint and place the result in extensions + +Example SimpleHTTPGetProcessor configuration: + + "http": { + "protocol": "http", + "hostname": "urls.api.twitter.com", + "port": 9300, + "resourceUri": "1/urls/count.json" + } + +Example SimpleHTTPPostPersistWriter configuration: + + "http": { + "protocol": "http", + "hostname": "localhost", + "port": 7474, + "resourceUri": "db/data/cypher" + } + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-config/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-config/src/site/markdown/index.md b/streams-config/src/site/markdown/index.md new file mode 100644 index 0000000..d962357 --- /dev/null +++ b/streams-config/src/site/markdown/index.md @@ -0,0 +1,6 @@ +streams-config +============== + +streams-config provides a centralized configuration system for streams. + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/site/markdown/index.md b/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/site/markdown/index.md new file mode 100644 index 0000000..cc64ce9 --- /dev/null +++ b/streams-contrib/streams-amazon-aws/streams-persist-kinesis/src/site/markdown/index.md @@ -0,0 +1,19 @@ +streams-persist-kinesis +============== + +Read/Write documents to/from Kinesis. + +Example writer configuration: + + "kinesis": { + "key": "", + "secretKey": "", + "protocol": "HTTPS", + "region": "us-east-1", + "streams: [ + "topic1", + "topic2" + ] + } + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-amazon-aws/streams-persist-s3/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-amazon-aws/streams-persist-s3/src/site/markdown/index.md b/streams-contrib/streams-amazon-aws/streams-persist-s3/src/site/markdown/index.md new file mode 100644 index 0000000..84b8a76 --- /dev/null +++ b/streams-contrib/streams-amazon-aws/streams-persist-s3/src/site/markdown/index.md @@ -0,0 +1,19 @@ +streams-persist-s3 +============== + +Write documents to an S3 bucket. + +Example writer configuration: + + "s3": { + "key": "", + "secretKey": "", + "bucket": "", + "protocol": "HTTP", + "writerPath": "path/", + "writerFilePrefix": "prefix", + "chunk": false, + "region": "us-east-1" + } + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-persist-elasticsearch/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-elasticsearch/src/site/markdown/index.md b/streams-contrib/streams-persist-elasticsearch/src/site/markdown/index.md new file mode 100644 index 0000000..5771838 --- /dev/null +++ b/streams-contrib/streams-persist-elasticsearch/src/site/markdown/index.md @@ -0,0 +1,39 @@ +streams-persist-elasticsearch +===================== + +Read and write to Elasticsearch + +Example reader configuration: + + "elasticsearch": { + "hosts": [ + "localhost" + ], + "port": 9300, + "clusterName": "elasticsearch", + "indexes": [ + "sourceindex" + ], + "types": [ + "sourcetype" + ], + "_search": { + "query" : { + "match_all" : { } + } + } + } + +Example writer configuration: + + "elasticsearch": { + "hosts": [ + "localhost" + ], + "port": 9300, + "clusterName": "elasticsearch", + "index": "destinationindex", + "type": "destinationtype + } + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-persist-filebuffer/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-filebuffer/src/site/markdown/index.md b/streams-contrib/streams-persist-filebuffer/src/site/markdown/index.md new file mode 100644 index 0000000..6634d72 --- /dev/null +++ b/streams-contrib/streams-persist-filebuffer/src/site/markdown/index.md @@ -0,0 +1,14 @@ +streams-persist-file +===================== + +Read to / write from File-backed Queue + +Example reader/writer configuration: + + file { + path = "/tmp/file-queue.txt" + } + +Reader will consume lines from Writer + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-persist-graph/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-graph/src/site/markdown/index.md b/streams-contrib/streams-persist-graph/src/site/markdown/index.md new file mode 100644 index 0000000..1073696 --- /dev/null +++ b/streams-contrib/streams-persist-graph/src/site/markdown/index.md @@ -0,0 +1,54 @@ +streams-persist-graph +===================== + +Build a graph index of a stream + +Example Neo4J writer configuration: + + { + "graph": { + "type": "neo4j", + "protocol": "http", + "hostname": "localhost", + "port": 7474, + "graph": "data" + "vertices": { + "objects": [ + "actor", + "object" + ], + "verbs": [ + "follow" + ], + "objectTypes": [ + "page" + ] + } + }, + } + +Example Neo4J reader configuration: + + { + "graph": { + "type": "neo4j", + "protocol": "http", + "hostname": "localhost", + "port": 7474, + "graph": "data" + "query": { + "objects": [ + "actor", + "object" + ], + "verbs": [ + "follow" + ], + "objectTypes": [ + "page" + ] + } + }, + } + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-persist-hbase/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hbase/src/site/markdown/index.md b/streams-contrib/streams-persist-hbase/src/site/markdown/index.md new file mode 100644 index 0000000..8892566 --- /dev/null +++ b/streams-contrib/streams-persist-hbase/src/site/markdown/index.md @@ -0,0 +1,21 @@ +streams-persist-hbase +===================== + +Read and write to HBase + +Example reader or writer configuration: + + hbase { + rootdir = "hdfs://cloudera-vm-local:8020/hbase" + zookeeper { + quorum = "cloudera-vm-local" + property { + clientPort = 2181 + } + } + table = "test_table" + family = "test_family" + qualifier = "test_column" + } + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-persist-hdfs/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-hdfs/src/site/markdown/index.md b/streams-contrib/streams-persist-hdfs/src/site/markdown/index.md new file mode 100644 index 0000000..9393409 --- /dev/null +++ b/streams-contrib/streams-persist-hdfs/src/site/markdown/index.md @@ -0,0 +1,28 @@ +streams-persist-hdfs +===================== + +Read and write to HDFS + +Example reader configuration: + + hdfs { + host = "localhost" + port = "50070" + path = "/user/cloudera" + user = "cloudera" + password = "cloudera" + } + +Example writer configuration: + + hdfs { + host = "localhost" + port = "50070" + path = "/user/cloudera" + user = "cloudera" + password = "cloudera" + writerPath = "/history/twitter/example" + writerFilePrefix = "streams-" + } + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-persist-kafka/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-kafka/src/site/markdown/index.md b/streams-contrib/streams-persist-kafka/src/site/markdown/index.md new file mode 100644 index 0000000..0c99458 --- /dev/null +++ b/streams-contrib/streams-persist-kafka/src/site/markdown/index.md @@ -0,0 +1,15 @@ +streams-persist-kafka +===================== + +Read and write to Kafka + +Example reader / writer configuration: + + kafka { + brokerlist = "localhost:9092" + zkconnect = "localhost:2181" + topic = "topic" + groupId = "group" + } + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-persist-mongo/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-persist-mongo/src/site/markdown/index.md b/streams-contrib/streams-persist-mongo/src/site/markdown/index.md new file mode 100644 index 0000000..aa582cf --- /dev/null +++ b/streams-contrib/streams-persist-mongo/src/site/markdown/index.md @@ -0,0 +1,15 @@ +streams-persist-mongo +===================== + +Read and write to MongoDB + +Example configuration: + + "mongo": { + "host": "localhost", + "port": 27017, + "db": "local", + "collection": "startup_log" + } + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-processor-jackson/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-processor-jackson/src/site/markdown/index.md b/streams-contrib/streams-processor-jackson/src/site/markdown/index.md new file mode 100644 index 0000000..5258dc7 --- /dev/null +++ b/streams-contrib/streams-processor-jackson/src/site/markdown/index.md @@ -0,0 +1,6 @@ +streams-processor-jackson +===================== + +Jackson Utility Processors + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-processor-json/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-processor-json/src/site/markdown/index.md b/streams-contrib/streams-processor-json/src/site/markdown/index.md new file mode 100644 index 0000000..6acd936 --- /dev/null +++ b/streams-contrib/streams-processor-json/src/site/markdown/index.md @@ -0,0 +1,6 @@ +streams-processor-json +===================== + +JsonPath Utility Processors + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-processor-peoplepattern/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-processor-peoplepattern/src/site/markdown/index.md b/streams-contrib/streams-processor-peoplepattern/src/site/markdown/index.md new file mode 100644 index 0000000..397b796 --- /dev/null +++ b/streams-contrib/streams-processor-peoplepattern/src/site/markdown/index.md @@ -0,0 +1,14 @@ +streams-processor-peoplepattern +===================== + +PeoplePattern API Processors + +Example configuration: + + "peoplepattern": { + "username": "", + "password": "" + } + + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-processor-regex/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-processor-regex/src/site/markdown/index.md b/streams-contrib/streams-processor-regex/src/site/markdown/index.md new file mode 100644 index 0000000..610442e --- /dev/null +++ b/streams-contrib/streams-processor-regex/src/site/markdown/index.md @@ -0,0 +1,6 @@ +streams-processor-regex +===================== + +Regex Utility Processors + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-processor-urls/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-processor-urls/src/site/markdown/index.md b/streams-contrib/streams-processor-urls/src/site/markdown/index.md new file mode 100644 index 0000000..5ff6ff8 --- /dev/null +++ b/streams-contrib/streams-processor-urls/src/site/markdown/index.md @@ -0,0 +1,6 @@ +streams-processor-urls +===================== + +URL Utility Processors + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-datasift/src/main/resources/datasift.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-datasift/src/main/resources/datasift.conf b/streams-contrib/streams-provider-datasift/src/main/resources/datasift.conf new file mode 100644 index 0000000..a910a02 --- /dev/null +++ b/streams-contrib/streams-provider-datasift/src/main/resources/datasift.conf @@ -0,0 +1,8 @@ +datasift { + apiKey = "" + userName = "" + hashes = [ + "b8aaf7cec5faa2fadbd55d651933a31e", + "f41f054e2a2ba8d2e7b0d74f56e727d6" + ] +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-datasift/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-datasift/src/site/markdown/index.md b/streams-contrib/streams-provider-datasift/src/site/markdown/index.md index d0ee964..ff1ee68 100644 --- a/streams-contrib/streams-provider-datasift/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-datasift/src/site/markdown/index.md @@ -1,7 +1,3 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - streams-provider-datasift ============== @@ -21,5 +17,9 @@ streams-provider-datasift contains schema definitions, providers, conversions, a | Schema | |--------| -| [TwitterConfiguration.json](com/twitter/tweet.json "TwitterConfiguration.json") [TwitterConfiguration.html](apidocs/org/apache/streams/twitter/TwitterConfiguration.html "javadoc") | +| [DatasiftConfiguration.json](org/apache/streams/datasift/DatasiftConfiguration.json "DatasiftConfiguration.json") [DatasiftConfiguration.html](apidocs/org/apache/streams/datasift/DatasiftConfiguration.html "javadoc") | +| [DatasiftPushConfiguration.json](org/apache/streams/datasift/DatasiftPushConfiguration.json "DatasiftPushConfiguration.json") [DatasiftPushConfiguration.html](apidocs/org/apache/streams/datasift/DatasiftPushConfiguration.html "javadoc") | +| [DatasiftStreamConfiguration.json](org/apache/streams/datasift/DatasiftStreamConfiguration.json "DatasiftStreamConfiguration.json") [DatasiftStreamConfiguration.html](apidocs/org/apache/streams/datasift/DatasiftStreamConfiguration.html "javadoc") | +| [DatasiftWebhookConfiguration.json](org/apache/streams/datasift/DatasiftWebhookConfiguration.json "DatasiftWebhookConfiguration.json") [DatasiftWebhookConfiguration.html](apidocs/org/apache/streams/datasift/DatasiftWebhookConfiguration.html "javadoc") | +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-facebook/src/main/resources/facebook.conf ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-facebook/src/main/resources/facebook.conf b/streams-contrib/streams-provider-facebook/src/main/resources/facebook.conf new file mode 100644 index 0000000..e69de29 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-facebook/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-facebook/src/site/markdown/index.md b/streams-contrib/streams-provider-facebook/src/site/markdown/index.md index 423fb3c..8f61f13 100644 --- a/streams-contrib/streams-provider-facebook/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-facebook/src/site/markdown/index.md @@ -1,7 +1,3 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - streams-provider-facebook ============== @@ -20,3 +16,4 @@ streams-provider-facebook contains schema definitions, providers, conversions, a | [FacebookConfiguration.json](org/apache/streams/facebook/FacebookConfiguration.json "FacebookConfiguration.json") [FacebookConfiguration.html](apidocs/org/apache/streams/facebook/FacebookConfiguration.html "javadoc") | +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-gnip/gnip-powertrack/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-gnip/gnip-powertrack/src/site/markdown/index.md b/streams-contrib/streams-provider-gnip/gnip-powertrack/src/site/markdown/index.md new file mode 100644 index 0000000..d38685e --- /dev/null +++ b/streams-contrib/streams-provider-gnip/gnip-powertrack/src/site/markdown/index.md @@ -0,0 +1,13 @@ +gnip-powertrack +============== + +gnip-powertrack contains schema definitions, providers, conversions, and utility classes. + +## Data Types + +| Schema | +|--------| +| [Gnip.json](com/gnip/Gnip.json "Gnip.json") +| [entry.xsd](com/gnip/entry.xsd "entry.xsd") + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-google/google-gmail/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-google/google-gmail/src/site/markdown/index.md b/streams-contrib/streams-provider-google/google-gmail/src/site/markdown/index.md index cd68c94..8ca848f 100644 --- a/streams-contrib/streams-provider-google/google-gmail/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-google/google-gmail/src/site/markdown/index.md @@ -1,7 +1,3 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - org.apache.streams:google-gmail =============================== @@ -17,4 +13,6 @@ google-gmail contains providers, conversions, and utility classes for activity e | Class | Class JavaDoc | |-------|---------------| -| GMailProvider | [GMailProvider.html](apidocs/com/google/gmail/provider/GMailProvider.html "GMailProvider.html") | [TwitterUserInformationConfiguration.json](com/twitter/TwitterUserInformationConfiguration.json "TwitterUserInformationConfiguration.json") | \ No newline at end of file +| GMailProvider | [GMailProvider.html](apidocs/com/google/gmail/provider/GMailProvider.html "GMailProvider.html") | [TwitterUserInformationConfiguration.json](com/twitter/TwitterUserInformationConfiguration.json "TwitterUserInformationConfiguration.json") | + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md b/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md index e5272b3..2a88ec0 100644 --- a/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-google/google-gplus/src/site/markdown/index.md @@ -1,7 +1,3 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - org.apache.streams:google-gmail =============================== @@ -19,3 +15,5 @@ google-gplus contains providers, conversions, and utility classes for activity e |-------|---------------| | GPlusUserDataProvider | [GPlusUserDataProvider.html](apidocs/com/google/gplus/provider/GPlusUserDataProvider.html "GPlusUserDataProvider.html") | | GPlusUserActivityProvider | [GPlusUserActivityProvider.html](apidocs/com/google/gplus/provider/GPlusUserActivityProvider.html "GPlusUserActivityProvider.html") | + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-instagram/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-instagram/src/site/markdown/index.md b/streams-contrib/streams-provider-instagram/src/site/markdown/index.md index 95de3f3..4392e47 100644 --- a/streams-contrib/streams-provider-instagram/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-instagram/src/site/markdown/index.md @@ -15,4 +15,6 @@ Example configuration "3", "kevin" ] - } \ No newline at end of file + } + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-moreover/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-moreover/src/site/markdown/index.md b/streams-contrib/streams-provider-moreover/src/site/markdown/index.md index af2274e..d4a7f11 100644 --- a/streams-contrib/streams-provider-moreover/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-moreover/src/site/markdown/index.md @@ -1,7 +1,3 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - streams-provider-moreover ============== @@ -13,3 +9,4 @@ streams-provider-moreover contains schema definitions, providers, conversions, a [articles10.xsd](com/moreover/articles10.xsd "articles10.xsd") +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-rss/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-rss/src/site/markdown/index.md b/streams-contrib/streams-provider-rss/src/site/markdown/index.md index c7d221f..8a076cd 100644 --- a/streams-contrib/streams-provider-rss/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-rss/src/site/markdown/index.md @@ -1,7 +1,3 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - streams-provider-rss ==================== @@ -17,3 +13,4 @@ streams-provider-rss |-------|---------------|--------------------------| | RssStreamProvider [RssStreamProvider.html](apidocs/org/apache/streams/rss/provider/RssStreamProvider.html "javadoc") | [RssStreamConfiguration.json](RssStreamConfiguration.json "RssStreamConfiguration.json") [RssStreamConfiguration.html](apidocs/org/apache/streams/rss/RssStreamConfiguration.html "javadoc") | [rss.conf](rss.conf "rss.conf") | +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md b/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md index b25b546..0858493 100644 --- a/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-sysomos/src/site/markdown/index.md @@ -1,7 +1,3 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - streams-provider-sysomos ============== @@ -26,4 +22,5 @@ streams-provider-sysomos contains schema definitions, providers, conversions, an |-------|---------------|--------------------------| | SysomosProvider [SysomosProvider.html](apidocs/org/apache/streams/sysomos/SysomosProvider.html "javadoc") | [SysomosConfiguration.json](com/sysomos/SysomosConfiguration.json "SysomosConfiguration.json") [SysomosConfiguration.html](apidocs/com/sysomos/SysomosConfiguration.html "javadoc") | [sysomos.conf](sysomos.conf "sysomos.conf") | +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-twitter/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-twitter/src/site/markdown/index.md b/streams-contrib/streams-provider-twitter/src/site/markdown/index.md index b55fc9c..576ad16 100644 --- a/streams-contrib/streams-provider-twitter/src/site/markdown/index.md +++ b/streams-contrib/streams-provider-twitter/src/site/markdown/index.md @@ -1,7 +1,3 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - org.apache.streams:streams-provider-twitter =========================================== @@ -33,3 +29,4 @@ streams-provider-twitter contains schema definitions, providers, conversions, an | TwitterStreamProvider [TwitterStreamProvider.html](apidocs/org/apache/streams/twitter/TwitterStreamProvider.html "javadoc") | [TwitterStreamConfiguration.json](com/twitter/TwitterStreamConfiguration.json "TwitterStreamConfiguration.json") [TwitterUserInformationConfiguration.html](apidocs/org/apache/streams/twitter/pojo/TwitterStreamConfiguration.html "javadoc") | [sample.conf](sample.conf "sample.conf")<br/>[userstream.conf](userstream.conf "userstream.conf") | | TwitterFollowingProvider [TwitterFollowingProvider.html](apidocs/org/apache/streams/twitter/TwitterFollowingConfiguration.html "javadoc") | [TwitterFollowingConfiguration.json](com/twitter/TwitterFollowingConfiguration.json "TwitterFollowingConfiguration.json") [TwitterFollowingConfiguration.html](apidocs/org/apache/streams/twitter/pojo/TwitterFollowingConfiguration.html "javadoc") | [friends.conf](friends.conf "friends.conf")<br/>[followers.conf](followers.conf "followers.conf") | +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-contrib/streams-provider-youtube/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-contrib/streams-provider-youtube/src/site/markdown/index.md b/streams-contrib/streams-provider-youtube/src/site/markdown/index.md new file mode 100644 index 0000000..d085d1e --- /dev/null +++ b/streams-contrib/streams-provider-youtube/src/site/markdown/index.md @@ -0,0 +1,19 @@ +org.apache.streams:streams-provider-youtube +=========================================== + +streams-provider-youtube contains providers, conversions, and utility classes. + +## Configuration + +| Schema | +|--------| +| [YoutubeConfiguration.json](com/youtube/YoutubeConfiguration.json "YoutubeConfiguration.json") [YoutubeConfiguration.html](apidocs/com/youtube/Youtube.html "javadoc") | + +## Components + +| Class | Configuration | +|-------|---------------| +| YoutubeChannelProvider [YoutubeChannelProvider.html](apidocs/com/youtube/provider/YoutubeChannelProvider.html "javadoc") | [YoutubeConfiguration.json](com/youtube/YoutubeConfiguration.json "YoutubeConfiguration.json") [YoutubeConfiguration.html](apidocs/com/youtube/YoutubeConfiguration.html "javadoc") +| YoutubeUserActivityProvider [YoutubeUserActivityProvider.html](apidocs/com/youtube/provider/YoutubeUserActivityProvider.html "javadoc") | [YoutubeConfiguration.json](com/youtube/YoutubeConfiguration.json "YoutubeConfiguration.json") [YoutubeConfiguration.html](apidocs/com/youtube/YoutubeConfiguration.html "javadoc") + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-core/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-core/src/site/markdown/index.md b/streams-core/src/site/markdown/index.md new file mode 100644 index 0000000..ce430f3 --- /dev/null +++ b/streams-core/src/site/markdown/index.md @@ -0,0 +1,6 @@ +streams-core +============== + +streams-core contains core classes and interfaces. + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-monitoring/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-monitoring/src/site/markdown/index.md b/streams-monitoring/src/site/markdown/index.md new file mode 100644 index 0000000..98ac1e6 --- /dev/null +++ b/streams-monitoring/src/site/markdown/index.md @@ -0,0 +1,6 @@ +streams-monitoring +============== + +streams-monitoring contains classes and interfaces for monitoring executing streams. + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-pojo-extensions/README.md ---------------------------------------------------------------------- diff --git a/streams-pojo-extensions/README.md b/streams-pojo-extensions/README.md index dd46309..608c73d 100644 --- a/streams-pojo-extensions/README.md +++ b/streams-pojo-extensions/README.md @@ -1,4 +1,5 @@ -streams-pojo-extensions -============== +org.apache.streams:streams-pojo-extensions +=========================================== + +[README.md](src/site/markdown/index.md "README") -Support for adding and modifying extension properties. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-pojo-extensions/src/site/markdown/README.md ---------------------------------------------------------------------- diff --git a/streams-pojo-extensions/src/site/markdown/README.md b/streams-pojo-extensions/src/site/markdown/README.md new file mode 100644 index 0000000..76169d7 --- /dev/null +++ b/streams-pojo-extensions/src/site/markdown/README.md @@ -0,0 +1,6 @@ +streams-pojo-extensions +============== + +Support for adding and modifying extension properties. + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-pojo/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-pojo/src/site/markdown/index.md b/streams-pojo/src/site/markdown/index.md index 23886b0..a041747 100644 --- a/streams-pojo/src/site/markdown/index.md +++ b/streams-pojo/src/site/markdown/index.md @@ -1,7 +1,3 @@ -Apache Streams (incubating) -Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 --------------------------------------------------------------------------------- - streams-pojo ============== @@ -29,3 +25,4 @@ streams-pojo contains ActivityStream json schema definitions and utility classes [activities](activities "activities/") +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-runtimes/streams-runtime-dropwizard/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-runtimes/streams-runtime-dropwizard/src/site/markdown/index.md b/streams-runtimes/streams-runtime-dropwizard/src/site/markdown/index.md new file mode 100644 index 0000000..ed6b35e --- /dev/null +++ b/streams-runtimes/streams-runtime-dropwizard/src/site/markdown/index.md @@ -0,0 +1,14 @@ +streams-runtime-dropwizard +============== + +streams-runtime-dropwizard can embed streams and stream components within the dropwizard framework. + +## Data Types + +[GenericWebhookData.json](GenericWebhookData.json "GenericWebhookData.json") + +## Configuration + +[StreamsDropwizardConfiguration.json](StreamsDropwizardConfiguration.json "StreamsDropwizardConfiguration.json") + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-runtimes/streams-runtime-local/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-runtimes/streams-runtime-local/src/site/markdown/index.md b/streams-runtimes/streams-runtime-local/src/site/markdown/index.md new file mode 100644 index 0000000..cab4d55 --- /dev/null +++ b/streams-runtimes/streams-runtime-local/src/site/markdown/index.md @@ -0,0 +1,10 @@ +streams-runtime-local +============== + +streams-runtime-local can execute streams in single-process multi-threaded mode. + +## Configuration + +[LocalRuntimeConfiguration.json](LocalRuntimeConfiguration.json "LocalRuntimeConfiguration.json") + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0 http://git-wip-us.apache.org/repos/asf/incubator-streams/blob/6e5e5c20/streams-runtimes/streams-runtime-pig/src/site/markdown/index.md ---------------------------------------------------------------------- diff --git a/streams-runtimes/streams-runtime-pig/src/site/markdown/index.md b/streams-runtimes/streams-runtime-pig/src/site/markdown/index.md new file mode 100644 index 0000000..6ffe209 --- /dev/null +++ b/streams-runtimes/streams-runtime-pig/src/site/markdown/index.md @@ -0,0 +1,6 @@ +streams-runtime-pig +============== + +streams-runtime-pig can embed streams processors within pig scripts. + +###### Licensed under Apache License 2.0 - http://www.apache.org/licenses/LICENSE-2.0
