[documentation] fix internals linking

VonRosenchild · Jul 4, 2014 · 88e4dac · 88e4dac
1 parent b945916
commit 88e4dac
Show file tree

Hide file tree

Showing 35 changed files with 66 additions and 60 deletions.
diff --git a/docs/internals/ClientJmTm.svg → docs/ClientJmTm.svg b/docs/internals/ClientJmTm.svg → docs/ClientJmTm.svg
diff --git a/docs/internals/JobManagerComponents.svg → docs/JobManagerComponents.svg b/docs/internals/JobManagerComponents.svg → docs/JobManagerComponents.svg
diff --git 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 }}
+ {{ site.FLINK_VERSION_STABLE }}
 
 This will be replaced with the value of the variable when generating the docs.
 

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -5,7 +5,7 @@
 # {{ site.CONFIG_KEY }}
 #------------------------------------------------------------------------------
 
-FLINK_VERSION: 0.6-SNAPSHOT
+FLINK_VERSION_STABLE: 0.6-SNAPSHOT # this variable can point to a SNAPSHOT version in the git source.
 FLINK_VERSION_SHORT: 0.6
 FLINK_ISSUES_URL: https://issues.apache.org/jira/browse/FLINK
 FLINK_GITHUB_URL: https://github.com/apache/incubator-flink

diff --git a/docs/_layouts/docs.html b/docs/_layouts/docs.html
@@ -4,7 +4,7 @@
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
- <title>Apache Flink {{ site.FLINK_VERSION }} Documentation: {{ page.title }}</title>
+ <title>Apache Flink {{ site.FLINK_VERSION_STABLE }} Documentation: {{ page.title }}</title>
 
  <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
  <link rel="stylesheet" href="css/syntax.css">
@@ -19,7 +19,7 @@
  <body>
  <div class="container">
  <div class="row">
- <h1>Apache Flink {{ site.FLINK_VERSION }} Documentation</h1>
+ <h1>Apache Flink {{ site.FLINK_VERSION_STABLE }} Documentation</h1>
  </div>
  <div class="row">
  <div class="col-md-3">
@@ -71,7 +71,9 @@ <h1>Apache Flink {{ site.FLINK_VERSION }} Documentation</h1>
 
  <li>Internals
  <ul>
- <li>To be written</li>
+ <li><a href="internal_overview.html">Overview</a></li>
+ <li><a href="internal_general_arch.html">General Architecture</a></li>
+ <li><a href="internal_add_operator.html">How-to: Adding a new Operator</a></li>
  </ul>
  </li>
  </ul>

diff --git a/docs/cli.md b/docs/cli.md
@@ -24,33 +24,33 @@ The command line can be used to
 
 - Run example program with no arguments.
 
- ./bin/stratosphere run ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION }}-WordCount.jar
+ ./bin/stratosphere run ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar
 
 - Run example program with arguments for input and result files
 
- ./bin/stratosphere run ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION }}-WordCount.jar \
+ ./bin/stratosphere run ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar \
   file:https:///home/user/hamlet.txt file:https:///home/user/wordcount_out
 
 - Run example program with parallelism 16 and arguments for input and result files
 
- ./bin/stratosphere run -p 16 ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION }}-WordCount.jar \
+ ./bin/stratosphere run -p 16 ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar \
   file:https:///home/user/hamlet.txt file:https:///home/user/wordcount_out
 
 - Run example program on a specific JobManager:
 
  ./bin/stratosphere run -m myJMHost:6123 \
-  ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION }}-WordCount.jar \
+  ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar \
   -file:https:///home/user/hamlet.txt file:https:///home/user/wordcount_out
 
 
 - Display the expected arguments for the WordCount example program:
 
- ./bin/stratosphere info -d ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION }}-WordCount.jar
+ ./bin/stratosphere info -d ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar
 
 - Display the optimized execution plan for the WordCount example program as JSON:
 
  ./bin/stratosphere info -e 
-  ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION }}-WordCount.jar \
+  ./examples/stratosphere-java-examples-{{ site.FLINK_VERSION_STABLE }}-WordCount.jar \
   file:https:///home/user/hamlet.txt file:https:///home/user/wordcount_out
 
 - List scheduled and running jobs (including their JobIDs):

diff --git a/docs/cluster_execution.md b/docs/cluster_execution.md
@@ -28,7 +28,7 @@ If you are developing your program as a Maven project, you have to add the
 <dependency>
  <groupId>eu.stratosphere</groupId>
  <artifactId>stratosphere-clients</artifactId>
