Build website
Project: http://git-wip-us.apache.org/repos/asf/flink-web/repo Commit: http://git-wip-us.apache.org/repos/asf/flink-web/commit/415ee891 Tree: http://git-wip-us.apache.org/repos/asf/flink-web/tree/415ee891 Diff: http://git-wip-us.apache.org/repos/asf/flink-web/diff/415ee891 Branch: refs/heads/asf-site Commit: 415ee89164efaca2d5802141330b4ac5661a0920 Parents: f2411e2 Author: Fabian Hueske <[email protected]> Authored: Thu Oct 8 12:51:45 2015 +0200 Committer: Fabian Hueske <[email protected]> Committed: Thu Oct 8 12:52:17 2015 +0200 ---------------------------------------------------------------------- content/blog/feed.xml | 20 +- content/blog/index.html | 6 +- content/blog/page2/index.html | 4 +- content/blog/page3/index.html | 8 +- content/blog/page4/index.html | 4 +- content/coding-guidelines.html | 227 --------- content/community.html | 22 +- content/contribute-code.html | 508 +++++++++++++++++++ content/contribute-documentation.html | 247 +++++++++ content/css/flink.css | 4 + content/downloads.html | 10 +- content/faq.html | 60 +-- content/features.html | 4 +- content/how-to-contribute.html | 270 ++++------ content/improve-website.html | 290 +++++++++++ content/index.html | 4 +- content/material.html | 16 +- content/news/2012/08/21/release02.html | 4 +- content/news/2012/10/15/icde2013.html | 4 +- content/news/2012/11/12/btw2013demo.html | 4 +- content/news/2012/11/21/previewICDE2013.html | 4 +- content/news/2013/03/27/www-demo-paper.html | 4 +- content/news/2013/10/21/cikm2013-paper.html | 4 +- .../2013/12/13/humboldt-innovation-award.html | 4 +- .../2014/01/10/stratosphere-hadoop-summit.html | 4 +- .../news/2014/01/12/0.4-migration-guide.html | 4 +- .../2014/01/13/stratosphere-release-0.4.html | 10 +- .../26/optimizer_plan_visualization_tool.html | 4 +- content/news/2014/01/28/querying_mongodb.html | 4 +- .../18/amazon-elastic-mapreduce-cloud-yarn.html | 10 +- ...stratosphere-google-summer-of-code-2014.html | 4 +- .../16/stratosphere-goes-apache-incubator.html | 4 +- content/news/2014/05/31/release-0.5.html | 4 +- content/news/2014/08/26/release-0.6.html | 4 +- content/news/2014/09/26/release-0.6.1.html | 4 +- content/news/2014/10/03/upcoming_events.html | 4 +- content/news/2014/11/04/release-0.7.0.html | 6 +- .../news/2014/11/18/hadoop-compatibility.html | 8 +- content/news/2015/01/06/december-in-flink.html | 4 +- content/news/2015/01/21/release-0.8.html | 6 +- content/news/2015/02/04/january-in-flink.html | 6 +- content/news/2015/02/09/streaming-example.html | 8 +- .../news/2015/03/02/february-2015-in-flink.html | 4 +- .../peeking-into-Apache-Flinks-Engine-Room.html | 22 +- content/news/2015/04/07/march-in-flink.html | 4 +- .../2015/04/13/release-0.9.0-milestone1.html | 4 +- .../05/11/Juggling-with-Bits-and-Bytes.html | 30 +- .../news/2015/05/14/Community-update-April.html | 8 +- .../announcing-apache-flink-0.9.0-release.html | 4 +- .../2015/08/24/introducing-flink-gelly.html | 28 +- content/news/2015/09/01/release-0.9.1.html | 4 +- content/news/2015/09/03/flink-forward.html | 4 +- content/news/2015/09/16/off-heap-memory.html | 4 +- content/privacy-policy.html | 4 +- content/project.html | 4 +- 55 files changed, 1407 insertions(+), 547 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/blog/feed.xml ---------------------------------------------------------------------- diff --git a/content/blog/feed.xml b/content/blog/feed.xml index 530b9cd..08a5699 100644 --- a/content/blog/feed.xml +++ b/content/blog/feed.xml @@ -2258,7 +2258,7 @@ Tez as an execution backend instead of Flinkâs own network stack. Learn more </item> <item> -<title>Peeking into Apache Flink's Engine Room</title> +<title>Peeking into Apache Flink's Engine Room</title> <description><h3 id="join-processing-in-apache-flink">Join Processing in Apache Flink</h3> <p>Joins are prevalent operations in many data processing applications. Most data processing systems feature APIs that make joining data sets very easy. However, the internal algorithms for join processing are much more involved â especially if large data sets need to be efficiently handled. Therefore, join processing serves as a good example to discuss the salient design points and implementation details of a data processing system.</p> @@ -2769,12 +2769,12 @@ INFO Socket Stream(1/1) switched to DEPLOYING INFO Custom Source(1/1) switched to SCHEDULED INFO Custom Source(1/1) switched to DEPLOYING ⦠-1&gt; StockPrice{symbol='SPX', count=1011.3405732645239} -2&gt; StockPrice{symbol='SPX', count=1018.3381290039248} -1&gt; StockPrice{symbol='DJI', count=1036.7454894073978} -3&gt; StockPrice{symbol='DJI', count=1135.1170217478427} -3&gt; StockPrice{symbol='BUX', count=1053.667523187687} -4&gt; StockPrice{symbol='BUX', count=1036.552601487263} +1&gt; StockPrice{symbol='SPX', count=1011.3405732645239} +2&gt; StockPrice{symbol='SPX', count=1018.3381290039248} +1&gt; StockPrice{symbol='DJI', count=1036.7454894073978} +3&gt; StockPrice{symbol='DJI', count=1135.1170217478427} +3&gt; StockPrice{symbol='BUX', count=1053.667523187687} +4&gt; StockPrice{symbol='BUX', count=1036.552601487263} </code></pre></div> <p><a href="#top">Back to top</a></p> @@ -3931,7 +3931,7 @@ Applying students can use our wiki (create a new page) to create a project propo <li>For the Hadoop distribution, it is very important to choose one with YARN support. We use <b>3.0.3 (Hadoop 2.2.0)</b> (the minor version might change over time)</li> <li>Remove all applications to be installed (unless you want to use them)</li> <li>Choose the instance types you want to start. Stratosphere runs fine with m1.large instances. Core and Task instances both run Stratosphere, but only core instances contain HDFS data nodes.</li> - <li>Choose the <b>EC2 key pair</b> you've created in the previous step!</li> + <li>Choose the <b>EC2 key pair</b> you've created in the previous step!</li> </ul> </div> </div> @@ -3991,7 +3991,7 @@ The arguments have the following meaning <ul> <li> Open an additional terminal and connect again to the master of your cluster. </li> -We recommend to create a SOCKS-proxy with your SSH that allows you to easily connect into the cluster. (If you've already a VPN setup with EC2, you can probably use that as well.) +We recommend to create a SOCKS-proxy with your SSH that allows you to easily connect into the cluster. (If you've already a VPN setup with EC2, you can probably use that as well.) <div class="highlight"><pre><code class="language-bash" data-lang="bash">ssh -D localhost:2001 hadoop@&lt;your master dns name&gt; -i &lt;your pem file&gt;</code></pre></div> @@ -4473,7 +4473,7 @@ The demo shows how static code analysis can be leveraged to reordered UDF operat <description> <p>Our demo submission<br /> <strong><cite>"Applying Stratosphere for Big Data Analytics"</cite></strong><br /> has been accepted for BTW 2013 in Magdeburg, Germany.<br /> -The demo focuses on Stratosphere's query language Meteor, which has been presented in our paper <cite>"Meteor/Sopremo: An Extensible Query Language and Operator Model"</cite> <a href="/assets/papers/Sopremo_Meteor BigData.pdf">[pdf]</a> at the BigData workshop associated with VLDB 2012 in Istanbul.</p> +The demo focuses on Stratosphere's query language Meteor, which has been presented in our paper <cite>"Meteor/Sopremo: An Extensible Query Language and Operator Model"</cite> <a href="/assets/papers/Sopremo_Meteor BigData.pdf">[pdf]</a> at the BigData workshop associated with VLDB 2012 in Istanbul.</p> <p>Visit our demo, and talk to us if you are going to attend BTW 2013.</p> <p><strong>Abstract:</strong><br /> Analyzing big data sets as they occur in modern business and science applications requires query languages that allow for the specification of complex data processing tasks. Moreover, these ideally declarative query specifications have to be optimized, parallelized and scheduled for processing on massively parallel data processing platforms. This paper demonstrates the application of Stratosphere to different kinds of Big Data Analytics tasks. Using examples from different application domains, we show how to formulate analytical tasks as Meteor queries and execute them with Stratosphere. These examples include data cleansing and information extraction tasks, and a correlation analysis of microblogging and stock trade volume data that we describe in detail in this paper.</p> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/blog/index.html ---------------------------------------------------------------------- diff --git a/content/blog/index.html b/content/blog/index.html index 7672859..d26c49b 100644 --- a/content/blog/index.html +++ b/content/blog/index.html @@ -112,7 +112,9 @@ <li class="divider"></li> <li role="presentation" class="dropdown-header"><strong>Contribute</strong></li> <li><a href="/how-to-contribute.html">How to Contribute</a></li> - <li><a href="/coding-guidelines.html">Coding Guidelines</a></li> + <li><a href="/contribute-code.html">Contribute Code</a></li> + <li><a href="/contribute-documentation.html">Contribute Documentation</a></li> + <li><a href="/improve-website.html">Improve the Website</a></li> </ul> </li> @@ -191,7 +193,7 @@ Apache Flink started.</p> <h2 class="blog-title"><a href="/news/2015/08/24/introducing-flink-gelly.html">Introducing Gelly: Graph Processing with Apache Flink</a></h2> <p>24 Aug 2015</p> - <p><p>This blog post introduces <strong>Gelly</strong>, Apache Flink’s <em>graph-processing API and library</em>. Flink’s native support + <p><p>This blog post introduces <strong>Gelly</strong>, Apache Flinkâs <em>graph-processing API and library</em>. Flinkâs native support for iterations makes it a suitable platform for large-scale graph analytics. By leveraging delta iterations, Gelly is able to map various graph processing models such as vertex-centric or gather-sum-apply to Flink dataflows.</p> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/blog/page2/index.html ---------------------------------------------------------------------- diff --git a/content/blog/page2/index.html b/content/blog/page2/index.html index 2dcd1ab..4f62fe8 100644 --- a/content/blog/page2/index.html +++ b/content/blog/page2/index.html @@ -112,7 +112,9 @@ <li class="divider"></li> <li role="presentation" class="dropdown-header"><strong>Contribute</strong></li> <li><a href="/how-to-contribute.html">How to Contribute</a></li> - <li><a href="/coding-guidelines.html">Coding Guidelines</a></li> + <li><a href="/contribute-code.html">Contribute Code</a></li> + <li><a href="/contribute-documentation.html">Contribute Documentation</a></li> + <li><a href="/improve-website.html">Improve the Website</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/blog/page3/index.html ---------------------------------------------------------------------- diff --git a/content/blog/page3/index.html b/content/blog/page3/index.html index 5f39e22..36512a1 100644 --- a/content/blog/page3/index.html +++ b/content/blog/page3/index.html @@ -112,7 +112,9 @@ <li class="divider"></li> <li role="presentation" class="dropdown-header"><strong>Contribute</strong></li> <li><a href="/how-to-contribute.html">How to Contribute</a></li> - <li><a href="/coding-guidelines.html">Coding Guidelines</a></li> + <li><a href="/contribute-code.html">Contribute Code</a></li> + <li><a href="/contribute-documentation.html">Contribute Documentation</a></li> + <li><a href="/improve-website.html">Improve the Website</a></li> </ul> </li> @@ -214,7 +216,7 @@ <h2 class="blog-title"><a href="/news/2014/01/26/optimizer_plan_visualization_tool.html">Optimizer Plan Visualization Tool</a></h2> <p>26 Jan 2014</p> - <p><p>Stratosphere’s hybrid approach combines <strong>MapReduce</strong> and <strong>MPP database</strong> techniques. One central part of this approach is to have a <strong>separation between the programming (API) and the way programs are executed</strong> <em>(execution plans)</em>. The <strong>compiler/optimizer</strong> decides the details concerning caching or when to partition/broadcast with a holistic view of the program. The same program may actually be executed differently in different scenarios (input data of different sizes, different number of machines).</p> + <p><p>Stratosphereâs hybrid approach combines <strong>MapReduce</strong> and <strong>MPP database</strong> techniques. One central part of this approach is to have a <strong>separation between the programming (API) and the way programs are executed</strong> <em>(execution plans)</em>. The <strong>compiler/optimizer</strong> decides the details concerning caching or when to partition/broadcast with a holistic view of the program. The same program may actually be executed differently in different scenarios (input data of different sizes, different number of machines).</p> </p> @@ -253,7 +255,7 @@ <h2 class="blog-title"><a href="/news/2014/01/10/stratosphere-hadoop-summit.html">Stratosphere got accepted to the Hadoop Summit Europe in Amsterdam</a></h2> <p>10 Jan 2014</p> - <p><p>The Stratosphere team is proud to announce that it is going to present at the <a href="http://hadoopsummit.org/amsterdam/";>Hadoop Summit 2014 in Amsterdam</a> on April 2-3. Our talk “Big Data looks tiny from Stratosphere” is part of the “Future of Hadoop” Track. The talk abstract already made it into the top 5 in the <a href="https://hadoopsummit.uservoice.com/forums/196822-future-of-apache-hadoop/filters/top";>Community Vote</a> that took place by the end of last year.</p> + <p><p>The Stratosphere team is proud to announce that it is going to present at the <a href="http://hadoopsummit.org/amsterdam/";>Hadoop Summit 2014 in Amsterdam</a> on April 2-3. Our talk âBig Data looks tiny from Stratosphereâ is part of the âFuture of Hadoopâ Track. The talk abstract already made it into the top 5 in the <a href="https://hadoopsummit.uservoice.com/forums/196822-future-of-apache-hadoop/filters/top";>Community Vote</a> that took place by the end of last year.</p> </p> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/blog/page4/index.html ---------------------------------------------------------------------- diff --git a/content/blog/page4/index.html b/content/blog/page4/index.html index 6c2b8fa..018512d 100644 --- a/content/blog/page4/index.html +++ b/content/blog/page4/index.html @@ -112,7 +112,9 @@ <li class="divider"></li> <li role="presentation" class="dropdown-header"><strong>Contribute</strong></li> <li><a href="/how-to-contribute.html">How to Contribute</a></li> - <li><a href="/coding-guidelines.html">Coding Guidelines</a></li> + <li><a href="/contribute-code.html">Contribute Code</a></li> + <li><a href="/contribute-documentation.html">Contribute Documentation</a></li> + <li><a href="/improve-website.html">Improve the Website</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/coding-guidelines.html ---------------------------------------------------------------------- diff --git a/content/coding-guidelines.html b/content/coding-guidelines.html deleted file mode 100644 index 9abe396..0000000 --- a/content/coding-guidelines.html +++ /dev/null @@ -1,227 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> - <meta http-equiv="X-UA-Compatible" content="IE=edge"> - <meta name="viewport" content="width=device-width, initial-scale=1"> - <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> - <title>Apache Flink: Coding Guidelines</title> - <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> - <link rel="icon" href="/favicon.ico" type="image/x-icon"> - - <!-- Bootstrap --> - <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css";> - <link rel="stylesheet" href="/css/flink.css"> - <link rel="stylesheet" href="/css/syntax.css"> - - <!-- Blog RSS feed --> - <link href="/blog/feed.xml" rel="alternate" type="application/rss+xml" title="Apache Flink Blog: RSS feed" /> - - <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> - <!-- WARNING: Respond.js doesn't work if you view the page via file:// --> - <!--[if lt IE 9]> - <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> - <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> - <![endif]--> - </head> - <body> - - - <!-- Top navbar. --> - <nav class="navbar navbar-default navbar-fixed-top"> - <div class="container"> - <!-- The logo. --> - <div class="navbar-header"> - <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - <span class="icon-bar"></span> - </button> - <div class="navbar-logo"> - <a href="/"><img alt="Apache Flink" src="/img/navbar-brand-logo.jpg" width="78px" height="40px"></a> - </div> - </div><!-- /.navbar-header --> - - <!-- The navigation links. --> - <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> - <ul class="nav navbar-nav"> - <!-- Overview --> - <li><a href="/index.html">Overview</a></li> - - <!-- Quickstart --> - <li class="dropdown"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Quickstart <span class="caret"></span></a> - <ul class="dropdown-menu" role="menu"> - <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/setup_quickstart.html";>Setup</a></li> - <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/java_api_quickstart.html";>Java API</a></li> - <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/scala_api_quickstart.html";>Scala API</a></li> - <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/run_example_quickstart.html";>Run Step-by-Step Example</a></li> - </ul> - </li> - - <!-- Features --> - <li><a href="/features.html">Features</a></li> - - <!-- Downloads --> - <li><a href="/downloads.html">Downloads</a></li> - - <!-- Documentation --> - <li class="dropdown"> - <a href="" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation <span class="caret"></span></a> - <ul class="dropdown-menu" role="menu"> - <!-- Latest stable release --> - <li role="presentation" class="dropdown-header"><strong>Latest Release</strong> (Stable)</li> - <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9";>0.9.1 Documentation</a></li> - <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/api/java"; class="active">0.9.1 Javadocs</a></li> - <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/api/scala/index.html"; class="active">0.9.1 ScalaDocs</a></li> - - <!-- Snapshot docs --> - <li class="divider"></li> - <li role="presentation" class="dropdown-header"><strong>Snapshot</strong> (Development)</li> - <li><a href="http://ci.apache.org/projects/flink/flink-docs-master";>0.10 Documentation</a></li> - <li><a href="http://ci.apache.org/projects/flink/flink-docs-master/api/java"; class="active">0.10 Javadocs</a></li> - <li><a href="http://ci.apache.org/projects/flink/flink-docs-master/api/scala/index.html"; class="active">0.10 ScalaDocs</a></li> - - <!-- Wiki --> - <li class="divider"></li> - <li><a href="https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home";><small><span class="glyphicon glyphicon-new-window"></span></small> Wiki</a></li> - </ul> - </li> - - <!-- FAQ --> - <li><a href="/faq.html">FAQ</a></li> - </ul> - - <ul class="nav navbar-nav navbar-right"> - <!-- Blog --> - <li class=" hidden-md hidden-sm"><a href="/blog/">Blog</a></li> - - <li class="dropdown active hidden-md hidden-sm"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Community <span class="caret"></span></a> - <ul class="dropdown-menu" role="menu"> - <!-- Community --> - <li role="presentation" class="dropdown-header"><strong>Community</strong></li> - <li><a href="/community.html#mailing-lists">Mailing Lists</a></li> - <li><a href="/community.html#irc">IRC</a></li> - <li><a href="/community.html#stack-overflow">Stack Overflow</a></li> - <li><a href="/community.html#issue-tracker">Issue Tracker</a></li> - <li><a href="/community.html#source-code">Source Code</a></li> - <li><a href="/community.html#people">People</a></li> - - <!-- Contribute --> - <li class="divider"></li> - <li role="presentation" class="dropdown-header"><strong>Contribute</strong></li> - <li><a href="/how-to-contribute.html">How to Contribute</a></li> - <li><a href="/coding-guidelines.html">Coding Guidelines</a></li> - </ul> - </li> - - <li class="dropdown hidden-md hidden-sm"> - <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Project <span class="caret"></span></a> - <ul class="dropdown-menu" role="menu"> - <!-- Project --> - <li role="presentation" class="dropdown-header"><strong>Project</strong></li> - <li><a href="/material.html">Material</a></li> - <li><a href="https://twitter.com/apacheflink";><small><span class="glyphicon glyphicon-new-window"></span></small> Twitter</a></li> - <li><a href="https://github.com/apache/flink";><small><span class="glyphicon glyphicon-new-window"></span></small> GitHub</a></li> - <li><a href="https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home";><small><span class="glyphicon glyphicon-new-window"></span></small> Wiki</a></li> - </ul> - </li> - </ul> - </div><!-- /.navbar-collapse --> - </div><!-- /.container --> - </nav> - - - <!-- Main content. --> - <div class="container"> - - -<div class="row"> - <div class="col-sm-8 col-sm-offset-2"> - <div class="row"> - <div class="col-sm-12"><h1>Coding Guidelines</h1></div> - </div> - -<p>These are the coding and style guidelines that we follow.</p> - -<h2 id="guidelines-for-pull-requests-and-patches">Guidelines for pull requests and patches</h2> - -<ul> - <li><strong>JIRA issue and commit message</strong>. A pull request should relate to a JIRA issue; create an issue if none exists for the change you want to make. The latest commit message should reference that issue. An example commit message would be <em>[FLINK-633] Fix NullPointerException for empty UDF parameters</em>. That way, the pull request automatically gives a description of what it does, for example what bug does it fix in what way.</li> - <li><strong>Documentation Updates</strong>. Many changes in the system will also affect the documentation (both JavaDocs and the user documentation in the <code>docs/</code> directory.). Pull requests and patches are required to update the documentation accordingly, otherwise the change can not be accepted to the source code.</li> - <li><strong>No WIP pull requests</strong>. We consider pull requests as requests to merge the referenced code <em>as is</em> into the current <em>stable</em> master branch. Therefore, a pull request should not be âwork in progressâ. Open a pull request if you are confident that it can be merged into the current master branch without problems. If you rather want comments on your code, post a link to your working branch.</li> - <li><strong>Single change per PR</strong>. Please do not combine various unrelated changes in a single pull request. Rather, open multiple individual pull requests. This ensures that pull requests are <em>topic related</em>, can be merged more easily, and typically result in topic-specific merge conflicts only.</li> - <li><strong>Tests need to pass</strong>. Any pull request where the tests do not pass or which does not compile will not undergo any further review. We recommend to connect your private GitHub accounts with <a href="http://travis-ci.org/";>Travis CI</a> (like the Flink GitHub repository). Travis will run tests for all tested environments whenever you push something into <em>your</em> Github repository.</li> - <li><strong>No reformattings</strong>. Please keep reformatting of source files to a minimum. Diffs become unreadable if you (or your IDE automatically) remove or replace whitespaces, reformat code, or comments. Also, other patches that affect the same files become un-mergeable. Please configure your IDE such that code is not automatically reformatted. Pull requests with excessive or unnecessary code reformatting might be rejected.</li> - <li><strong>Tests for new features are required</strong>. All new features need to be backed by tests, <em>strictly</em>. It is very easy that a later merge accidentally throws out a feature or breaks it. This will not be caught if the feature is not guarded by tests. Anything not covered by a test is considered cosmetic.</li> - <li><strong>Cleanup</strong>. Before opening a pull request follow this checklist: - <ul> - <li>Rebase onto the latest version of the master branch</li> - <li>Clean up your commits, i.e., squash them in a reasonable way and give meaningful commit messages</li> - <li>Run <em>all</em> tests either locally with <code>mvn clean verify</code> or use Travis CI to check the build</li> - </ul> - </li> - <li><strong>Append review commits</strong>. When you get comments on the pull request asking for changes, append commits for these changes. <em>Do not rebase and squash them.</em> It allows people to review the cleanup work independently. Otherwise reviewers have to go through the entire set of diffs again.</li> - <li><strong>Javadocs for public methods</strong>. Public methods and classes that are part of the user-facing API need to have JavaDocs. Please write meaningful docs. Good docs are concise and informative.</li> - <li><strong>Meaningful error messages</strong>. Give meaningful exception messages. Try to imagine why an exception could be thrown (what a user did wrong) and give a message that will help a user to resolve the problem.</li> - <li><strong>Follow the coding style</strong> (see below). The checkstyle plugin verifies these rules when you build the code. If your code does not follow the checkstyle rules, Maven will not compile it and consequently the build will fail.</li> -</ul> - -<h2 id="coding-style-guidelines">Coding Style Guidelines</h2> - -<ul> - <li><strong>Apache license headers</strong>. Make sure you have Apache License headers in your files. The RAT plugin is checking for that when you build the code.</li> - <li><strong>Tabs vs. spaces</strong>. We are using tabs for indentation, not spaces. We are not religious there, it just happened to be that we started with tabs, and it is important to not mix them (merge/diff conflicts).</li> - <li> - <p><strong>Blocks</strong>. All statements after <code>if</code>, <code>for</code>, <code>while</code>, <code>do</code>, ⦠must always be encapsulated in a block with curly braces (even if the block contains one statement):</p> - - <div class="highlight"><pre><code class="language-java"><span class="k">for</span> <span class="o">(...)</span> <span class="o">{</span> - <span class="o">...</span> -<span class="o">}</span></code></pre></div> - <p>If you are wondering why, recall the famous <a href="https://www.imperialviolet.org/2014/02/22/applebug.html";><em>goto bug</em></a> in Appleâs SSL library.</p> - </li> - <li><strong>No wildcard imports</strong>. Do not use wildcard imports in the core files. They can cause problems when adding to the code and in some cases even during refactoring. Exceptions are the Tuple classes, Tuple-related utilities, and Flink user programs, when importing operators/functions. Tests are a special case of the user programs.</li> - <li><strong>No unused imports</strong>. Remove all unused imports.</li> - <li><strong>Use Guava Checks</strong>. To increase homogeneity, consistently use Guava methods checkNotNull and checkArgument rather than Apache Commons Validate.</li> - <li><strong>No raw generic types</strong>. Do not use raw generic types, unless strictly necessary (sometime necessary for signature matches, arrays).</li> - <li><strong>Supress warnings</strong>. Add annotations to suppress warnings, if they cannot be avoided (such as âuncheckedâ, or âserialâ).</li> - <li> - <p><strong>Comments</strong>. Add comments to your code. What is it doing? Add JavaDocs or inherit them by not adding any comments to the methods. Do not automatically generate comments and avoid unnecessary comments like:</p> - - <div class="highlight"><pre><code class="language-java"><span class="n">i</span><span class="o">++;</span> <span class="c1">// increment by one</span></code></pre></div> - </li> -</ul> - - - </div> -</div> - - - <hr /> - <div class="footer text-center"> - <p>Copyright © 2014-2015 <a href="http://apache.org";>The Apache Software Foundation</a>. All Rights Reserved.</p> - <p>Apache Flink, Apache, and the Apache feather logo are trademarks of The Apache Software Foundation.</p> - <p><a href="/privacy-policy.html">Privacy Policy</a> · <a href="/blog/feed.xml">RSS feed</a></p> - </div> - - </div><!-- /.container --> - - <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> - <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> - <!-- Include all compiled plugins (below), or include individual files as needed --> - <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js";></script> - <script src="/js/codetabs.js"></script> - - <!-- Google Analytics --> - <script> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-52545728-1', 'auto'); - ga('send', 'pageview'); - </script> - </body> -</html> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/community.html ---------------------------------------------------------------------- diff --git a/content/community.html b/content/community.html index 2084a87..8442d59 100644 --- a/content/community.html +++ b/content/community.html @@ -112,7 +112,9 @@ <li class="divider"></li> <li role="presentation" class="dropdown-header"><strong>Contribute</strong></li> <li><a href="/how-to-contribute.html">How to Contribute</a></li> - <li><a href="/coding-guidelines.html">Coding Guidelines</a></li> + <li><a href="/contribute-code.html">Contribute Code</a></li> + <li><a href="/contribute-documentation.html">Contribute Documentation</a></li> + <li><a href="/improve-website.html">Improve the Website</a></li> </ul> </li> @@ -147,17 +149,17 @@ <div class="page-toc"> <ul id="markdown-toc"> - <li><a href="#mailing-lists" id="markdown-toc-mailing-lists">Mailing Lists</a></li> - <li><a href="#irc" id="markdown-toc-irc">IRC</a></li> - <li><a href="#stack-overflow" id="markdown-toc-stack-overflow">Stack Overflow</a></li> - <li><a href="#issue-tracker" id="markdown-toc-issue-tracker">Issue Tracker</a></li> - <li><a href="#source-code" id="markdown-toc-source-code">Source Code</a> <ul> - <li><a href="#main-source-repositories" id="markdown-toc-main-source-repositories">Main source repositories</a></li> - <li><a href="#website-repositories" id="markdown-toc-website-repositories">Website repositories</a></li> + <li><a href="#mailing-lists">Mailing Lists</a></li> + <li><a href="#irc">IRC</a></li> + <li><a href="#stack-overflow">Stack Overflow</a></li> + <li><a href="#issue-tracker">Issue Tracker</a></li> + <li><a href="#source-code">Source Code</a> <ul> + <li><a href="#main-source-repositories">Main source repositories</a></li> + <li><a href="#website-repositories">Website repositories</a></li> </ul> </li> - <li><a href="#people" id="markdown-toc-people">People</a></li> - <li><a href="#former-mentors" id="markdown-toc-former-mentors">Former mentors</a></li> + <li><a href="#people">People</a></li> + <li><a href="#former-mentors">Former mentors</a></li> </ul> </div> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/contribute-code.html ---------------------------------------------------------------------- diff --git a/content/contribute-code.html b/content/contribute-code.html new file mode 100644 index 0000000..b0a634f --- /dev/null +++ b/content/contribute-code.html @@ -0,0 +1,508 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + <title>Apache Flink: Contributing Code</title> + <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> + <link rel="icon" href="/favicon.ico" type="image/x-icon"> + + <!-- Bootstrap --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css";> + <link rel="stylesheet" href="/css/flink.css"> + <link rel="stylesheet" href="/css/syntax.css"> + + <!-- Blog RSS feed --> + <link href="/blog/feed.xml" rel="alternate" type="application/rss+xml" title="Apache Flink Blog: RSS feed" /> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!-- WARNING: Respond.js doesn't work if you view the page via file:// --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> + </head> + <body> + + + <!-- Top navbar. --> + <nav class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <!-- The logo. --> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <div class="navbar-logo"> + <a href="/"><img alt="Apache Flink" src="/img/navbar-brand-logo.jpg" width="78px" height="40px"></a> + </div> + </div><!-- /.navbar-header --> + + <!-- The navigation links. --> + <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> + <ul class="nav navbar-nav"> + <!-- Overview --> + <li><a href="/index.html">Overview</a></li> + + <!-- Quickstart --> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Quickstart <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu"> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/setup_quickstart.html";>Setup</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/java_api_quickstart.html";>Java API</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/scala_api_quickstart.html";>Scala API</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/run_example_quickstart.html";>Run Step-by-Step Example</a></li> + </ul> + </li> + + <!-- Features --> + <li><a href="/features.html">Features</a></li> + + <!-- Downloads --> + <li><a href="/downloads.html">Downloads</a></li> + + <!-- Documentation --> + <li class="dropdown"> + <a href="" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu"> + <!-- Latest stable release --> + <li role="presentation" class="dropdown-header"><strong>Latest Release</strong> (Stable)</li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9";>0.9.1 Documentation</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/api/java"; class="active">0.9.1 Javadocs</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/api/scala/index.html"; class="active">0.9.1 ScalaDocs</a></li> + + <!-- Snapshot docs --> + <li class="divider"></li> + <li role="presentation" class="dropdown-header"><strong>Snapshot</strong> (Development)</li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-master";>0.10 Documentation</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-master/api/java"; class="active">0.10 Javadocs</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-master/api/scala/index.html"; class="active">0.10 ScalaDocs</a></li> + + <!-- Wiki --> + <li class="divider"></li> + <li><a href="https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home";><small><span class="glyphicon glyphicon-new-window"></span></small> Wiki</a></li> + </ul> + </li> + + <!-- FAQ --> + <li><a href="/faq.html">FAQ</a></li> + </ul> + + <ul class="nav navbar-nav navbar-right"> + <!-- Blog --> + <li class=" hidden-md hidden-sm"><a href="/blog/">Blog</a></li> + + <li class="dropdown hidden-md hidden-sm"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Community <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu"> + <!-- Community --> + <li role="presentation" class="dropdown-header"><strong>Community</strong></li> + <li><a href="/community.html#mailing-lists">Mailing Lists</a></li> + <li><a href="/community.html#irc">IRC</a></li> + <li><a href="/community.html#stack-overflow">Stack Overflow</a></li> + <li><a href="/community.html#issue-tracker">Issue Tracker</a></li> + <li><a href="/community.html#source-code">Source Code</a></li> + <li><a href="/community.html#people">People</a></li> + + <!-- Contribute --> + <li class="divider"></li> + <li role="presentation" class="dropdown-header"><strong>Contribute</strong></li> + <li><a href="/how-to-contribute.html">How to Contribute</a></li> + <li><a href="/contribute-code.html">Contribute Code</a></li> + <li><a href="/contribute-documentation.html">Contribute Documentation</a></li> + <li><a href="/improve-website.html">Improve the Website</a></li> + </ul> + </li> + + <li class="dropdown hidden-md hidden-sm"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Project <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu"> + <!-- Project --> + <li role="presentation" class="dropdown-header"><strong>Project</strong></li> + <li><a href="/material.html">Material</a></li> + <li><a href="https://twitter.com/apacheflink";><small><span class="glyphicon glyphicon-new-window"></span></small> Twitter</a></li> + <li><a href="https://github.com/apache/flink";><small><span class="glyphicon glyphicon-new-window"></span></small> GitHub</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home";><small><span class="glyphicon glyphicon-new-window"></span></small> Wiki</a></li> + </ul> + </li> + </ul> + </div><!-- /.navbar-collapse --> + </div><!-- /.container --> + </nav> + + + <!-- Main content. --> + <div class="container"> + + +<div class="row"> + <div class="col-sm-8 col-sm-offset-2"> + <div class="row"> + <div class="col-sm-12"><h1>Contributing Code</h1></div> + </div> + +<p>Apache Flink is maintained, improved, and extended by code contributions of volunteers. The Apache Flink community encourages anybody to contribute source code. In order to ensure a pleasant contribution experience for contributors and reviewers and to preserve the high quality of the code base, we follow a contribution process that is explained in this document.</p> + +<p>This document contains everything you need to know about contributing code to Apache Flink. It describes the process of preparing, testing and submitting a contribution, explains coding guidelines and code style of Flinkâs code base, and gives instructions to setup a development environment.</p> + +<p><strong>IMPORTANT</strong>: Please read this document carefully before starting to work on a code contribution. It is important to follow the process and guidelines explained below. Otherwise, your pull request might not be accepted or might require substantial rework.</p> + +<div class="page-toc"> +<ul id="markdown-toc"> + <li><a href="#code-contribution-process">Code Contribution Process</a> <ul> + <li><a href="#before-you-start-coding">Before you start codingâ¦</a></li> + <li><a href="#while-coding">While codingâ¦</a></li> + <li><a href="#verifying-the-compliance-of-your-code">Verifying the compliance of your code</a></li> + <li><a href="#preparing-and-submitting-your-contribution">Preparing and submitting your contribution</a></li> + </ul> + </li> + <li><a href="#coding-guidelines">Coding guidelines</a></li> + <li><a href="#code-style">Code style</a></li> + <li><a href="#best-practices">Best practices</a></li> + <li><a href="#setup-a-development-environment">Setup a development environment</a> <ul> + <li><a href="#requirements-for-developing-and-building-flink">Requirements for developing and building Flink</a></li> + </ul> + </li> + <li><a href="#how-to-use-git-as-a-committer">How to use Git as a committer</a></li> + <li><a href="#snapshots-nightly-builds">Snapshots (Nightly Builds)</a></li> +</ul> + +</div> + +<h2 id="code-contribution-process">Code Contribution Process</h2> + +<h3 id="before-you-start-coding">Before you start codingâ¦</h3> + +<p>⦠please make sure there is a JIRA issue that corresponds to your contribution. This is a <em>general rule</em> that the Flink community follows for all code contributions, including bug fixes, improvements, or new features, with an exception for <em>trivial</em> hot fixes. If you would like to fix a bug that you found or if you would like to add a new feature or improvement to Flink, please follow the <a href="/how-to-contribute.html#file-a-bug-report">File a bug report</a> or <a href="/how-to-contribute.html#propose-an-improvement-or-a-new-feature">Propose an improvement or a new feature</a> guidelines to open an issue in <a href="http://issues.apache.org/jira/browse/FLINK";>Flinkâs JIRA</a> before starting with the implementation.</p> + +<p>If the description of a JIRA issue indicates that its resolution will touch sensible parts of the code base, be sufficiently complex, or add significant amounts of new code, the Flink community might request a design document (most contributions should not require a design document). The purpose of this document is to ensure that the overall approach to address the issue is sensible and agreed upon by the community. JIRA issues that require a design document are tagged with the <strong><code>requires-design-doc</code></strong> label. The label can be attached by any community member who feels that a design document is necessary. A good description helps to decide whether a JIRA issue requires a design document or not. The design document must be added or attached to or link from the JIRA issue and cover the following aspects:</p> + +<ul> + <li>Overview of the general approach</li> + <li>List of API changes (changed interfaces, new and deprecated configuration parameters, changed behavior, â¦)</li> + <li>Main components and classes to be touched</li> + <li>Known limitations of the proposed approach</li> +</ul> + +<p>A design document can be added by anybody, including the reporter of the issue or the person working on it.</p> + +<p>Contributions for JIRA issues that require a design document will not be added to Flinkâs code base before a design document has been accepted by the community with <a href="http://www.apache.org/foundation/glossary.html#LazyConsensus";>lazy consensus</a>. Please check if a design document is required before starting to code.</p> + +<h3 id="while-coding">While codingâ¦</h3> + +<p>⦠please respect the following rules:</p> + +<ul> + <li>Take any discussion or requirement that is recorded in the JIRA issue into account.</li> + <li>Follow the design document (if a design document is required) as close as possible. Please update the design document and seek consensus, if your implementation deviates too much from the solution proposed by the design document. Minor variations are OK but should be pointed out when the contribution is submitted.</li> + <li>Closely follow the <a href="/contribute-code.html#coding-guidelines">coding guidelines</a> and the <a href="/contribute-code.html#code-style">code style</a>.</li> + <li>Do not mix unrelated issues into one contribution. </li> +</ul> + +<p><strong>Please feel free to ask questions at any time.</strong> Either send a mail to the <a href="/community.html#mailing-lists">dev mailing list</a> or comment on the JIRA issue.</p> + +<p>The following instructions will help you to <a href="/contribute-code.html#setup-a-development-environment">setup a development environment</a>.</p> + +<h3 id="verifying-the-compliance-of-your-code">Verifying the compliance of your code</h3> + +<p>It is very important to verify the compliance of changes before submitting your contribution. This includes:</p> + +<ul> + <li>Making sure the code builds.</li> + <li>Verifying that all existing and new tests pass.</li> + <li>Check that the code style is not violated.</li> + <li>Making sure no unrelated or unnecessary reformatting changes are included.</li> +</ul> + +<p>You can build the code, run the tests, and check (parts of) the code style by calling </p> + +<div class="highlight"><pre><code>mvn clean verify +</code></pre></div> + +<p>Please note, that some tests in Flinkâs code base are flaky and can fail by chance. The Flink community is working hard on improving these tests but sometimes this is not possible, e.g., when tests include external dependencies. We maintain all tests that are known to be flaky in JIRA and attach the <strong><code>test-stability</code></strong> label. Please check (and extend) this list of <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20FLINK%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20test-stability%20ORDER%20BY%20priority%20DESC";>known flaky tests</a> if you encounter a test failure that seems to be unrelated to your changes.</p> + +<p>Please note, that we run additional build profiles for different combinations of Java, Scala, and Hadoop versions to validate your contribution. We encourage every contributor to use a <em>continuous integration</em> service that will automatically test the code in your repository whenever you push a change. The <a href="/contribute-code.html#best-practices">Best practices</a> guide shows how to integrate <a href="https://travis-ci.org/";>Travis</a> with your Github repository.</p> + +<p>In addition to the automated tests, please check the diff of your changes and remove all unrelated changes such as unnecessary reformatting.</p> + +<h3 id="preparing-and-submitting-your-contribution">Preparing and submitting your contribution</h3> + +<p>To make the changes easily mergeable, please rebase them to the latest version of the main repositories master branch. Please do also respect the <a href="/contribute-code.html#coding-guidelines">commit message guidelines</a>, clean up your commit history, and squash your commits to an appropriate set. Please verify your contribution one more time after rebasing and commit squashing as described above.</p> + +<p>The Flink project accepts code contributions through the <a href="https://github.com/apache/flink";>GitHub Mirror</a>, in the form of <a href="https://help.github.com/articles/using-pull-requests";>Pull Requests</a>. Pull requests are a simple way to offer a patch, by providing a pointer to a code branch that contains the change.</p> + +<p>To open a pull request, push our contribution back into your fork of the Flink repository.</p> + +<div class="highlight"><pre><code>git push origin myBranch +</code></pre></div> + +<p>Go the website of your repository fork (<code>https://github.com/<your-user-name>/flink</code>) and use the <em>âCreate Pull Requestâ</em> button to start creating a pull request. Make sure that the base fork is <code>apache/flink master</code> and the head fork selects the branch with your changes. Give the pull request a meaningful description and send it.</p> + +<p>It is also possible to attach a patch to a <a href="https://issues.apache.org/jira/browse/FLINK";>JIRA</a> issue.</p> + +<hr /> + +<h2 id="coding-guidelines">Coding guidelines</h2> + +<h3 class="no_toc" id="pull-requests-and-commit-message">Pull requests and commit message</h3> + +<ul> + <li> + <p><strong>Single change per PR</strong>. Please do not combine various unrelated changes in a single pull request. Rather, open multiple individual pull requests where each PR refers to a JIRA issue. This ensures that pull requests are <em>topic related</em>, can be merged more easily, and typically result in topic-specific merge conflicts only.</p> + </li> + <li> + <p><strong>No WIP pull requests</strong>. We consider pull requests as requests to merge the referenced code <em>as is</em> into the current <em>stable</em> master branch. Therefore, a pull request should not be âwork in progressâ. Open a pull request if you are confident that it can be merged into the current master branch without problems. If you rather want comments on your code, post a link to your working branch.</p> + </li> + <li> + <p><strong>Commit message</strong>. A pull request must relate to a JIRA issue; create an issue if none exists for the change you want to make. The latest commit message should reference that issue. An example commit message would be <em>[FLINK-633] Fix NullPointerException for empty UDF parameters</em>. That way, the pull request automatically gives a description of what it does, for example what bug does it fix in what way.</p> + </li> + <li> + <p><strong>Append review commits</strong>. When you get comments on the pull request asking for changes, append commits for these changes. <em>Do not rebase and squash them.</em> It allows people to review the cleanup work independently. Otherwise reviewers have to go through the entire set of diffs again.</p> + </li> +</ul> + +<h3 class="no_toc" id="exceptions-and-error-messages">Exceptions and error messages</h3> + +<ul> + <li> + <p><strong>Exception swallowing</strong>. Do not swallow exceptions and print the stacktrace. Instead check how exceptions are handled by similar classes.</p> + </li> + <li> + <p><strong>Meaningful error messages</strong>. Give meaningful exception messages. Try to imagine why an exception could be thrown (what a user did wrong) and give a message that will help a user to resolve the problem.</p> + </li> +</ul> + +<h3 class="no_toc" id="tests">Tests</h3> + +<ul> + <li> + <p><strong>Tests need to pass</strong>. Any pull request where the tests do not pass or which does not compile will not undergo any further review. We recommend to connect your private GitHub accounts with <a href="http://travis-ci.org/";>Travis CI</a> (like the Flink GitHub repository). Travis will run tests for all tested environments whenever you push something into <em>your</em> Github repository. Please note the previous <a href="/contribute-code.html#verifying-the-compliance-of-your-code">comment about flaky tests</a>.</p> + </li> + <li> + <p><strong>Tests for new features are required</strong>. All new features need to be backed by tests, <em>strictly</em>. It is very easy that a later merge accidentally throws out a feature or breaks it. This will not be caught if the feature is not guarded by tests. Anything not covered by a test is considered cosmetic.</p> + </li> + <li> + <p><strong>Use appropriate test mechanisms</strong>. Please use unit tests to test isolated functionality, such as methods. Unit tests should execute in subseconds and should be preferred whenever possible. The name of unit test classes have to on <code>*Test</code>. Use integration tests to implement long-running tests. Flink offers test utilities for end-to-end tests that start a Flink instance and run a job. These tests are pretty heavy and can significantly increase build time. Hence, they should be added with care. The name of unit test classes have to on <code>*ITCase</code>.</p> + </li> +</ul> + +<h3 class="no_toc" id="documentation">Documentation</h3> + +<ul> + <li> + <p><strong>Documentation Updates</strong>. Many changes in the system will also affect the documentation (both JavaDocs and the user documentation in the <code>docs/</code> directory.). Pull requests and patches are required to update the documentation accordingly, otherwise the change can not be accepted to the source code. See the <a href="/contribute-documentation.html">Contribute documentation</a> guide for how to update the documentation.</p> + </li> + <li> + <p><strong>Javadocs for public methods</strong>. All public methods and classes need to have JavaDocs. Please write meaningful docs. Good docs are concise and informative. Please do also update JavaDocs if you change the signature or behavior of a documented method.</p> + </li> +</ul> + +<h3 class="no_toc" id="code-formatting">Code formatting</h3> + +<ul> + <li><strong>No reformattings</strong>. Please keep reformatting of source files to a minimum. Diffs become unreadable if you (or your IDE automatically) remove or replace whitespaces, reformat code, or comments. Also, other patches that affect the same files become un-mergeable. Please configure your IDE such that code is not automatically reformatted. Pull requests with excessive or unnecessary code reformatting might be rejected.</li> +</ul> + +<hr /> + +<h2 id="code-style">Code style</h2> + +<ul> + <li><strong>Apache license headers</strong>. Make sure you have Apache License headers in your files. The RAT plugin is checking for that when you build the code.</li> + <li><strong>Tabs vs. spaces</strong>. We are using tabs for indentation, not spaces. We are not religious there, it just happened to be that we started with tabs, and it is important to not mix them (merge/diff conflicts).</li> + <li> + <p><strong>Blocks</strong>. All statements after <code>if</code>, <code>for</code>, <code>while</code>, <code>do</code>, ⦠must always be encapsulated in a block with curly braces (even if the block contains one statement):</p> + + <div class="highlight"><pre><code class="language-java"><span class="k">for</span> <span class="o">(...)</span> <span class="o">{</span> + <span class="o">...</span> +<span class="o">}</span></code></pre></div> + <p>If you are wondering why, recall the famous <a href="https://www.imperialviolet.org/2014/02/22/applebug.html";><em>goto bug</em></a> in Appleâs SSL library.</p> + </li> + <li><strong>No wildcard imports</strong>. Do not use wildcard imports in the core files. They can cause problems when adding to the code and in some cases even during refactoring. Exceptions are the Tuple classes, Tuple-related utilities, and Flink user programs, when importing operators/functions. Tests are a special case of the user programs.</li> + <li><strong>No unused imports</strong>. Remove all unused imports.</li> + <li><strong>Use Guava Checks</strong>. To increase homogeneity, consistently use Guava methods checkNotNull and checkArgument rather than Apache Commons Validate.</li> + <li><strong>No raw generic types</strong>. Do not use raw generic types, unless strictly necessary (sometime necessary for signature matches, arrays).</li> + <li><strong>Supress warnings</strong>. Add annotations to suppress warnings, if they cannot be avoided (such as âuncheckedâ, or âserialâ).</li> + <li> + <p><strong>Comments</strong>. Add comments to your code. What is it doing? Add JavaDocs or inherit them by not adding any comments to the methods. Do not automatically generate comments and avoid unnecessary comments like:</p> + + <div class="highlight"><pre><code class="language-java"><span class="n">i</span><span class="o">++;</span> <span class="c1">// increment by one</span></code></pre></div> + </li> +</ul> + +<hr /> + +<h2 id="best-practices">Best practices</h2> + +<ul> + <li>Travis: Flink is pre-configured for <a href="http://docs.travis-ci.com/";>Travis CI</a>, which can be easily enabled for your private repository fork (it uses GitHub for authentication, so you so not need an additional account). Simply add the <em>Travis CI</em> hook to your repository (<em>settings â> webhooks & services â> add service</em>) and enable tests for the <code>flink</code> repository on <a href="https://travis-ci.org/profile";>Travis</a>.</li> +</ul> + +<hr /> + +<h2 id="setup-a-development-environment">Setup a development environment</h2> + +<h3 id="requirements-for-developing-and-building-flink">Requirements for developing and building Flink</h3> + +<ul> + <li>Unix-like environment (We use Linux, Mac OS X, Cygwin)</li> + <li>git</li> + <li>Maven (at least version 3.0.4)</li> + <li>Java 7 or 8</li> +</ul> + +<h3 class="no_toc" id="clone-the-repository">Clone the repository</h3> + +<p>Apache Flinkâs source code is stored in a <a href="http://git-scm.com/";>git</a> repository which is mirrored to <a href="https://github.com/apache/flink";>Github</a>. The common way to exchange code on Github is to fork a the repository into your personal Github account. For that, you need to have a <a href="https://github.com";>Github</a> account or create one for free. Forking a repository means that Github creates a copy of the forked repository for you. This is done by clicking on the <em>fork</em> button on the upper right of the <a href="https://github.com/apache/flink";>repository website</a>. Once you have a fork of Flinkâs repository in your personal account, you can clone that repository to your local machine.</p> + +<div class="highlight"><pre><code>git clone https://github.com/<your-user-name>/flink.git +</code></pre></div> + +<p>The code is downloaded into a directory called <code>flink</code>.</p> + +<h3 class="no_toc" id="setup-an-ide-and-import-the-source-code">Setup an IDE and import the source code</h3> + +<p>The Flink committers use IntelliJ IDEA and Eclipse IDE to develop the Flink code base.</p> + +<p>Minimal requirements for an IDE are:</p> + +<ul> + <li>Support for Java and Scala (also mixed projects)</li> + <li>Support for Maven with Java and Scala</li> +</ul> + +<h4 id="intellij-idea">IntelliJ IDEA</h4> + +<p>The IntelliJ IDE supports Maven out of the box and offers a plugin for Scala development.</p> + +<ul> + <li>IntelliJ download: <a href="https://www.jetbrains.com/idea/";>https://www.jetbrains.com/idea/</a></li> + <li>IntelliJ Scala Plugin: <a href="http://plugins.jetbrains.com/plugin/?id=1347";>http://plugins.jetbrains.com/plugin/?id=1347</a></li> +</ul> + +<p>Check out our <a href="https://github.com/apache/flink/blob/master/docs/internals/ide_setup.md#intellij-idea";>Setting up IntelliJ</a> guide for details.</p> + +<h4 id="eclipse-scala-ide">Eclipse Scala IDE</h4> + +<p>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 version that works most robustly for a complex project like Flink.</p> + +<p>Further details, and a guide to newer Scala IDE versions can be found in the +<a href="https://github.com/apache/flink/blob/master/docs/internals/ide_setup.md#eclipse";>How to setup Eclipse</a> docs.</p> + +<p><strong>Note:</strong> Before following this setup, make sure to run the build from the command line once +(<code>mvn clean install -DskipTests</code>, see above)</p> + +<ol> + <li>Download the Scala IDE (preferred) or install the plugin to Eclipse Kepler. See +<a href="https://github.com/apache/flink/blob/master/docs/internals/ide_setup.md#eclipse";>How to setup Eclipse</a> for download links and instructions.</li> + <li>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 <em>macroparadise</em> jar file (typically â/home/<em>-your-user-</em>/.m2/repository/org/scalamacros/paradise_2.10.4/2.0.1/paradise_2.10.4-2.0.1.jarâ). +Note: If you do not have the jar file, you probably did not run the command line build.</li> + <li>Import the Flink Maven projects (âFileâ -> âImportâ -> âMavenâ -> âExisting Maven Projectsâ) </li> + <li>During the import, Eclipse will ask to automatically install additional Maven build helper plugins.</li> + <li>Close the âflink-java8â project. Since Eclipse Kepler does not support Java 8, you cannot develop this project.</li> +</ol> + +<h4 id="import-the-source-code">Import the source code</h4> + +<p>Apache Flink uses Apache Maven as build tool. Most IDE are capable of importing Maven projects.</p> + +<h3 class="no_toc" id="build-the-code">Build the code</h3> + +<p>To build Flink from source code, open a terminal, navigate to the root directory of the Flink source code, and call</p> + +<div class="highlight"><pre><code>mvn clean package +</code></pre></div> + +<p>This will build Flink and run all tests. Flink is now installed in <code>build-target</code>.</p> + +<p>To build Flink without executing the tests you can call </p> + +<div class="highlight"><pre><code>mvn -DskipTests clean package +</code></pre></div> + +<hr /> + +<h2 id="how-to-use-git-as-a-committer">How to use Git as a committer</h2> + +<p>Only the infrastructure team of the ASF has administrative access to the GitHub mirror. Therefore, comitters have to push changes to the git repository at the ASF.</p> + +<h3 class="no_toc" id="main-source-repositories">Main source repositories</h3> + +<p><strong>ASF writable</strong>: https://git-wip-us.apache.org/repos/asf/flink.git</p> + +<p><strong>ASF read-only</strong>: git://git.apache.org/repos/asf/flink.git</p> + +<p><strong>ASF read-only</strong>: https://github.com/apache/flink.git</p> + +<p>Note: Flink does not build with Oracle JDK 6. It runs with Oracle JDK 6.</p> + +<p>If you want to build for Hadoop 1, activate the build profile via <code>mvn clean package -DskipTests -Dhadoop.profile=1</code>.</p> + +<hr /> + +<h2 id="snapshots-nightly-builds">Snapshots (Nightly Builds)</h2> + +<p>Apache Flink <code>0.10-SNAPSHOT</code> is our latest development version.</p> + +<p>You can download a packaged version of our nightly builds, which include +the most recent development code. You can use them if you need a feature +before its release. Only builds that pass all tests are published here.</p> + +<ul> + <li><strong>Hadoop 1</strong>: <a href="http://stratosphere-bin.s3-website-us-east-1.amazonaws.com/flink-0.10-SNAPSHOT-bin-hadoop1.tgz"; class="ga-track" id="download-hadoop1-nightly">flink-0.10-SNAPSHOT-bin-hadoop1.tgz</a></li> + <li><strong>Hadoop 2 and YARN</strong>: <a href="http://stratosphere-bin.s3-website-us-east-1.amazonaws.com/flink-0.10-SNAPSHOT-bin-hadoop2.tgz"; class="ga-track" id="download-hadoop2-nightly">flink-0.10-SNAPSHOT-bin-hadoop2.tgz</a></li> +</ul> + +<p>Add the <strong>Apache Snapshot repository</strong> to your Maven <code>pom.xml</code>:</p> + +<div class="highlight"><pre><code class="language-xml"><span class="nt"><repositories></span> + <span class="nt"><repository></span> + <span class="nt"><id></span>apache.snapshots<span class="nt"></id></span> + <span class="nt"><name></span>Apache Development Snapshot Repository<span class="nt"></name></span> + <span class="nt"><url></span>https://repository.apache.org/content/repositories/snapshots/<span class="nt"></url></span> + <span class="nt"><releases><enabled></span>false<span class="nt"></enabled></releases></span> + <span class="nt"><snapshots><enabled></span>true<span class="nt"></enabled></snapshots></span> + <span class="nt"></repository></span> +<span class="nt"></repositories></span></code></pre></div> + +<p>You can now include Apache Flink as a Maven dependency (see above) with version <code>0.10-SNAPSHOT</code> (or <code>0.10-SNAPSHOT-hadoop1</code> for compatibility with old Hadoop 1.x versions).</p> + + + </div> +</div> + + + <hr /> + <div class="footer text-center"> + <p>Copyright © 2014-2015 <a href="http://apache.org";>The Apache Software Foundation</a>. All Rights Reserved.</p> + <p>Apache Flink, Apache, and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + <p><a href="/privacy-policy.html">Privacy Policy</a> · <a href="/blog/feed.xml">RSS feed</a></p> + </div> + + </div><!-- /.container --> + + <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> + <!-- Include all compiled plugins (below), or include individual files as needed --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js";></script> + <script src="/js/codetabs.js"></script> + + <!-- Google Analytics --> + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-52545728-1', 'auto'); + ga('send', 'pageview'); + </script> + </body> +</html> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/contribute-documentation.html ---------------------------------------------------------------------- diff --git a/content/contribute-documentation.html b/content/contribute-documentation.html new file mode 100644 index 0000000..83b1906 --- /dev/null +++ b/content/contribute-documentation.html @@ -0,0 +1,247 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + <title>Apache Flink: Contribute Documentation</title> + <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> + <link rel="icon" href="/favicon.ico" type="image/x-icon"> + + <!-- Bootstrap --> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css";> + <link rel="stylesheet" href="/css/flink.css"> + <link rel="stylesheet" href="/css/syntax.css"> + + <!-- Blog RSS feed --> + <link href="/blog/feed.xml" rel="alternate" type="application/rss+xml" title="Apache Flink Blog: RSS feed" /> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!-- WARNING: Respond.js doesn't work if you view the page via file:// --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> + </head> + <body> + + + <!-- Top navbar. --> + <nav class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <!-- The logo. --> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <div class="navbar-logo"> + <a href="/"><img alt="Apache Flink" src="/img/navbar-brand-logo.jpg" width="78px" height="40px"></a> + </div> + </div><!-- /.navbar-header --> + + <!-- The navigation links. --> + <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> + <ul class="nav navbar-nav"> + <!-- Overview --> + <li><a href="/index.html">Overview</a></li> + + <!-- Quickstart --> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Quickstart <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu"> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/setup_quickstart.html";>Setup</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/java_api_quickstart.html";>Java API</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/scala_api_quickstart.html";>Scala API</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/quickstart/run_example_quickstart.html";>Run Step-by-Step Example</a></li> + </ul> + </li> + + <!-- Features --> + <li><a href="/features.html">Features</a></li> + + <!-- Downloads --> + <li><a href="/downloads.html">Downloads</a></li> + + <!-- Documentation --> + <li class="dropdown"> + <a href="" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu"> + <!-- Latest stable release --> + <li role="presentation" class="dropdown-header"><strong>Latest Release</strong> (Stable)</li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9";>0.9.1 Documentation</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/api/java"; class="active">0.9.1 Javadocs</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-release-0.9/api/scala/index.html"; class="active">0.9.1 ScalaDocs</a></li> + + <!-- Snapshot docs --> + <li class="divider"></li> + <li role="presentation" class="dropdown-header"><strong>Snapshot</strong> (Development)</li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-master";>0.10 Documentation</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-master/api/java"; class="active">0.10 Javadocs</a></li> + <li><a href="http://ci.apache.org/projects/flink/flink-docs-master/api/scala/index.html"; class="active">0.10 ScalaDocs</a></li> + + <!-- Wiki --> + <li class="divider"></li> + <li><a href="https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home";><small><span class="glyphicon glyphicon-new-window"></span></small> Wiki</a></li> + </ul> + </li> + + <!-- FAQ --> + <li><a href="/faq.html">FAQ</a></li> + </ul> + + <ul class="nav navbar-nav navbar-right"> + <!-- Blog --> + <li class=" hidden-md hidden-sm"><a href="/blog/">Blog</a></li> + + <li class="dropdown hidden-md hidden-sm"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Community <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu"> + <!-- Community --> + <li role="presentation" class="dropdown-header"><strong>Community</strong></li> + <li><a href="/community.html#mailing-lists">Mailing Lists</a></li> + <li><a href="/community.html#irc">IRC</a></li> + <li><a href="/community.html#stack-overflow">Stack Overflow</a></li> + <li><a href="/community.html#issue-tracker">Issue Tracker</a></li> + <li><a href="/community.html#source-code">Source Code</a></li> + <li><a href="/community.html#people">People</a></li> + + <!-- Contribute --> + <li class="divider"></li> + <li role="presentation" class="dropdown-header"><strong>Contribute</strong></li> + <li><a href="/how-to-contribute.html">How to Contribute</a></li> + <li><a href="/contribute-code.html">Contribute Code</a></li> + <li><a href="/contribute-documentation.html">Contribute Documentation</a></li> + <li><a href="/improve-website.html">Improve the Website</a></li> + </ul> + </li> + + <li class="dropdown hidden-md hidden-sm"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Project <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu"> + <!-- Project --> + <li role="presentation" class="dropdown-header"><strong>Project</strong></li> + <li><a href="/material.html">Material</a></li> + <li><a href="https://twitter.com/apacheflink";><small><span class="glyphicon glyphicon-new-window"></span></small> Twitter</a></li> + <li><a href="https://github.com/apache/flink";><small><span class="glyphicon glyphicon-new-window"></span></small> GitHub</a></li> + <li><a href="https://cwiki.apache.org/confluence/display/FLINK/Apache+Flink+Home";><small><span class="glyphicon glyphicon-new-window"></span></small> Wiki</a></li> + </ul> + </li> + </ul> + </div><!-- /.navbar-collapse --> + </div><!-- /.container --> + </nav> + + + <!-- Main content. --> + <div class="container"> + + +<div class="row"> + <div class="col-sm-8 col-sm-offset-2"> + <div class="row"> + <div class="col-sm-12"><h1>Contribute Documentation</h1></div> + </div> + +<p>Good documentation is crucial for any kind of software. This is especially true for sophisticated software systems such as distributed data processing engines like Apache Flink. The Apache Flink community aims to provide concise, precise, and complete documentation and welcomes any contribution to improve Apache Flinkâs documentation.</p> + +<div class="page-toc"> +<ul id="markdown-toc"> + <li><a href="#obtain-the-documentation-sources">Obtain the documentation sources</a></li> + <li><a href="#before-you-start-working-on-the-documentation-">Before you start working on the documentation â¦</a></li> + <li><a href="#update-or-extend-the-documentation">Update or extend the documentation</a></li> + <li><a href="#submit-your-contribution">Submit your contribution</a></li> +</ul> + +</div> + +<h2 id="obtain-the-documentation-sources">Obtain the documentation sources</h2> + +<p>Apache Flinkâs documentation is maintained in the same <a href="http://git-scm.com/";>git</a> repository as the code base. This is done to ensure that code and documentation can be easily kept in sync. </p> + +<p>The easiest way to contribute documentation is to fork <a href="https://github.com/apache/flink";>Flinkâs mirrored repository on Github</a> into your own Github account by clicking on the fork button at the top right. If you have no Github account, you can create one for free.</p> + +<p>Next, clone your fork to your local machine.</p> + +<div class="highlight"><pre><code>git clone https://github.com/<your-user-name>/flink.git +</code></pre></div> + +<p>The documentation is located in the <code>docs/</code> subdirectory of the Flink code base.</p> + +<h2 id="before-you-start-working-on-the-documentation-">Before you start working on the documentation â¦</h2> + +<p>⦠please make sure there exists a <a href="https://issues.apache.org/jira/browse/FLINK";>JIRA</a> issue that corresponds to your contribution. We require all documentation changes to refer to a JIRA issue, except for trivial fixes such as typos. </p> + +<h2 id="update-or-extend-the-documentation">Update or extend the documentation</h2> + +<p>The Flink documentation is written in <a href="http://daringfireball.net/projects/markdown/";>Markdown</a>. Markdown is a lightweight markup language which can be translated to HTML.</p> + +<p>In order to update or extend the documentation you have to modify the Markdown (<code>.md</code>) files. Please verify your changes by starting the build script in preview mode.</p> + +<div class="highlight"><pre><code>cd docs +./build_docs.sh -p +</code></pre></div> + +<p>The script compiles the Markdown files into static HTML pages and starts a local webserver. Open your browser at <code>http://localhost:4000</code> to view the compiled documentation including your changes. The served documentation is automatically re-compiled and updated when you modify and save Markdown files and refresh your browser.</p> + +<p>Please feel free to ask any questions you have on the developer mailing list.</p> + +<h2 id="submit-your-contribution">Submit your contribution</h2> + +<p>The Flink project accepts documentation contributions through the <a href="https://github.com/apache/flink";>GitHub Mirror</a> as <a href="https://help.github.com/articles/using-pull-requests";>Pull Requests</a>. Pull requests are a simple way of offering a patch by providing a pointer to a code branch that contains the changes.</p> + +<p>To prepare and submit a pull request follow these steps.</p> + +<ol> + <li> + <p>Commit your changes to your local git repository. The commit message should point to the corresponding JIRA issue by starting with <code>[FLINK-XXXX]</code>. </p> + </li> + <li> + <p>Push your committed contribution to your fork of the Flink repository at Github.</p> + + <p><code> + git push origin myBranch +</code></p> + </li> + <li> + <p>Go the website of your repository fork (<code>https://github.com/<your-user-name>/flink</code>) and use the âCreate Pull Requestâ button to start creating a pull request. Make sure that the base fork is <code>apache/flink master</code> and the head fork selects the branch with your changes. Give the pull request a meaningful description and submit it.</p> + </li> +</ol> + +<p>It is also possible to attach a patch to a <a href="https://issues.apache.org/jira/browse/FLINK";>JIRA</a> issue.</p> + + + + </div> +</div> + + + <hr /> + <div class="footer text-center"> + <p>Copyright © 2014-2015 <a href="http://apache.org";>The Apache Software Foundation</a>. All Rights Reserved.</p> + <p>Apache Flink, Apache, and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + <p><a href="/privacy-policy.html">Privacy Policy</a> · <a href="/blog/feed.xml">RSS feed</a></p> + </div> + + </div><!-- /.container --> + + <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> + <!-- Include all compiled plugins (below), or include individual files as needed --> + <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js";></script> + <script src="/js/codetabs.js"></script> + + <!-- Google Analytics --> + <script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-52545728-1', 'auto'); + ga('send', 'pageview'); + </script> + </body> +</html> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/css/flink.css ---------------------------------------------------------------------- diff --git a/content/css/flink.css b/content/css/flink.css index 7e04d60..5b68542 100644 --- a/content/css/flink.css +++ b/content/css/flink.css @@ -51,6 +51,10 @@ h3, h4, h5, h6 { font-size: 120%; } +blockquote { + font-size: 100%; +} + /*============================================================================= Table of Contents =============================================================================*/ http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/downloads.html ---------------------------------------------------------------------- diff --git a/content/downloads.html b/content/downloads.html index 21d9c6d..c27193e 100644 --- a/content/downloads.html +++ b/content/downloads.html @@ -112,7 +112,9 @@ <li class="divider"></li> <li role="presentation" class="dropdown-header"><strong>Contribute</strong></li> <li><a href="/how-to-contribute.html">How to Contribute</a></li> - <li><a href="/coding-guidelines.html">Coding Guidelines</a></li> + <li><a href="/contribute-code.html">Contribute Code</a></li> + <li><a href="/contribute-documentation.html">Contribute Documentation</a></li> + <li><a href="/improve-website.html">Improve the Website</a></li> </ul> </li> @@ -156,9 +158,9 @@ $( document ).ready(function() { <div class="page-toc"> <ul id="markdown-toc"> - <li><a href="#latest-stable-release-v091" id="markdown-toc-latest-stable-release-v091">Latest stable release (v0.9.1)</a></li> - <li><a href="#maven-dependencies" id="markdown-toc-maven-dependencies">Maven Dependencies</a></li> - <li><a href="#all-releases" id="markdown-toc-all-releases">All releases</a></li> + <li><a href="#latest-stable-release-v091">Latest stable release (v0.9.1)</a></li> + <li><a href="#maven-dependencies">Maven Dependencies</a></li> + <li><a href="#all-releases">All releases</a></li> </ul> </div>
