Repository: incubator-zeppelin Updated Branches: refs/heads/master 2ba4b38fb -> 82ea80dc6
ZEPPELIN-296 add flink docs [ZEPPELIN-296](https://issues.apache.org/jira/browse/ZEPPELIN-296) initial documentation for Apache Flink interpreter While we are at it, there are some minor updates for the docs too. Author: Alexander Bezzubov <[email protected]> Closes #303 from bzz/ZEPPELIN-296-add-flink-docs and squashes the following commits: 8a2f909 [Alexander Bezzubov] ZEPPELIN-296: initial Flink interpreter docs 8e87683 [Alexander Bezzubov] Update /docs README f85b4cd [Alexander Bezzubov] Update /download page Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/82ea80dc Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/82ea80dc Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/82ea80dc Branch: refs/heads/master Commit: 82ea80dc6a320a7d7e400495afa3cd97f1c523eb Parents: 2ba4b38 Author: Alexander Bezzubov <[email protected]> Authored: Mon Sep 14 12:01:38 2015 +0900 Committer: Alexander Bezzubov <[email protected]> Committed: Mon Oct 5 08:30:54 2015 +0900 ---------------------------------------------------------------------- docs/README.md | 30 ++++++++++++++--------- docs/docs/index.md | 3 +-- docs/docs/interpreter/flink.md | 49 +++++++++++++++++++++++++++++++++++++ docs/download.md | 10 +++++--- 4 files changed, 75 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/82ea80dc/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index daa6246..b463599 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,11 @@ ## Zeppelin project website -## Build +Welcome to the Zeppelin documentation! + +This readme will walk you through building the Zeppelin documentation, which is included here with the Zeppelin source code. + + +## Build website See https://help.github.com/articles/using-jekyll-with-pages#installing-jekyll **tl;dr version:** @@ -11,22 +16,25 @@ See https://help.github.com/articles/using-jekyll-with-pages#installing-jekyll *On OS X 10.9 you may need to do "xcode-select --install"* -## On local machine -### Run +## Run website + bundle exec jekyll serve --watch -### Deploy - 1. generate static website in ```_site``` - bundle exec jekyll build - 2. checkout asf repo +## Deploy to ASF svnpubsub infra (commiters only) + 1. generate static website in `./_site` + ``` + bundle exec jekyll build --safe + ``` + 2. checkout ASF repo + ``` svn co https://svn.apache.org/repos/asf/incubator/zeppelin asf-zepplelin - + ``` 3. copy zeppelin/_site to asf-zepplelin/site - 4. svn commit + 4. ```svn commit``` + +## Adding a new page -### Add a new page rake page name="new-page.md" - http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/82ea80dc/docs/docs/index.md ---------------------------------------------------------------------- diff --git a/docs/docs/index.md b/docs/docs/index.md index 5fa9c6d..d243c41 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -19,7 +19,7 @@ group: nav-right **[Interpreters in zeppelin](manual/interpreters.html)** -* [flink](../docs/pleasecontribute.html) +* [flink](../docs/interpreter/flink.html) * [hive](../docs/pleasecontribute.html) * [ignite](../docs/pleasecontribute.html) * [lens](../docs/pleasecontribute.html) @@ -53,4 +53,3 @@ group: nav-right * [How to contribute (website)](./development/howtocontributewebsite.html) - http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/82ea80dc/docs/docs/interpreter/flink.md ---------------------------------------------------------------------- diff --git a/docs/docs/interpreter/flink.md b/docs/docs/interpreter/flink.md new file mode 100644 index 0000000..579a5f4 --- /dev/null +++ b/docs/docs/interpreter/flink.md @@ -0,0 +1,49 @@ +--- +layout: page +title: "Flink Interpreter" +description: "" +group: manual +--- +{% include JB/setup %} + + +## Flink interpreter for Apache Zeppelin +[Apache Flink](https://flink.apache.org) is an open source platform for distributed stream and batch data processing. + + +### How to start local Flink cluster, to test the interpreter +Zeppelin comes with pre-configured flink-local interpreter, which starts Flink in a local mode on your machine, so you do not need to install anything. + +### How to configure interpreter to point to Flink cluster +At the "Interpreters" menu, you have to create a new Flink interpreter and provide next properties: + +property | value | Description +---------|----------|----- +host | local | host name of running JobManager. 'local' runs flink in local mode (default) +port | 6123 | port of running JobManager +xxx | yyy | anything else from [Flink Configuration](https://ci.apache.org/projects/flink/flink-docs-release-0.9/setup/config.html) + +### How to test it's working + +In example, by using the [Zeppelin notebook](https://www.zeppelinhub.com/viewer/notebooks/aHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL05GTGFicy96ZXBwZWxpbi1ub3RlYm9va3MvbWFzdGVyL25vdGVib29rcy8yQVFFREs1UEMvbm90ZS5qc29u) is from [Till Rohrmann's presentation](http://www.slideshare.net/tillrohrmann/data-analysis-49806564) "Interactive data analysis with Apache Flink" for Apache Flink Meetup. + + +``` +%sh +rm 10.txt.utf-8 +wget http://www.gutenberg.org/ebooks/10.txt.utf-8 +``` +``` +%flink +case class WordCount(word: String, frequency: Int) +val bible:DataSet[String] = env.readTextFile("10.txt.utf-8") +val partialCounts: DataSet[WordCount] = bible.flatMap{ + line => + """\b\w+\b""".r.findAllIn(line).map(word => WordCount(word, 1)) +// line.split(" ").map(word => WordCount(word, 1)) +} +val wordCounts = partialCounts.groupBy("word").reduce{ + (left, right) => WordCount(left.word, left.frequency + right.frequency) +} +val result10 = wordCounts.first(10).collect() +``` http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/82ea80dc/docs/download.md ---------------------------------------------------------------------- diff --git a/docs/download.md b/docs/download.md index b206100..28f3e41 100644 --- a/docs/download.md +++ b/docs/download.md @@ -8,14 +8,16 @@ group: nav-right ### Download Zeppelin -The latest release of Apache Zeppelin (incubating) is 0.5.0-incubating. Released on July 23, 2015 ([release notes](./docs/releases/zeppelin-release-0.5.0-incubating.html)) ([git tag](https://git-wip-us.apache.org/repos/asf?p=incubator-zeppelin.git;a=tag;h=refs/tags/v0.5.0)) +The latest release of Apache Zeppelin (incubating) is *0.5.0-incubating*. -[Download](http://www.apache.org/dyn/closer.cgi/incubator/zeppelin/0.5.0-incubating) + - 0.5.0-incubating released on July 23, 2015 ([release notes](./docs/releases/zeppelin-release-0.5.0-incubating.html)) ([git tag](https://git-wip-us.apache.org/repos/asf?p=incubator-zeppelin.git;a=tag;h=refs/tags/v0.5.0)) + [Download](http://www.apache.org/dyn/closer.cgi/incubator/zeppelin/0.5.0-incubating) -### Build from source, installation -Check [install](./docs/install/install.html). +### Build from source + +For developers, to get latest *0.6.0-incubating-SNAPSHOT* check [install](./docs/install/install.html) section. <!--