- <version>{{ site.FLINK_VERSION }}</version>
+ <version>{{ site.FLINK_VERSION_STABLE }}</version>
 </dependency>
 ```
 
@@ -74,7 +74,7 @@ If you are developing your program in a Maven project, you have to add the
 <dependency>
  <groupId>eu.stratosphere</groupId>
  <artifactId>stratosphere-clients</artifactId>
- <version>{{ site.FLINK_VERSION }}</version>
+ <version>{{ site.FLINK_VERSION_STABLE }}</version>
 </dependency>
 ```
 

diff --git a/docs/faq.md b/docs/faq.md
@@ -24,8 +24,8 @@ Hadoop client libraries with Stratosphere by default.
 
 Additionally, we provide a special YARN Enabled download of Stratosphere for
 users with an existing Hadoop YARN cluster. [Apache Hadoop
-YARN](http:https://hadoop.apache.org/docs/r2.2.0/hadoop-yarn/hadoop-yarn-
-site/YARN.html) is Hadoop's cluster resource manager that allows to use
+YARN](http:https://hadoop.apache.org/docs/r2.2.0/hadoop-yarn/hadoop-yarn-site/YARN.html) 
+is Hadoop's cluster resource manager that allows to use
 different execution engines next to each other on a cluster.
 
 # Usage

diff --git a/docs/img/StratosphereOnYarn.svg b/docs/img/StratosphereOnYarn.svg
diff --git a/docs/internals/add_operator.md → docs/internal_add_operator.md b/docs/internals/add_operator.md → docs/internal_add_operator.md
diff --git a/docs/internals/distributed_runtime.md → docs/internal_distributed_runtime.md b/docs/internals/distributed_runtime.md → docs/internal_distributed_runtime.md
diff --git a/docs/internals/general_arch.md → docs/internal_general_arch.md b/docs/internals/general_arch.md → docs/internal_general_arch.md
diff --git a/docs/internals/job_scheduling.md → docs/internal_job_scheduling.md b/docs/internals/job_scheduling.md → docs/internal_job_scheduling.md
diff --git a/docs/internals/operators_and_memory.md → docs/internal_operators_and_memory.md b/docs/internals/operators_and_memory.md → docs/internal_operators_and_memory.md
diff --git a/docs/internals/optimizer.md → docs/internal_optimizer.md b/docs/internals/optimizer.md → docs/internal_optimizer.md
diff --git a/docs/internals/overview.md → docs/internal_overview.md b/docs/internals/overview.md → docs/internal_overview.md
@@ -15,7 +15,7 @@ or pull request that updates these documents as well.*
 
 ### Architectures and Components
 
-- [General Architecture and Process Model](general_arch.html)
+- [General Architecture and Process Model](internal_general_arch.html)
 
 <!--
 - [Life Cycle of a Program](program_life_cycle.html)
@@ -29,7 +29,7 @@ or pull request that updates these documents as well.*
 - [Program Optimizer](optimizer.html)
 -->
 
-- [How-to: Adding a new Operator](add_operator.html)
+- [How-to: Adding a new Operator](internal_add_operator.html)
 
 <!--
 - [Java API, Types, and Type Extraction](types.html)

diff --git a/docs/internals/program_life_cycle.md → docs/internal_program_life_cycle.md b/docs/internals/program_life_cycle.md → docs/internal_program_life_cycle.md
diff --git a/docs/java_api_guide.md b/docs/java_api_guide.md
@@ -73,7 +73,7 @@ The simplest way to do this is to use the [quickstart scripts]({{site.baseurl}}/
 mvn archetype:generate /
  -DarchetypeGroupId=eu.stratosphere /
  -DarchetypeArtifactId=quickstart-java /
- -DarchetypeVersion={{site.docs_05_stable}}
+ -DarchetypeVersion={{site.FLINK_VERSION_STABLE }}
 ```
 
 If you want to add Stratosphere to an existing Maven project, add the following entry to your *dependencies* section in the *pom.xml* file of your project:
@@ -82,12 +82,12 @@ If you want to add Stratosphere to an existing Maven project, add the following
 <dependency>
  <groupId>eu.stratosphere</groupId>
  <artifactId>stratosphere-java</artifactId>
- <version>{{site.docs_05_stable}}</version>
+ <version>{{site.FLINK_VERSION_STABLE }}</version>
 </dependency>
 <dependency>
  <groupId>eu.stratosphere</groupId>
  <artifactId>stratosphere-clients</artifactId>
- <version>{{site.docs_05_stable}}</version>
+ <version>{{site.FLINK_VERSION_STABLE }}</version>
 </dependency>
 ```
 

diff --git a/docs/java_api_quickstart.md b/docs/java_api_quickstart.md
@@ -18,15 +18,15 @@ Use one of the following commands to __create a project__:
 <div class="tab-content">
  <div class="tab-pane active" id="quickstart-script">
  {% highlight bash %}
- $ curl https://raw.githubusercontent.com/stratosphere/stratosphere-quickstart/master/quickstart.sh | bash
+ $ curl https://raw.githubusercontent.com/apache/incubator-flink/master/stratosphere-quickstart/quickstart.sh | bash
  {% endhighlight %}
  </div>
  <div class="tab-pane" id="maven-archetype">
  {% highlight bash %}
  $ mvn archetype:generate \
   -DarchetypeGroupId=eu.stratosphere \
   -DarchetypeArtifactId=quickstart-java \
-  -DarchetypeVersion={{site.current_stable}}
+  -DarchetypeVersion={{site.FLINK_VERSION_STABLE}}
  {% endhighlight %}
   This allows you to <strong>name your newly created project</strong>. It will interactively ask you for the groupId, artifactId, and package name.
  </div>

diff --git a/docs/internals/jobgraph_executiongraph.svg → docs/jobgraph_executiongraph.svg b/docs/internals/jobgraph_executiongraph.svg → docs/jobgraph_executiongraph.svg
diff --git a/docs/local_execution.md b/docs/local_execution.md
@@ -25,7 +25,7 @@ If you are developing your program in a Maven project, you have to add the `stra
 <dependency>
  <groupId>eu.stratosphere</groupId>
  <artifactId>stratosphere-clients</artifactId>
- <version>{{site.current_stable}}</version>
+ <version>{{site.FLINK_VERSION_STABLE}}</version>
 </dependency>
 ```
 

diff --git a/docs/internals/projects_dependencies.svg → docs/projects_dependencies.svg b/docs/internals/projects_dependencies.svg → docs/projects_dependencies.svg
diff --git a/docs/run_example_quickstart.md b/docs/run_example_quickstart.md
@@ -10,13 +10,13 @@ On the way, you will see the compiler, the status interface and the result of th
 Stratosphere contains a data generator for K-Means.
 
  # Download Stratosphere
- wget {{ site.current_stable_dl }}
+ wget {{ site.FLINK_VERSION_STABLE_dl }}
  tar xzf stratosphere-*.tgz 
  cd stratosphere-*
  mkdir kmeans
  cd kmeans
  # Run data generator
- java -cp ../examples/stratosphere-java-examples-{{ site.current_stable }}-KMeans.jar eu.stratosphere.example.java.clustering.util.KMeansDataGenerator 500 10 0.08
+ java -cp ../examples/stratosphere-java-examples-{{ site.FLINK_VERSION_STABLE }}-KMeans.jar eu.stratosphere.example.java.clustering.util.KMeansDataGenerator 500 10 0.08
  cp /tmp/points .
  cp /tmp/centers .
 

diff --git a/docs/scala_api_guide.md b/docs/scala_api_guide.md
@@ -97,12 +97,12 @@ following lines to your POM.
  <dependency>
  <groupId>eu.stratosphere</groupId>
  <artifactId>stratosphere-scala</artifactId>
- <version>{{site.current_stable}}</version>
+ <version>{{site.FLINK_VERSION_STABLE}}</version>
  </dependency>
  <dependency>
  <groupId>eu.stratosphere</groupId>
  <artifactId>stratosphere-clients</artifactId>
- <version>{{site.current_stable}}</version>
+ <version>{{site.FLINK_VERSION_STABLE}}</version>
  </dependency>
 </dependencies>
 ```
@@ -173,9 +173,9 @@ the primitive Scala types, case classes (which includes tuples), and custom
 data types.
 
 Custom data types must implement the interface
-[Value](https://github.com/stratosphere/stratosphere/blob/release-{{site.current_stable}}/stratosphere-core/src/main/java/eu/stratosphere/types/Value.java).
+[Value](https://github.com/stratosphere/stratosphere/blob/release-{{site.FLINK_VERSION_STABLE}}/stratosphere-core/src/main/java/eu/stratosphere/types/Value.java).
 For custom data types that should also be used as a grouping key or join key
-the [Key](https://github.com/stratosphere/stratosphere/blob/release-{{site.current_stable}}/stratosphere-core/src/main/java/eu/stratosphere/types/Key.java)
+the [Key](https://github.com/stratosphere/stratosphere/blob/release-{{site.FLINK_VERSION_STABLE}}/stratosphere-core/src/main/java/eu/stratosphere/types/Key.java)
 interface must be implemented.
 
 [Back to top](#top)
@@ -915,7 +915,7 @@ Executing Jobs
 --------------
 
 To execute a data flow graph the sinks need to be wrapped in a
-[ScalaPlan](https://github.com/stratosphere/stratosphere/blob/release-{{site.current_stable}}/stratosphere-scala/src/main/scala/eu/stratosphere/api/scala/ScalaPlan.scala)
+[ScalaPlan](https://github.com/stratosphere/stratosphere/blob/release-{{site.FLINK_VERSION_STABLE}}/stratosphere-scala/src/main/scala/eu/stratosphere/api/scala/ScalaPlan.scala)
 object like this:
 
 ```scala
@@ -951,7 +951,7 @@ Remote (or cluster) execution is a bit more complicated because you have
 to package your code in a jar file so that it can be distributed on the cluster.
 Have a look at the [scala quickstart](/quickstart/scala.html) to see how you
 can set up a maven project that does the packaging. Remote execution is done
-using the [RemoteExecutor](https://github.com/stratosphere/stratosphere/blob/release-{{site.current_stable}}/stratosphere-clients/src/main/java/eu/stratosphere/client/RemoteExecutor.java), like this:
+using the [RemoteExecutor](https://github.com/stratosphere/stratosphere/blob/release-{{site.FLINK_VERSION_STABLE}}/stratosphere-clients/src/main/java/eu/stratosphere/client/RemoteExecutor.java), like this:
 
 ```scala
 import eu.stratosphere.client.RemoteExecutor
@@ -1011,7 +1011,7 @@ instead of the anonymous class we used here.
 
 There are rich functions for all the various operator types. The basic
 template is the some, though. The common interface that they implement 
-is [Function](https://github.com/stratosphere/stratosphere/blob/release-{{site.current_stable}}/stratosphere-core/src/main/java/eu/stratosphere/api/common/functions/Function.java). The `open` and `close` methods can be overridden to run set-up
+is [Function](https://github.com/stratosphere/stratosphere/blob/release-{{site.FLINK_VERSION_STABLE}}/stratosphere-core/src/main/java/eu/stratosphere/api/common/functions/Function.java). The `open` and `close` methods can be overridden to run set-up
 and tear-down code. The other methods can be used in a rich function to
 work with the runtime context which gives information about the context
 of the operator. Your operation code must now reside in an `apply` method

diff --git a/docs/scala_api_quickstart.md b/docs/scala_api_quickstart.md
@@ -18,15 +18,15 @@ Use one of the following commands to __create a project__:
 <div class="tab-content">
  <div class="tab-pane active" id="quickstart-script">
 {% highlight bash %}
-$ curl https://raw.githubusercontent.com/stratosphere/stratosphere-quickstart/master/quickstart-scala.sh | bash
+$ curl https://raw.githubusercontent.com/apache/incubator-flink/master/stratosphere-quickstart/quickstart-scala.sh | bash
 {% endhighlight %}
  </div>
  <div class="tab-pane" id="maven-archetype">
 {% highlight bash %}
 $ mvn archetype:generate \
  -DarchetypeGroupId=eu.stratosphere \
  -DarchetypeArtifactId=quickstart-scala \
- -DarchetypeVersion={{site.current_stable}} 
+ -DarchetypeVersion={{site.FLINK_VERSION_STABLE}} 
 {% endhighlight %}
  This allows you to <strong>name your newly created project</strong>. It will interactively ask you for the groupId, artifactId, and package name.
  </div>

diff --git a/docs/setup_quickstart.md b/docs/setup_quickstart.md
@@ -16,10 +16,10 @@ Download the ready to run binary package. Choose the Stratosphere distribution t
  </ul>
  <div class="tab-content text-center">
  <div class="tab-pane active" id="bin-hadoop1">
-  <a class="btn btn-info btn-lg" onclick="_gaq.push(['_trackEvent','Action','download-quickstart-setup-1',this.href]);" href="{{site.current_stable_dl}}"><i class="icon-download"> </i> Download Stratosphere for Hadoop 1.2</a>
+  <a class="btn btn-info btn-lg" onclick="_gaq.push(['_trackEvent','Action','download-quickstart-setup-1',this.href]);" href="{{site.FLINK_DOWNLOAD_URL_HADOOP_1_STABLE}}"><i class="icon-download"> </i> Download Stratosphere for Hadoop 1.2</a>
  </div>
  <div class="tab-pane" id="bin-hadoop2">
-  <a class="btn btn-info btn-lg" onclick="_gaq.push(['_trackEvent','Action','download-quickstart-setup-2',this.href]);" href="{{site.current_stable_dl_yarn}}"><i class="icon-download"> </i> Download Stratosphere for Hadoop 2 (YARN)</a>
+  <a class="btn btn-info btn-lg" onclick="_gaq.push(['_trackEvent','Action','download-quickstart-setup-2',this.href]);" href="{{site.FLINK_DOWNLOAD_URL_HADOOP_2_STABLE}}"><i class="icon-download"> </i> Download Stratosphere for Hadoop 2</a>
  </div>
  </div>
 </p>
@@ -54,7 +54,8 @@ $ wget -O hamlet.txt http:https://www.gutenberg.org/cache/epub/1787/pg1787.txt
 * __Start the example program__:
 ```bash
 $ bin/stratosphere run \
- --jarfile ./examples/stratosphere-java-examples-{{site.current_stable}}-WordCount.jar \
+ --jarfile ./examples/stratosphere-java-examples-{{site.FLINK_VERSION_STABLE}}-WordCount.jar \
+
  --arguments file:https://`pwd`/hamlet.txt file:https://`pwd`/wordcount-result.txt
 ```
 * You will find a file called __wordcount-result.txt__ in your current directory.
@@ -75,7 +76,7 @@ The following __example__ illustrates the setup with three nodes (with IP addres
 
 <div class="row">
  <div class="col-md-6 text-center">
- <img src="{{ site.baseurl }}/img/quickstart_cluster.png" style="width: 85%">
+ <img src="img/quickstart_cluster.png" style="width: 85%">
  </div>
 <div class="col-md-6">
  <div class="row">
@@ -89,8 +90,7 @@ The following __example__ illustrates the setup with three nodes (with IP addres
  /path/to/<strong>stratosphere/<br>conf/slaves</strong>
  <pre>
  10.0.0.2
- 10.0.0.3
- </pre>
+ 10.0.0.3</pre>
  </p>
 </div>
 </div>
@@ -99,7 +99,7 @@ The following __example__ illustrates the setup with three nodes (with IP addres
 # Stratosphere on YARN
 You can easily deploy Stratosphere on your existing __YARN cluster__. 
 
-1. Download the __Stratosphere YARN package__ with the YARN client: [Stratosphere for YARN]({{site.current_stable_uberjar}})
+1. Download the __Stratosphere YARN package__ with the YARN client: [Stratosphere for YARN]({{site.FLINK_DOWNLOAD_URL_YARN_STABLE}})
 2. Make sure your __HADOOP_HOME__ (or _YARN_CONF_DIR_ or _HADOOP_CONF_DIR_) __environment variable__ is set to read your YARN and HDFS configuration.
 3. Run the __YARN client__ with: `./bin/yarn-session.sh`. You can run the client with options `-n 10 -tm 8192` to allocate 10 TaskManagers with 8GB of memory each.
 

diff --git a/docs/internals/slot_based_scheduling.jpg → docs/slot_based_scheduling.jpg b/docs/internals/slot_based_scheduling.jpg → docs/slot_based_scheduling.jpg
diff --git a/docs/spargel_guide.md b/docs/spargel_guide.md
@@ -25,7 +25,7 @@ Add the following dependency to your `pom.xml` to use the Spargel.
 <dependency>
  <groupId>eu.stratosphere</groupId>
  <artifactId>spargel</artifactId>
- <version>{{site.current_stable}}</version>
+ <version>{{site.FLINK_VERSION_STABLE}}</version>
 </dependency>
 ```
 

diff --git a/docs/internals/stack.svg → docs/stack.svg b/docs/internals/stack.svg → docs/stack.svg
diff --git a/docs/internals/state_machine.jpg → docs/state_machine.jpg b/docs/internals/state_machine.jpg → docs/state_machine.jpg