flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From se...@apache.org
Subject [2/2] flink git commit: [docs] Update README and internals (scheduling) for graduation and fix broken links
Date Thu, 08 Jan 2015 18:11:32 GMT
[docs] Update README and internals (scheduling) for graduation and fix broken links


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/7f659f61
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/7f659f61
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/7f659f61

Branch: refs/heads/master
Commit: 7f659f61ea6d0ab2833841bf46aaae42d5a927c1
Parents: 0954c4e
Author: Stephan Ewen <sewen@apache.org>
Authored: Thu Jan 8 18:32:22 2015 +0100
Committer: Stephan Ewen <sewen@apache.org>
Committed: Thu Jan 8 18:54:10 2015 +0100

----------------------------------------------------------------------
 README.md                       | 17 +++++++++--------
 docs/internal_job_scheduling.md | 20 ++++++++++----------
 2 files changed, 19 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/7f659f61/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 5b7af90..4a23dab 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ Flink is highlighted by some unique features:
 * Custom type analysis and serialization stack for high performance
 
 
-Learn more about Flink at http://flink.incubator.apache.org/
+Learn more about Flink at [http://flink.apache.org/](http://flink.apache.org/)
 
 
 ## Building Apache Flink from Source
@@ -62,17 +62,17 @@ The IntelliJ IDE supports Maven out of the box and offers a plugin for
Scala dev
 
 ### Eclipse Scala IDE
 
-We recommend using Scala IDE 3.0.3, based on Eclipse Kepler. While this is a slightly older
version,
+For Eclipse users, we recommend using Scala IDE 3.0.3, based on Eclipse Kepler. While this
is a slightly older version,
 we found it to be the verstion that works most robustly for a complex project like Flink.
 
 Further details, and a guide to newer Scala IDE versions can be found in the
-[How to setup Eclipse](https://github.com/StephanEwen/incubator-flink/blob/master/docs/internal_setup_eclipse.md)
docs.
+[How to setup Eclipse](https://github.com/apache/flink/blob/master/docs/internal_setup_eclipse.md)
docs.
 
 **Note:** Before following this setup, make sure to run the build from the command line once
 (`mvn clean package -DskipTests`, see above)
 
-1. Download the Scala IDE (preferred) or install the plugin to Eclipse Kepler. See [How to
setup Eclipse](apache/incubator-flink/blob/master/docs/internal_setup_eclipse.md)
-   for download links and instructions.
+1. Download the Scala IDE (preferred) or install the plugin to Eclipse Kepler. See 
+   [How to setup Eclipse](https://github.com/apache/flink/blob/master/docs/internal_setup_eclipse.md)
for download links and instructions.
 2. Add the "macroparadise" compiler plugin to the Scala compiler.
    Open "Window" -> "Preferences" -> "Scala" -> "Compiler" -> "Advanced" and
put into the "Xplugin" field the path to
    the *macroparadise* jar file (typically "/home/*-your-user-*/.m2/repository/org/scalamacros/paradise_2.10.4/2.0.1/paradise_2.10.4-2.0.1.jar").
@@ -86,14 +86,14 @@ Further details, and a guide to newer Scala IDE versions can be found
in the
 
 Don’t hesitate to ask!
 
-Please contact the developers on our [mailing lists](http://flink.incubator.apache.org/community.html#mailing-lists)
if you need help.
+Please contact the developers on our [mailing lists](http://flink.apache.org/community.html#mailing-lists)
if you need help.
 
 [Open an issue](https://issues.apache.org/jira/browse/FLINK) if you found a bug in Flink.
 
 
 ## Documentation
 
-The documentation of Apache Flink is located on the website: [http://flink.incubator.apache.org](http://flink.incubator.apache.org)
+The documentation of Apache Flink is located on the website: [http://flink.apache.org](http://flink.apache.org)
 or in the `docs/` directory of the source code.
 
 
@@ -101,10 +101,11 @@ or in the `docs/` directory of the source code.
 
 This is an active open-source project. We are always open to people who want to use the system
or contribute to it. 
 Contact us if you are looking for implementation tasks that fit your skills.
-This article describes [how to contribute to Apache Flink](http://flink.incubator.apache.org/how-to-contribute.html).
+This article describes [how to contribute to Apache Flink](http://flink.apache.org/how-to-contribute.html).
 
 
 ## About
 
 Apache Flink is an open source project of The Apache Software Foundation (ASF).
 The Apache Flink project originated from the [Stratosphere](http://stratosphere.eu) research
project.
+

http://git-wip-us.apache.org/repos/asf/flink/blob/7f659f61/docs/internal_job_scheduling.md
----------------------------------------------------------------------
diff --git a/docs/internal_job_scheduling.md b/docs/internal_job_scheduling.md
index 7fb4500..6cfde4d 100644
--- a/docs/internal_job_scheduling.md
+++ b/docs/internal_job_scheduling.md
@@ -44,8 +44,8 @@ parallism of 3. A pipeline consists of the sequence Source - Map - Reduce.
On a
 <img src="img/slots.svg" alt="Assigning Pipelines of Tasks to Slots" height="250px" style="text-align:
center;"/>
 </div>
 
-Internally, Flink defines through [SlotSharingGroup](https://github.com/apache/incubator-flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/SlotSharingGroup.java)

-and [CoLocationGroup](https://github.com/apache/incubator-flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/CoLocationGroup.java)
+Internally, Flink defines through {% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/SlotSharingGroup.java
"SlotSharingGroup" %} 
+and {% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/jobmanager/scheduler/CoLocationGroup.java
"CoLocationGroup" %}
 which tasks may share a slot (permissive), respectively which tasks must be strictly placed
into the same slot.
 
 
@@ -54,18 +54,18 @@ which tasks may share a slot (permissive), respectively which tasks must
be stri
 During job execution, the JobManager keeps track of distributed tasks, decides when to schedule
the next task (or set of tasks),
 and reacts to finished tasks or execution failures.
 
-The JobManager receives the [JobGraph](https://github.com/apache/incubator-flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/),
-which is a representation of the data flow consisting of operators ([JobVertex](https://github.com/apache/incubator-flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/AbstractJobVertex.java))
-and intermediate results ([IntermediateDataSet](https://github.com/apache/incubator-flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/IntermediateDataSet.java)).
+The JobManager receives the {% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/
"JobGraph" %},
+which is a representation of the data flow consisting of operators ({% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/AbstractJobVertex.java
"JobVertex" %})
+and intermediate results ({% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/jobgraph/IntermediateDataSet.java
"IntermediateDataSet" %}).
 Each operator has properies, like the degree of parallelism and the code that it executes.
 In addition, the JobGraph has a set of attached libraries, that are neccessary to execute
the code of the operators.
 
-The JobManager transforms the JobGraph into an [ExecutionGraph](https://github.com/apache/incubator-flink/tree/master/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph).
-The ExecutionGraph is a parallel version of the JobGraph: For each JobVertex, it contains
an [ExecutionVertex](https://github.com/apache/incubator-flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/ExecutionVertex.java)
per parallel subtask. An operator with a parallelism of 100 will have one JobVertex and 100
ExecutionVertices.
+The JobManager transforms the JobGraph into an {% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/
"ExecutionGraph" %}.
+The ExecutionGraph is a parallel version of the JobGraph: For each JobVertex, it contains
an {% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/ExecutionVertex.java
"ExecutionVertex" %} per parallel subtask. An operator with a parallelism of 100 will have
one JobVertex and 100 ExecutionVertices.
 The ExecutionVertex tracks the state of execution of a particular subtask. All ExecutionVertices
from one JobVertex are held in an
-[ExecutionJobVertex](https://github.com/apache/incubator-flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/ExecutionJobVertex.java),
+{% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/ExecutionJobVertex.java
"ExecutionJobVertex" %},
 which tracks the status of the operator as a whole. 
-Besides the vertices, the ExecutionGraph also contains the [IntermediateResult](https://github.com/apache/incubator-flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/IntermediateResult.java)
and the [IntermediateResultPartition](https://github.com/apache/incubator-flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/IntermediateResultPartition.java).
The former tracks the state of the *IntermediateDataSet*, the latter the state of each of
its partitions.
+Besides the vertices, the ExecutionGraph also contains the {% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/IntermediateResult.java
"IntermediateResult" %} and the {% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/IntermediateResultPartition.java
"IntermediateResultPartition" %}. The former tracks the state of the *IntermediateDataSet*,
the latter the state of each of its partitions.
 
 <div style="text-align: center;">
 <img src="img/job_and_execution_graph.svg" alt="JobGraph and ExecutionGraph" height="400px"
style="text-align: center;"/>
@@ -73,7 +73,7 @@ Besides the vertices, the ExecutionGraph also contains the [IntermediateResult](
 
 During its execution, each parallel task goes through multiple stages, from *created* to
*finished* or *failed*. The diagram below illustrates the 
 states and possible transitions between them. A task may be executed multiple times (for
example in the course of failure recovery).
-For that reason, the execution of an ExecutionVertex is tracked in an [Execution](https://github.com/apache/incubator-flink/blob/master/flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/Execution.java).
Each ExecutionVertex has a current Execution, and prior Executions.
+For that reason, the execution of an ExecutionVertex is tracked in an {% gh_link /flink-runtime/src/main/java/org/apache/flink/runtime/executiongraph/Execution.java
"Execution" %}. Each ExecutionVertex has a current Execution, and prior Executions.
 
 <div style="text-align: center;">
 <img src="img/state_machine.svg" alt="States and Transitions of Task Executions" height="300px"
style="text-align: center;"/>


Mime
View raw message