From 839fd0309b4ef699b1c55ea7c3e267b5a31bde6a Mon Sep 17 00:00:00 2001
From: Robert Metzger
Date: Sat, 10 Jan 2015 12:21:56 +0100
Subject: [PATCH] [docs] Prepare documentation for 0.8 release
---
docs/README.md | 2 +-
docs/_config.yml | 10 +++++-----
docs/cli.md | 12 ++++++------
docs/cluster_execution.md | 4 ++--
docs/example_connectors.md | 8 ++++----
docs/hadoop_compatibility.md | 2 +-
docs/index.md | 4 ++--
docs/java_api_quickstart.md | 2 +-
docs/local_execution.md | 2 +-
docs/programming_guide.md | 12 ++++++------
docs/scala_api_quickstart.md | 2 +-
docs/setup_quickstart.md | 8 ++++----
docs/spargel_guide.md | 2 +-
docs/streaming_guide.md | 2 +-
docs/yarn_setup.md | 14 +++++++-------
15 files changed, 43 insertions(+), 43 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 8a190346bf2..6dc76f264ee 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -44,7 +44,7 @@ title of the page. This title is used as the top-level heading for the page.
Furthermore, you can access variables found in `docs/_config.yml` as follows:
- {{ site.FLINK_VERSION_STABLE }}
+ {{ site.FLINK_VERSION_SHORT }}
This will be replaced with the value of the variable when generating the docs.
diff --git a/docs/_config.yml b/docs/_config.yml
index f9e3690dfbf..0fccf8cdc61 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -22,9 +22,9 @@
# {{ site.CONFIG_KEY }}
#------------------------------------------------------------------------------
-FLINK_VERSION_STABLE: "0.7.0-incubating" # this variable can point to a SNAPSHOT version in the git source.
-FLINK_VERSION_SHORT: "0.7.0"
-FLINK_VERSION_HADOOP_2_STABLE: 0.7-hadoop2-incubating
+FLINK_VERSION_HADOOP1_STABLE: "0.8.0-hadoop1" # this variable can point to a SNAPSHOT version in the git source.
+FLINK_VERSION_SHORT: "0.8.0"
+FLINK_VERSION_HADOOP2_STABLE: "0.8.0"
FLINK_SCALA_VERSION: "2.10.4"
FLINK_SCALA_VERSION_SHORT: "2.10"
FLINK_ISSUES_URL: https://issues.apache.org/jira/browse/FLINK
@@ -33,8 +33,8 @@ FLINK_GITHUB_URL: https://github.com/apache/incubator-flink
FLINK_WEBSITE_URL: http://flink.incubator.apache.org
FLINK_DOWNLOAD_URL: http://flink.incubator.apache.org/downloads.html
-FLINK_DOWNLOAD_URL_HADOOP_1_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.7.0-incubating/flink-0.7.0-incubating-bin-hadoop1.tgz
-FLINK_DOWNLOAD_URL_HADOOP_2_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.7.0-incubating/flink-0.7.0-incubating-bin-hadoop2.tgz
+FLINK_DOWNLOAD_URL_HADOOP1_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.7.0-incubating/flink-0.7.0-incubating-bin-hadoop1.tgz
+FLINK_DOWNLOAD_URL_HADOOP2_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.7.0-incubating/flink-0.7.0-incubating-bin-hadoop2.tgz
FLINK_DOWNLOAD_URL_YARN_STABLE: http://www.apache.org/dyn/closer.cgi/incubator/flink/flink-0.7.0-incubating/flink-0.7.0-incubating-bin-hadoop2-yarn.tgz
FLINK_WGET_URL_YARN_STABLE: http://artfiles.org/apache.org/incubator/flink/flink-0.7.0-incubating/flink-0.7.0-incubating-bin-hadoop2-yarn.tgz
diff --git a/docs/cli.md b/docs/cli.md
index 7db31a6a17c..ceab6e42edd 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -46,33 +46,33 @@ The command line can be used to
- Run example program with no arguments.
- ./bin/flink run ./examples/flink-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar
+ ./bin/flink run ./examples/flink-java-examples-{{ site.FLINK_VERSION_SHORT }}-WordCount.jar
- Run example program with arguments for input and result files
- ./bin/flink run ./examples/flink-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar \
+ ./bin/flink run ./examples/flink-java-examples-{{ site.FLINK_VERSION_SHORT }}-WordCount.jar \
file:///home/user/hamlet.txt file:///home/user/wordcount_out
- Run example program with parallelism 16 and arguments for input and result files
- ./bin/flink run -p 16 ./examples/flink-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar \
+ ./bin/flink run -p 16 ./examples/flink-java-examples-{{ site.FLINK_VERSION_SHORT }}-WordCount.jar \
file:///home/user/hamlet.txt file:///home/user/wordcount_out
- Run example program on a specific JobManager:
./bin/flink run -m myJMHost:6123 \
- ./examples/flink-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar \
+ ./examples/flink-java-examples-{{ site.FLINK_VERSION_SHORT }}-WordCount.jar \
-file:///home/user/hamlet.txt file:///home/user/wordcount_out
- Display the expected arguments for the WordCount example program:
- ./bin/flink info -d ./examples/flink-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar
+ ./bin/flink info -d ./examples/flink-java-examples-{{ site.FLINK_VERSION_SHORT }}-WordCount.jar
- Display the optimized execution plan for the WordCount example program as JSON:
./bin/flink info -e
- ./examples/flink-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar \
+ ./examples/flink-java-examples-{{ site.FLINK_VERSION_SHORT }}-WordCount.jar \
file:///home/user/hamlet.txt file:///home/user/wordcount_out
- List scheduled and running jobs (including their JobIDs):
diff --git a/docs/cluster_execution.md b/docs/cluster_execution.md
index c80c3845dfa..34879dd0710 100644
--- a/docs/cluster_execution.md
+++ b/docs/cluster_execution.md
@@ -49,7 +49,7 @@ If you are developing your program as a Maven project, you have to add the
org.apache.flink
flink-clients
- {{ site.FLINK_VERSION_STABLE }}
+ {{ site.FLINK_VERSION_SHORT }}
~~~
@@ -95,7 +95,7 @@ If you are developing your program in a Maven project, you have to add the
org.apache.flink
flink-clients
- {{ site.FLINK_VERSION_STABLE }}
+ {{ site.FLINK_VERSION_SHORT }}
~~~
diff --git a/docs/example_connectors.md b/docs/example_connectors.md
index 69c613defae..c65f06fd4c7 100644
--- a/docs/example_connectors.md
+++ b/docs/example_connectors.md
@@ -40,7 +40,7 @@ interface. Hadoop ships adapters for FTP, [Hftp](http://hadoop.apache.org/docs/r
Flink has integrated testcases to validate the integration with [Tachyon](http://tachyon-project.org/).
Other file systems we tested the integration is the
-[Google Cloud Storage Connector for Hadoop](https://cloud.google.com/hadoop/google-cloud-storage-connector).
+[Google Cloud Storage Connector for Hadoop](https://cloud.google.com/hadoop/google-cloud-storage-connector) and [XtreemFS](http://www.xtreemfs.org/).
In order to use a Hadoop file system with Flink, make sure that the `flink-conf.yaml` has set the
`fs.hdfs.hadoopconf` property set to the Hadoop configuration directory.
@@ -90,16 +90,16 @@ Execute the following commands:
curl https://raw.githubusercontent.com/apache/incubator-flink/master/flink-quickstart/quickstart.sh | bash
~~~
-3. Set the the version of Flink to `{{site.FLINK_VERSION_HADOOP_2_STABLE}}` in the `pom.xml` file. The quickstart.sh script sets the version to the `hadoop1` version of Flink. Since the `microsoft-hadoop-azure` has been written for Hadoop 2.2 (mapreduce-API) version, we need to use the appropriate Flink version.
+3. Set the the version of Flink to `{{site.FLINK_VERSION_HADOOP2_STABLE}}` in the `pom.xml` file. The quickstart.sh script sets the version to the `hadoop1` version of Flink. Since the `microsoft-hadoop-azure` has been written for Hadoop 2.2 (mapreduce-API) version, we need to use the appropriate Flink version.
- Replace all occurences of `{{site.FLINK_VERSION_STABLE}}` with `{{site.FLINK_VERSION_HADOOP_2_STABLE}}`.
+ Replace all occurences of `{{site.FLINK_VERSION_SHORT}}` with `{{site.FLINK_VERSION_HADOOP2_STABLE}}`.
4. Add the following dependencies (in the `` section) to your `pom.xml` file:
~~~xml
org.apache.flink
flink-hadoop-compatibility
- {{site.FLINK_VERSION_HADOOP_2_STABLE}}
+ {{site.FLINK_VERSION_HADOOP2_STABLE}}
com.microsoft.hadoop
diff --git a/docs/hadoop_compatibility.md b/docs/hadoop_compatibility.md
index ed8eef46656..9b4302244bf 100644
--- a/docs/hadoop_compatibility.md
+++ b/docs/hadoop_compatibility.md
@@ -46,7 +46,7 @@ Add the following dependency to your `pom.xml` to use the Hadoop Compatibility L
org.apache.flink
flink-hadoop-compatibility
- {{site.FLINK_VERSION_STABLE}}
+ {{site.FLINK_VERSION_SHORT}}
~~~
diff --git a/docs/index.md b/docs/index.md
index 275419ed743..517f9f3141e 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -32,10 +32,10 @@ a thorough introduction of the Flink API please refer to the
## Download
You can download Flink from the [downloads]({{ site.FLINK_DOWNLOAD_URL }}) page
-of the [project website]({{ site.FLINK_WEBSITE_URL }}). This documentation is for version {{ site.FLINK_VERSION_STABLE }}. Be careful
+of the [project website]({{ site.FLINK_WEBSITE_URL }}). This documentation is for version {{ site.FLINK_VERSION_SHORT }}. Be careful
when picking a version, there are different versions depending on the Hadoop and/or
HDFS version that you want to use with Flink. Please refer to [building](building.html) if you
want to build Flink yourself from the source.
-In Version {{ site.FLINK_VERSION_STABLE}} the Scala API uses Scala {{ site.FLINK_SCALA_VERSION_SHORT }}. Please make
+In Version {{ site.FLINK_VERSION_SHORT}} the Scala API uses Scala {{ site.FLINK_SCALA_VERSION_SHORT }}. Please make
sure to use a compatible version.
diff --git a/docs/java_api_quickstart.md b/docs/java_api_quickstart.md
index 355c6ccf3d1..f84d656647f 100644
--- a/docs/java_api_quickstart.md
+++ b/docs/java_api_quickstart.md
@@ -49,7 +49,7 @@ Use one of the following commands to __create a project__:
$ mvn archetype:generate \
-DarchetypeGroupId=org.apache.flink \
-DarchetypeArtifactId=flink-quickstart-java \
- -DarchetypeVersion={{site.FLINK_VERSION_STABLE}}
+ -DarchetypeVersion={{site.FLINK_VERSION_SHORT}}
{% endhighlight %}
This allows you to name your newly created project. It will interactively ask you for the groupId, artifactId, and package name.
diff --git a/docs/local_execution.md b/docs/local_execution.md
index d6e3a91ce48..bac1745ee17 100644
--- a/docs/local_execution.md
+++ b/docs/local_execution.md
@@ -45,7 +45,7 @@ If you are developing your program in a Maven project, you have to add the `flin
org.apache.flink
flink-clients
- {{site.FLINK_VERSION_STABLE}}
+ {{site.FLINK_VERSION_SHORT}}
~~~
diff --git a/docs/programming_guide.md b/docs/programming_guide.md
index e7ac064ae29..e4d0eb36fbb 100644
--- a/docs/programming_guide.md
+++ b/docs/programming_guide.md
@@ -130,7 +130,7 @@ manually create the project, you can use the archetype and create a project by c
mvn archetype:generate /
-DarchetypeGroupId=org.apache.flink/
-DarchetypeArtifactId=flink-quickstart-java /
- -DarchetypeVersion={{site.FLINK_VERSION_STABLE }}
+ -DarchetypeVersion={{site.FLINK_VERSION_SHORT }}
{% endhighlight %}
@@ -138,7 +138,7 @@ mvn archetype:generate /
mvn archetype:generate /
-DarchetypeGroupId=org.apache.flink/
-DarchetypeArtifactId=flink-quickstart-scala /
- -DarchetypeVersion={{site.FLINK_VERSION_STABLE }}
+ -DarchetypeVersion={{site.FLINK_VERSION_SHORT }}
{% endhighlight %}
@@ -152,12 +152,12 @@ If you want to add Flink to an existing Maven project, add the following entry t
org.apache.flink
flink-java
- {{site.FLINK_VERSION_STABLE }}
+ {{site.FLINK_VERSION_SHORT }}
org.apache.flink
flink-clients
- {{site.FLINK_VERSION_STABLE }}
+ {{site.FLINK_VERSION_SHORT }}
{% endhighlight %}
@@ -166,12 +166,12 @@ If you want to add Flink to an existing Maven project, add the following entry t
org.apache.flink
flink-scala
- {{site.FLINK_VERSION_STABLE }}
+ {{site.FLINK_VERSION_SHORT }}
org.apache.flink
flink-clients
- {{site.FLINK_VERSION_STABLE }}
+ {{site.FLINK_VERSION_SHORT }}
{% endhighlight %}
diff --git a/docs/scala_api_quickstart.md b/docs/scala_api_quickstart.md
index 8e204711a89..db315e5aeb2 100644
--- a/docs/scala_api_quickstart.md
+++ b/docs/scala_api_quickstart.md
@@ -49,7 +49,7 @@ $ curl https://raw.githubusercontent.com/apache/incubator-flink/master/flink-qui
$ mvn archetype:generate \
-DarchetypeGroupId=org.apache.flink \
-DarchetypeArtifactId=flink-quickstart-scala \
- -DarchetypeVersion={{site.FLINK_VERSION_STABLE}}
+ -DarchetypeVersion={{site.FLINK_VERSION_SHORT}}
{% endhighlight %}
This allows you to name your newly created project. It will interactively ask you for the groupId, artifactId, and package name.
diff --git a/docs/setup_quickstart.md b/docs/setup_quickstart.md
index e9d2b8b3d33..d98781307d2 100644
--- a/docs/setup_quickstart.md
+++ b/docs/setup_quickstart.md
@@ -38,10 +38,10 @@ Download the ready to run binary package. Choose the Flink distribution that __m
@@ -57,7 +57,7 @@ Download the ready to run binary package. Choose the Flink distribution that __m
~~~bash
$ cd ~/Downloads # Go to download directory
$ tar xzf flink-*.tgz # Unpack the downloaded archive
-$ cd flink-{{site.FLINK_VERSION_STABLE}}
+$ cd flink-{{site.FLINK_VERSION_SHORT}}
$ bin/start-local.sh # Start Flink
~~~
@@ -78,7 +78,7 @@ Run the __Word Count example__ to see Flink at work.
* __Start the example program__:
~~~bash
- $ bin/flink run ./examples/flink-java-examples-{{site.FLINK_VERSION_STABLE}}-WordCount.jar file://`pwd`/hamlet.txt file://`pwd`/wordcount-result.txt
+ $ bin/flink run ./examples/flink-java-examples-{{site.FLINK_VERSION_SHORT}}-WordCount.jar file://`pwd`/hamlet.txt file://`pwd`/wordcount-result.txt
~~~
* You will find a file called __wordcount-result.txt__ in your current directory.
diff --git a/docs/spargel_guide.md b/docs/spargel_guide.md
index 0520ba52547..da362b1768e 100644
--- a/docs/spargel_guide.md
+++ b/docs/spargel_guide.md
@@ -43,7 +43,7 @@ Add the following dependency to your `pom.xml` to use the Spargel.
org.apache.flink
flink-spargel
- {{site.FLINK_VERSION_STABLE}}
+ {{site.FLINK_VERSION_SHORT}}
~~~
diff --git a/docs/streaming_guide.md b/docs/streaming_guide.md
index 1b0a1e9c095..d2d54c31359 100644
--- a/docs/streaming_guide.md
+++ b/docs/streaming_guide.md
@@ -42,7 +42,7 @@ Add the following dependency to your `pom.xml` to use the Flink Streaming.
org.apache.flink
flink-streaming-core
- {{site.FLINK_VERSION_STABLE}}
+ {{site.FLINK_VERSION_SHORT}}
~~~
diff --git a/docs/yarn_setup.md b/docs/yarn_setup.md
index 5f51340dff4..3374500bcda 100644
--- a/docs/yarn_setup.md
+++ b/docs/yarn_setup.md
@@ -29,8 +29,8 @@ Start YARN session with 4 Task Managers (each with 4 GB of Heapspace):
~~~bash
wget {{ site.FLINK_WGET_URL_YARN_STABLE }}
-tar xvzf flink-{{ site.FLINK_VERSION_STABLE }}-bin-hadoop2-yarn.tgz
-cd flink-yarn-{{ site.FLINK_VERSION_STABLE }}/
+tar xvzf flink-{{ site.FLINK_VERSION_SHORT }}-bin-hadoop2-yarn.tgz
+cd flink-yarn-{{ site.FLINK_VERSION_SHORT }}/
./bin/yarn-session.sh -n 4 -jm 1024 -tm 4096
~~~
@@ -60,11 +60,11 @@ Download the YARN tgz package on the [download page]({{site.baseurl}}/downloads.
Extract the package using:
~~~bash
-tar xvzf flink-{{ site.FLINK_VERSION_STABLE }}-bin-hadoop2-yarn.tgz
-cd flink-yarn-{{site.FLINK_VERSION_STABLE }}/
+tar xvzf flink-{{ site.FLINK_VERSION_SHORT }}-bin-hadoop2-yarn.tgz
+cd flink-yarn-{{site.FLINK_VERSION_SHORT }}/
~~~
-If you want to build the YARN .tgz file from sources, follow the [build instructions](building.html). Make sure to use the `-Dhadoop.profile=2` profile. You can find the result of the build in `flink-dist/target/flink-{{ site.FLINK_VERSION_STABLE }}-bin/flink-yarn-{{ site.FLINK_VERSION_STABLE }}/` (*Note: The version might be different for you* ).
+If you want to build the YARN .tgz file from sources, follow the [build instructions](building.html). You can find the result of the build in `flink-dist/target/flink-{{ site.FLINK_VERSION_SHORT }}-bin/flink-yarn-{{ site.FLINK_VERSION_SHORT }}/` (*Note: The version might be different for you* ).
#### Start a Session
@@ -157,14 +157,14 @@ Use the *run* action to submit a job to YARN. The client is able to determine th
~~~bash
wget -O apache-license-v2.txt http://www.apache.org/licenses/LICENSE-2.0.txt
-./bin/flink run -j ./examples/flink-java-examples-{{site.FLINK_VERSION_STABLE }}-WordCount.jar \
+./bin/flink run -j ./examples/flink-java-examples-{{site.FLINK_VERSION_SHORT }}-WordCount.jar \
-a 1 file://`pwd`/apache-license-v2.txt file://`pwd`/wordcount-result.txt
~~~
If there is the following error, make sure that all TaskManagers started:
~~~bash
-Exception in thread "main" org.apache.flinkcompiler.CompilerException:
+Exception in thread "main" org.apache.flink.compiler.CompilerException:
Available instances could not be determined from job manager: Connection timed out.
~~~
--
GitLab