[1/9] samza git commit: Clean-up the Quick-Start and Code-Examples pages; Re-organize content
Repository: samza Updated Branches: refs/heads/1.0.0 ed8d1da8b -> d034bbef8 Clean-up the Quick-Start and Code-Examples pages; Re-organize content Author: Jagadish Reviewers: Jagadish Closes #759 from vjagadish1989/website-reorg23 Project: http://git-wip-us.apache.org/repos/asf/samza/repo Commit: http://git-wip-us.apache.org/repos/asf/samza/commit/4b012326 Tree: http://git-wip-us.apache.org/repos/asf/samza/tree/4b012326 Diff: http://git-wip-us.apache.org/repos/asf/samza/diff/4b012326 Branch: refs/heads/1.0.0 Commit: 4b0123262bcb754de0311d617c4110480ed3bfaf Parents: ed8d1da Author: Jagadish Authored: Tue Oct 23 23:39:54 2018 -0700 Committer: Jagadish Committed: Tue Nov 13 19:28:10 2018 -0800 -- docs/_docs/replace-versioned.sh | 5 +- docs/_menu/index.html | 2 +- docs/startup/code-examples/versioned/index.md | 49 + docs/startup/quick-start/versioned/index.md | 83 ++ 4 files changed, 91 insertions(+), 48 deletions(-) -- http://git-wip-us.apache.org/repos/asf/samza/blob/4b012326/docs/_docs/replace-versioned.sh -- diff --git a/docs/_docs/replace-versioned.sh b/docs/_docs/replace-versioned.sh index 24bf7ae..c454cac 100755 --- a/docs/_docs/replace-versioned.sh +++ b/docs/_docs/replace-versioned.sh @@ -44,4 +44,7 @@ echo "replaced startup/hello-samza/versioned to startup/hello-samza/"$version mv -f $DIR/_site/startup/hello-samza/versioned $DIR/_site/startup/hello-samza/$version echo "replaced startup/quick-start/versioned to startup/quick-start/"$version -mv -f $DIR/_site/startup/quick-start/versioned $DIR/_site/startup/quick-start/$version \ No newline at end of file +mv -f $DIR/_site/startup/quick-start/versioned $DIR/_site/startup/quick-start/$version + +echo "replaced startup/code-examples/versioned to startup/code-examples/"$version +mv -f $DIR/_site/startup/code-examples/versioned $DIR/_site/startup/code-examples/$version http://git-wip-us.apache.org/repos/asf/samza/blob/4b012326/docs/_menu/index.html -- diff --git a/docs/_menu/index.html b/docs/_menu/index.html index 0d1750f..a363bae 100644 --- a/docs/_menu/index.html +++ b/docs/_menu/index.html @@ -5,7 +5,7 @@ items: - menu_title: QuickStart url: /startup/quick-start/version/ - menu_title: Code Examples -url: /learn/tutorials/version/ +url: /startup/code-examples/version/ - menu_title: Documentation has_sub: true has_sub_subs: true http://git-wip-us.apache.org/repos/asf/samza/blob/4b012326/docs/startup/code-examples/versioned/index.md -- diff --git a/docs/startup/code-examples/versioned/index.md b/docs/startup/code-examples/versioned/index.md new file mode 100644 index 000..ba1cc3e --- /dev/null +++ b/docs/startup/code-examples/versioned/index.md @@ -0,0 +1,49 @@ +--- +layout: page +title: +--- + + + +### Checking out our examples + +The [hello-samza](https://github.com/apache/samza-hello-samza) project contains several examples to help you create your Samza applications. To checkout the hello-samza project: + +{% highlight bash %} +> git clone https://git.apache.org/samza-hello-samza.git hello-samza +{% endhighlight %} + + High-level API examples +[The Samza Cookbook](https://github.com/apache/samza-hello-samza/tree/master/src/main/java/samza/examples/cookbook) contains various recipes using the Samza high-level API. +These include: + +- The [Filter example](https://github.com/apache/samza-hello-samza/blob/latest/src/main/java/samza/examples/cookbook/FilterExample.java) demonstrates how to perform stateless operations on a stream. + +- The [Join example](https://github.com/apache/samza-hello-samza/blob/latest/src/main/java/samza/examples/cookbook/JoinExample.java]) demonstrates how you can join a Kafka stream of page-views with a stream of ad-clicks + +- The [Stream-Table Join example](https://github.com/apache/samza-hello-samza/blob/latest/src/main/java/samza/examples/cookbook/RemoteTableJoinExample.java) demonstrates how the Samza Table API. It joins a Kafka stream with a remote dataset accessed through a REST service. + +- The [SessionWindow](https://github.com/apache/samza-hello-samza/blob/latest/src/main/java/samza/examples/cookbook/SessionWindowExample.java) and [TumblingWindow](https://github.com/apache/samza-hello-samza/blob/latest/src/main/java/samza/examples/cookbook/TumblingWindowExample.java) examples illustrate Samza's rich windowing and triggering capabilities. + + +In addition to the cookbook, you can also consult these: + +- [Wikipedia
samza git commit: Clean-up the Quick-Start and Code-Examples pages; Re-organize content
Repository: samza Updated Branches: refs/heads/master 282f83494 -> 59bc23cf9 Clean-up the Quick-Start and Code-Examples pages; Re-organize content Author: Jagadish Reviewers: Jagadish Closes #759 from vjagadish1989/website-reorg23 Project: http://git-wip-us.apache.org/repos/asf/samza/repo Commit: http://git-wip-us.apache.org/repos/asf/samza/commit/59bc23cf Tree: http://git-wip-us.apache.org/repos/asf/samza/tree/59bc23cf Diff: http://git-wip-us.apache.org/repos/asf/samza/diff/59bc23cf Branch: refs/heads/master Commit: 59bc23cf954bf86683c499729930f126af5ebf2b Parents: 282f834 Author: Jagadish Authored: Tue Oct 23 23:39:54 2018 -0700 Committer: Jagadish Committed: Tue Oct 23 23:39:54 2018 -0700 -- docs/_docs/replace-versioned.sh | 5 +- docs/_menu/index.html | 2 +- docs/startup/code-examples/versioned/index.md | 49 + docs/startup/quick-start/versioned/index.md | 83 ++ 4 files changed, 91 insertions(+), 48 deletions(-) -- http://git-wip-us.apache.org/repos/asf/samza/blob/59bc23cf/docs/_docs/replace-versioned.sh -- diff --git a/docs/_docs/replace-versioned.sh b/docs/_docs/replace-versioned.sh index 24bf7ae..c454cac 100755 --- a/docs/_docs/replace-versioned.sh +++ b/docs/_docs/replace-versioned.sh @@ -44,4 +44,7 @@ echo "replaced startup/hello-samza/versioned to startup/hello-samza/"$version mv -f $DIR/_site/startup/hello-samza/versioned $DIR/_site/startup/hello-samza/$version echo "replaced startup/quick-start/versioned to startup/quick-start/"$version -mv -f $DIR/_site/startup/quick-start/versioned $DIR/_site/startup/quick-start/$version \ No newline at end of file +mv -f $DIR/_site/startup/quick-start/versioned $DIR/_site/startup/quick-start/$version + +echo "replaced startup/code-examples/versioned to startup/code-examples/"$version +mv -f $DIR/_site/startup/code-examples/versioned $DIR/_site/startup/code-examples/$version http://git-wip-us.apache.org/repos/asf/samza/blob/59bc23cf/docs/_menu/index.html -- diff --git a/docs/_menu/index.html b/docs/_menu/index.html index 0d1750f..a363bae 100644 --- a/docs/_menu/index.html +++ b/docs/_menu/index.html @@ -5,7 +5,7 @@ items: - menu_title: QuickStart url: /startup/quick-start/version/ - menu_title: Code Examples -url: /learn/tutorials/version/ +url: /startup/code-examples/version/ - menu_title: Documentation has_sub: true has_sub_subs: true http://git-wip-us.apache.org/repos/asf/samza/blob/59bc23cf/docs/startup/code-examples/versioned/index.md -- diff --git a/docs/startup/code-examples/versioned/index.md b/docs/startup/code-examples/versioned/index.md new file mode 100644 index 000..ba1cc3e --- /dev/null +++ b/docs/startup/code-examples/versioned/index.md @@ -0,0 +1,49 @@ +--- +layout: page +title: +--- + + + +### Checking out our examples + +The [hello-samza](https://github.com/apache/samza-hello-samza) project contains several examples to help you create your Samza applications. To checkout the hello-samza project: + +{% highlight bash %} +> git clone https://git.apache.org/samza-hello-samza.git hello-samza +{% endhighlight %} + + High-level API examples +[The Samza Cookbook](https://github.com/apache/samza-hello-samza/tree/master/src/main/java/samza/examples/cookbook) contains various recipes using the Samza high-level API. +These include: + +- The [Filter example](https://github.com/apache/samza-hello-samza/blob/latest/src/main/java/samza/examples/cookbook/FilterExample.java) demonstrates how to perform stateless operations on a stream. + +- The [Join example](https://github.com/apache/samza-hello-samza/blob/latest/src/main/java/samza/examples/cookbook/JoinExample.java]) demonstrates how you can join a Kafka stream of page-views with a stream of ad-clicks + +- The [Stream-Table Join example](https://github.com/apache/samza-hello-samza/blob/latest/src/main/java/samza/examples/cookbook/RemoteTableJoinExample.java) demonstrates how the Samza Table API. It joins a Kafka stream with a remote dataset accessed through a REST service. + +- The [SessionWindow](https://github.com/apache/samza-hello-samza/blob/latest/src/main/java/samza/examples/cookbook/SessionWindowExample.java) and [TumblingWindow](https://github.com/apache/samza-hello-samza/blob/latest/src/main/java/samza/examples/cookbook/TumblingWindowExample.java) examples illustrate Samza's rich windowing and triggering capabilities. + + +In addition to the cookbook, you can also consult these: + +- [Wikipedia