You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by fh...@apache.org on 2018/05/28 16:56:41 UTC
[3/3] flink-web git commit: Rebuild website
Rebuild 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/0b278cc2
Tree: http://git-wip-us.apache.org/repos/asf/flink-web/tree/0b278cc2
Diff: http://git-wip-us.apache.org/repos/asf/flink-web/diff/0b278cc2
Branch: refs/heads/asf-site
Commit: 0b278cc297ff9353eb394f777a0a7b64d25c648d
Parents: 1b88c80
Author: Fabian Hueske <fh...@apache.org>
Authored: Mon May 28 18:55:04 2018 +0200
Committer: Fabian Hueske <fh...@apache.org>
Committed: Mon May 28 18:57:04 2018 +0200
----------------------------------------------------------------------
content/community.html | 16 ++---
content/contribute-code.html | 97 +++++++++++++++---------------
content/contribute-documentation.html | 13 ++--
content/downloads.html | 12 ++--
content/ecosystem.html | 24 ++++----
content/faq.html | 42 +++++++------
content/how-to-contribute.html | 24 ++++----
content/improve-website.html | 6 +-
content/introduction.html | 2 +-
content/poweredby.html | 8 +--
content/usecases.html | 2 +-
11 files changed, 128 insertions(+), 118 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/community.html
----------------------------------------------------------------------
diff --git a/content/community.html b/content/community.html
index dd59481..4a594a3 100644
--- a/content/community.html
+++ b/content/community.html
@@ -178,7 +178,7 @@
</div>
-<p>There are many ways to get help from the Apache Flink community. The <a href="#mailing-lists">mailing lists</a> are the primary place where all Flink committers are present. If you want to talk with the Flink committers and users in a chat, there is a <a href="#irc">IRC channel</a>. Some committers are also monitoring <a href="http://stackoverflow.com/questions/tagged/flink">Stack Overflow</a>. Please remember to tag your questions with the <em><a href="http://stackoverflow.com/questions/tagged/flink">flink</a></em> tag. Bugs and feature requests can either be discussed on <em>dev mailing list</em> or on <a href="https://issues.apache.org/jira/browse/FLINK">JIRA</a>. Those interested in contributing to Flink should check out the <a href="how-to-contribute.html">contribution guide</a>.</p>
+<p>There are many ways to get help from the Apache Flink community. The <a href="#mailing-lists">mailing lists</a> are the primary place where all Flink committers are present. If you want to talk with the Flink committers and users in a chat, there is an <a href="#irc">IRC channel</a>. Some committers are also monitoring <a href="http://stackoverflow.com/questions/tagged/apache-flink">Stack Overflow</a>. Please remember to tag your questions with the <em><a href="http://stackoverflow.com/questions/tagged/apache-flink">apache-flink</a></em> tag. Bugs and feature requests can either be discussed on the <em>dev mailing list</em> or on <a href="https://issues.apache.org/jira/browse/FLINK">Jira</a>. Those interested in contributing to Flink should check out the <a href="how-to-contribute.html">contribution guide</a>.</p>
<h2 id="mailing-lists">Mailing Lists</h2>
@@ -194,7 +194,7 @@
<tr>
<td>
<strong>news</strong>@flink.apache.org<br />
- <small>News and announcements from the Flink community.</small>
+ <small>News and announcements from the Flink community</small>
</td>
<td class="text-center"><i class="fa fa-pencil-square-o"></i> <a href="mailto:news-subscribe@flink.apache.org">Subscribe</a></td>
<td class="text-center"><i class="fa fa-pencil-square-o"></i> <a href="mailto:news-digest-subscribe@flink.apache.org">Subscribe</a></td>
@@ -207,7 +207,7 @@
<tr>
<td>
<strong>community</strong>@flink.apache.org<br />
- <small>Broader community discussions related to meetups, conferences, blog posts and job offers.</small>
+ <small>Broader community discussions related to meetups, conferences, blog posts and job offers</small>
</td>
<td class="text-center"><i class="fa fa-pencil-square-o"></i> <a href="mailto:community-subscribe@flink.apache.org">Subscribe</a></td>
<td class="text-center"><i class="fa fa-pencil-square-o"></i> <a href="mailto:community-digest-subscribe@flink.apache.org">Subscribe</a></td>
@@ -249,7 +249,7 @@
<td>
<strong>issues</strong>@flink.apache.org
<br />
- <small>Mirror of all JIRA activity</small>
+ <small>Mirror of all Jira activity</small>
</td>
<td class="text-center"><i class="fa fa-pencil-square-o"></i> <a href="mailto:issues-subscribe@flink.apache.org">Subscribe</a></td>
<td class="text-center"><i class="fa fa-pencil-square-o"></i> <a href="mailto:issues-digest-subscribe@flink.apache.org">Subscribe</a></td>
@@ -271,7 +271,7 @@
</tr>
</table>
-<p><b style="color:red">Please make sure you are subscribed to the mailing list you are posting to!</b> If you are not subscribed to the mailing list, your message will either be rejected (dev@ list) or you won’t receive the response (user@) list.</p>
+<p><b style="color:red">Please make sure you are subscribed to the mailing list you are posting to!</b> If you are not subscribed to the mailing list, your message will either be rejected (dev@ list) or you won’t receive the response (user@ list).</p>
<h2 id="irc">IRC</h2>
@@ -281,13 +281,13 @@
<h2 id="stack-overflow">Stack Overflow</h2>
-<p>Committers are watching <a href="http://stackoverflow.com/questions/tagged/flink">Stack Overflow</a> for the <a href="http://stackoverflow.com/questions/tagged/flink">flink</a> tag.</p>
+<p>Committers are watching <a href="http://stackoverflow.com/questions/tagged/apache-flink">Stack Overflow</a> for the <a href="http://stackoverflow.com/questions/tagged/apache-flink">apache-flink</a> tag.</p>
<p>Make sure to tag your questions there accordingly to get answers from the Flink community.</p>
<h2 id="issue-tracker">Issue Tracker</h2>
-<p>We use JIRA to track all code related issues: <a href="https://issues.apache.org/jira/browse/FLINK">https://issues.apache.org/jira/browse/FLINK</a>.</p>
+<p>We use Jira to track all code related issues: <a href="https://issues.apache.org/jira/browse/FLINK">https://issues.apache.org/jira/browse/FLINK</a>.</p>
<p>All issue activity is also mirrored to the issues mailing list.</p>
@@ -337,7 +337,7 @@
<p>The second edition of Flink Forward took place on September 12-14, 2016. All <a href="http://2016.flink-forward.org/program/sessions/">slides and videos</a> are available on the Flink Forward 2016 page.</p>
-<p>In 2017, Flink Forward came to San Francisco to welcome the Apache Flink community to one day of training and one day of conference. Find all videos on our <a href="https://www.youtube.com/playlist?list=PLDX4T_cnKjD2UC6wJr_wRbIvtlMtkc-n2">YouTube Channel</a> and all slides on <a href="https://www.slideshare.net/FlinkForward">Slideshare</a>.</p>
+<p>In 2017, Flink Forward came to San Francisco to welcome the Apache Flink community to one day of training and one day of conference. Find all videos on our <a href="https://www.youtube.com/playlist?list=PLDX4T_cnKjD2UC6wJr_wRbIvtlMtkc-n2">YouTube Channel</a> and all slides on <a href="https://www.slideshare.net/FlinkForward">SlideShare</a>.</p>
<h1 id="people">People</h1>
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/contribute-code.html
----------------------------------------------------------------------
diff --git a/content/contribute-code.html b/content/contribute-code.html
index a2d8806..b098395 100644
--- a/content/contribute-code.html
+++ b/content/contribute-code.html
@@ -139,9 +139,9 @@
<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>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. In particular, before opening a pull request that implements a <strong>new feature</strong>, you need to open a JIRA ticket and reach consensus with the community on whether this feature is needed.</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. In particular, before opening a pull request that implements a <strong>new feature</strong>, you need to open a Jira ticket and reach consensus with the community on whether this feature is needed.</p>
<div class="page-toc">
<ul id="markdown-toc">
@@ -181,33 +181,33 @@
<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>…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>
+<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 linked 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>
+ <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>
+<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>
+<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>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><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>
@@ -218,35 +218,35 @@
<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>Checking 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>
+<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 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>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>To make the changes easily mergeable, please rebase them to the latest version of the main repository’s master branch. Please 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>
+<p>To open a pull request, push your 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>Go to 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>
+<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 />
@@ -256,13 +256,13 @@
<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>
+ <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>
+ <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>
@@ -287,13 +287,13 @@
<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>
+ <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 personal 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>
+ <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 names of unit test classes have to end in <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 names of end-to-end test classes have to end in <code>*ITCase</code>.</p>
</li>
</ul>
@@ -301,10 +301,10 @@
<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>
+ <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>
+ <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>
@@ -346,32 +346,35 @@
<ul>
<li><strong>Package names must start with a letter, and must not contain upper-case letters or special characters.</strong></li>
<li><strong>Non-private static final fields must be upper-case, with words being separated by underscores.</strong> (<code>MY_STATIC_VARIABLE</code>)</li>
- <li><strong>Non-static fields/methods must be in lower camcel case.</strong> (<code>myNonStaticField</code>)</li>
+ <li><strong>Non-static fields/methods must be in lower camel case.</strong> (<code>myNonStaticField</code>)</li>
</ul>
<h3 id="whitespace">Whitespace</h3>
<ul>
- <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><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><strong>No trailing whitespace.</strong></li>
- <li><strong>Spaces around operators/keywords.</strong> Operators (+, =, >, …) and keywords (if, for, catch, …) must have a space before and after them, provided they are not at the start or end of the line.</li>
+ <li><strong>Spaces around operators/keywords.</strong> Operators (<code>+</code>, <code>=</code>, <code>></code>, …) and keywords (<code>if</code>, <code>for</code>, <code>catch</code>, …) must have a space before and after them, provided they are not at the start or end of the line.</li>
</ul>
<h3 id="braces">Braces</h3>
<ul>
<li><strong>Left curly braces (<code>{</code>) must not be placed on a new line.</strong></li>
<li><strong>Right curly braces (<code>}</code>) must always be placed at the beginning of the line.</strong></li>
- <li><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):
-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.</li>
-</ul>
+ <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>
+ <div class="highlight"><pre><code class="language-java"><span class="k">for</span> <span class="o">(</span><span class="err">…</span><span class="o">)</span> <span class="o">{</span>
+ <span class="err">…</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>
+</ul>
+
<h3 id="javadocs">Javadocs</h3>
<ul>
<li><strong>All public/protected methods and classes must have a Javadoc.</strong></li>
- <li><strong>The first sentence of the javadoc must end with a period.</strong></li>
+ <li><strong>The first sentence of the Javadoc must end with a period.</strong></li>
<li><strong>Paragraphs must be separated with a new line, and started with <p>.</strong></li>
</ul>
@@ -389,12 +392,12 @@ If you are wondering why, recall the famous <a href="https://www.imperialviolet.
<h3 id="misc">Misc</h3>
<ul>
- <li><strong>Arrays must be defined Java-style.</strong> I.e <code>public String[] array</code>.</li>
- <li><strong>Use Flink Preconditions.</strong> To increase homogeneity, consistently use org.apache.flink.Preconditons methods checkNotNull and checkArgument rather than Apache Commons Validate or Google Guava.</li>
+ <li><strong>Arrays must be defined Java-style.</strong> For example, <code>public String[] array</code>.</li>
+ <li><strong>Use Flink Preconditions.</strong> To increase homogeneity, consistently use the <code>org.apache.flink.Preconditions</code> methods <code>checkNotNull</code> and <code>checkArgument</code> rather than Apache Commons Validate or Google Guava.</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><strong>Suppress 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>
+ <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>
@@ -405,7 +408,7 @@ If you are wondering why, recall the famous <a href="https://www.imperialviolet.
<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>
+ <li>Travis: Flink is pre-configured for <a href="http://docs.travis-ci.com/">Travis CI</a>, which can be easily enabled for your personal repository fork (it uses GitHub for authentication, so you do not need an additional account). Simply add the <em>Travis CI</em> hook to your repository (<em>Settings –> Integrations & 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 />
@@ -415,7 +418,7 @@ If you are wondering why, recall the famous <a href="https://www.imperialviolet.
<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>Unix-like environment (We use Linux, Mac OS X, and Cygwin)</li>
<li>git</li>
<li>Maven (at least version 3.0.4)</li>
<li>Java 7 or 8</li>
@@ -423,7 +426,7 @@ If you are wondering why, recall the famous <a href="https://www.imperialviolet.
<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>
+<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 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>
@@ -463,11 +466,11 @@ If you are wondering why, recall the famous <a href="https://www.imperialviolet.
<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
+<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>
+(<code>mvn clean install -DskipTests</code>; see below).</p>
<ol>
<li>Download the Scala IDE (preferred) or install the plugin to Eclipse Kepler. See
@@ -483,18 +486,18 @@ Note: If you do not have the jar file, you probably did not run the command line
<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>
+<p>Apache Flink uses Apache Maven as build tool. Most IDEs 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>
+<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>
+<p>To build Flink without executing the tests you can call:</p>
<div class="highlight"><pre><code>mvn -DskipTests clean package
</code></pre></div>
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/contribute-documentation.html
----------------------------------------------------------------------
diff --git a/content/contribute-documentation.html b/content/contribute-documentation.html
index 8c92e6a..4b0f69c 100644
--- a/content/contribute-documentation.html
+++ b/content/contribute-documentation.html
@@ -153,7 +153,7 @@
<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>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>
@@ -164,7 +164,7 @@
<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>
+<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>
@@ -188,22 +188,21 @@
<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>
+ <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>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>
+ <p>Go to 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>
-
+<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>
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/downloads.html
----------------------------------------------------------------------
diff --git a/content/downloads.html b/content/downloads.html
index 8866bac..9b95df3 100644
--- a/content/downloads.html
+++ b/content/downloads.html
@@ -174,9 +174,9 @@ $( document ).ready(function() {
to use Flink. If you plan to run Flink in YARN or process data stored in HDFS then
select the version matching your installed Hadoop version.</p>
-<p>The binary releases marked with a Hadoop version come bundled with binaries for that Hadoop version,
-the binary release without bundled Hadoop can be used without Hadoop or with a Hadoop version
-that is installed in the environment, i.e. this version can pick up a Hadoop version from
+<p>The binary releases marked with a Hadoop version come bundled with binaries for that Hadoop version.
+The binary release without bundled Hadoop can be used without Hadoop or with a Hadoop version
+that is installed in the environment, i.e., this version can pick up a Hadoop version from
the classpath.</p>
<h3 id="binaries">Binaries</h3>
@@ -234,7 +234,7 @@ the classpath.</p>
<h2 id="verifying-hashes-and-signatures">Verifying Hashes and Signatures</h2>
-<p>Along our releases, we also provide sha512 hashes in <code>*.sha512</code> files and cryptographic signatures in <code>*.asc</code> files. The Apache Software Foundation has an extensive <a href="http://www.apache.org/info/verification.html">tutorial to verify hashes and signatures</a> which you can follow by using any of these release-signing <a href="https://www.apache.org/dist/flink/KEYS">KEYS</a>.</p>
+<p>Along with our releases, we also provide sha512 hashes in <code>*.sha512</code> files and cryptographic signatures in <code>*.asc</code> files. The Apache Software Foundation has an extensive <a href="http://www.apache.org/info/verification.html">tutorial to verify hashes and signatures</a> which you can follow by using any of these release-signing <a href="https://www.apache.org/dist/flink/KEYS">KEYS</a>.</p>
<h2 id="maven-dependencies">Maven Dependencies</h2>
@@ -264,7 +264,7 @@ the classpath.</p>
<p>As of March 2017, the Flink community <a href="http://apache-flink-mailing-list-archive.1008284.n3.nabble.com/DISCUSS-Time-based-releases-in-Flink-tp15386p15394.html">decided</a> to support the current and previous minor release with bugfixes. If 1.2.x is the current release, 1.1.y is the previous minor supported release. Both versions will receive bugfixes for critical issues.</p>
-<p>Note that the community is always open for discussing bugfix releases for even older versions. Please get in touch with the developers for that on the dev@flink.apache.org mailing list.</p>
+<p>Note that the community is always open to discussing bugfix releases for even older versions. Please get in touch with the developers for that on the dev@flink.apache.org mailing list.</p>
<h2 id="all-releases">All releases</h2>
@@ -303,7 +303,7 @@ the classpath.</p>
<li>Flink 0.6-incubating - 2014-08-26 (<a href="https://archive.apache.org/dist/incubator/flink/flink-0.6-incubating-src.tgz">Source</a>, <a href="https://archive.apache.org/dist/incubator/flink/">Binaries</a>)</li>
</ul>
-<p>Previous Stratosphere releases are available on <a href="https://github.com/stratosphere/stratosphere/releases">Github</a>.</p>
+<p>Previous Stratosphere releases are available on <a href="https://github.com/stratosphere/stratosphere/releases">GitHub</a>.</p>
</div>
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/ecosystem.html
----------------------------------------------------------------------
diff --git a/content/ecosystem.html b/content/ecosystem.html
index 5261d26..9b5ea57 100644
--- a/content/ecosystem.html
+++ b/content/ecosystem.html
@@ -168,13 +168,13 @@ many other data processing projects and frameworks.
</ul>
<p>To run an application using one of these connectors, additional third party
-components are usually required to be installed and launched, e.g. the servers
+components are usually required to be installed and launched, e.g., the servers
for the message queues. Further instructions for these can be found in the
corresponding subsections.</p>
<h2 id="third-party-projects">Third-Party Projects</h2>
-<p>This is a list of third party packages (ie, libraries, system extensions, or examples) built on Flink.
+<p>This is a list of third party packages (i.e., libraries, system extensions, or examples) built on Flink.
The Flink community collects links to these packages but does not maintain them.
Thus, they do not belong to the Apache Flink project, and the community cannot give any support for them.
<strong>Is your project missing?</strong>
@@ -183,27 +183,27 @@ Please let us know on the <a href="#mailing-lists">user/dev mailing list</a>.</p
<p><strong>Apache Zeppelin</strong></p>
<p><a href="https://zeppelin.incubator.apache.org/">Apache Zeppelin</a> is a web-based notebook that enables interactive data analytics and can be used with
-<a href="https://zeppelin.incubator.apache.org/docs/interpreter/flink.html">Flink as an execution engine</a> (next to others engines).
+<a href="https://zeppelin.incubator.apache.org/docs/interpreter/flink.html">Flink as an execution engine</a> (next to other engines).
See also Jim Dowling’s <a href="http://www.slideshare.net/FlinkForward/jim-dowling-interactive-flink-analytics-with-hopsworks-and-zeppelin">Flink Forward talk</a> about Zeppelin on Flink.</p>
<p><strong>Apache Mahout</strong></p>
-<p><a href="https://mahout.apache.org/">Apache Mahout</a> in a machine learning library that will feature Flink as an execution engine soon.
+<p><a href="https://mahout.apache.org/">Apache Mahout</a> is a machine learning library that will feature Flink as an execution engine soon.
Check out Sebastian Schelter’s <a href="http://www.slideshare.net/FlinkForward/sebastian-schelter-distributed-machine-learing-with-the-samsara-dsl">Flink Forward talk</a> about Mahout-Samsara DSL.</p>
<p><strong>Cascading</strong></p>
-<p><a href="http://www.cascading.org/cascading-flink/">Cascading</a> enables an user to build complex workflows easily on Flink and other execution engines.
-<a href="https://github.com/dataArtisans/cascading-flink">Cascading on Flink</a> is build by <a href="http://data-artisans.com/">dataArtisans</a> and <a href="http://www.driven.io/">Driven, Inc</a>.
+<p><a href="http://www.cascading.org/cascading-flink/">Cascading</a> enables a user to build complex workflows easily on Flink and other execution engines.
+<a href="https://github.com/dataArtisans/cascading-flink">Cascading on Flink</a> is built by <a href="http://data-artisans.com/">dataArtisans</a> and <a href="http://www.driven.io/">Driven, Inc</a>.
See Fabian Hueske’s <a href="http://www.slideshare.net/FlinkForward/fabian-hueske-training-cascading-on-flink">Flink Forward talk</a> for more details.</p>
<p><strong>Apache Beam</strong></p>
-<p><a href="https://beam.apache.org/">Apache Beam</a> is an open source, unified programming model that you can use to create a data processing pipeline. Flink is one of the back-ends supported by the Beam programming model.</p>
+<p><a href="https://beam.apache.org/">Apache Beam</a> is an open-source, unified programming model that you can use to create a data processing pipeline. Flink is one of the back-ends supported by the Beam programming model.</p>
<p><strong>GRADOOP</strong></p>
-<p><a href="http://dbs.uni-leipzig.de/en/research/projects/gradoop">GRADOOP</a> enables scalable graph analytics on top of Flink and is developed at Leipzig University. Check out <a href="http://www.slideshare.net/FlinkForward/martin-junghans-gradoop-scalable-graph-analytics-with-apache-flink">Martin Junghanns’ Flink Forward talk</a>.</p>
+<p><a href="http://dbs.uni-leipzig.de/en/research/projects/gradoop">GRADOOP</a> enables scalable graph analytics on top of Flink and is developed at Leipzig University. Check out Martin Junghanns’ <a href="http://www.slideshare.net/FlinkForward/martin-junghans-gradoop-scalable-graph-analytics-with-apache-flink">Flink Forward talk</a>.</p>
<p><strong>BigPetStore</strong></p>
@@ -212,11 +212,11 @@ See Suneel Marthi’s <a href="http://www.slideshare.net/FlinkForward/suneel-mar
<p><strong>FastR</strong></p>
-<p><a href="https://bitbucket.org/allr/fastr-flink">FastR</a> in an implemenation of the R language in Java. <a href="https://bitbucket.org/allr/fastr-flink/src/3535a9b7c7f208508d6afbcdaf1de7d04fa2bf79/README_FASTR_FLINK.md?at=default&fileviewer=file-view-default">FastR Flink</a> exeutes R workload on top of Flink.</p>
+<p><a href="https://github.com/oracle/fastr">FastR</a> is an implemenation of the R language in Java. <a href="https://bitbucket.org/allr/fastr-flink/src/3535a9b7c7f208508d6afbcdaf1de7d04fa2bf79/README_FASTR_FLINK.md?at=default&fileviewer=file-view-default">FastR Flink</a> executes R workloads on top of Flink.</p>
<p><strong>Apache SAMOA</strong></p>
-<p><a href="https://samoa.incubator.apache.org/">Apache SAMOA (incubating)</a> a streaming ML library featuring Flink an execution engine soon. Albert Bifet introduced SAMOA on Flink at his <a href="http://www.slideshare.net/FlinkForward/albert-bifet-apache-samoa-mining-big-data-streams-with-apache-flink?ref=http://flink-forward.org/?session=apache-samoa-mining-big-data-streams-with-apache-flink">Flink Forward talk</a>.</p>
+<p><a href="https://samoa.incubator.apache.org/">Apache SAMOA (incubating)</a> is a streaming ML library featuring Flink as an execution engine soon. Albert Bifet introduced SAMOA on Flink at his <a href="http://www.slideshare.net/FlinkForward/albert-bifet-apache-samoa-mining-big-data-streams-with-apache-flink?ref=http://flink-forward.org/?session=apache-samoa-mining-big-data-streams-with-apache-flink">Flink Forward talk</a>.</p>
<p><strong>Alluxio</strong></p>
@@ -228,7 +228,7 @@ See Suneel Marthi’s <a href="http://www.slideshare.net/FlinkForward/suneel-mar
<p><strong>WordCount Example in Clojure</strong></p>
-<p>Small <a href="https://github.com/mjsax/flink-external/tree/master/flink-clojure">WordCount example</a> on how to write a Flink program in Clojure.</p>
+<p>A small <a href="https://github.com/mjsax/flink-external/tree/master/flink-clojure">WordCount example</a> on how to write a Flink program in Clojure.</p>
<p><strong>Anomaly Detection and Prediction in Flink</strong></p>
@@ -240,7 +240,7 @@ See Suneel Marthi’s <a href="http://www.slideshare.net/FlinkForward/suneel-mar
<p><strong>Tink temporal graph library</strong></p>
-<p><a href="https://github.com/otherwise777/Temporal_Graph_library">Tink</a> is a temporal graph library build on top of Flink. It allows for temporal graph analytics like different interpretations of the shortest temporal path algorithm and metrics like temporal betweenness and temporal closeness. This library was the result of the <a href="http://www.win.tue.nl/~gfletche/ligtenberg2017.pdf">Thesis</a> of Wouter Ligtenberg.</p>
+<p><a href="https://github.com/otherwise777/Temporal_Graph_library">Tink</a> is a temporal graph library built on top of Flink. It allows for temporal graph analytics like different interpretations of the shortest temporal path algorithm and metrics like temporal betweenness and temporal closeness. This library was the result of the <a href="http://www.win.tue.nl/~gfletche/ligtenberg2017.pdf">Thesis</a> of Wouter Ligtenberg.</p>
</div>
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/faq.html
----------------------------------------------------------------------
diff --git a/content/faq.html b/content/faq.html
index 9b46a2a..ad058a5 100644
--- a/content/faq.html
+++ b/content/faq.html
@@ -202,7 +202,7 @@ whereas a stream of bytes from a file is a bounded stream.</p>
<p>Bounded streams are often more efficient to process than unbounded streams. Processing unbounded streams of events
in (near) real-time requires the system to be able to immediately act on events and to produce intermediate
-results (often with low latency). Processing bounded streams usually does not require to produce low latency results, because the data is a while old
+results (often with low latency). Processing bounded streams usually does not require producing low latency results, because the data is a while old
anyway (in relative terms). That allows Flink to process the data in a simple and more efficient way.</p>
<p>The <em>DataStream</em> API captures the continuous processing of unbounded and bounded streams, with a model that supports
@@ -215,7 +215,7 @@ plans to combine these optimizations with the techniques in the DataStream API.<
<p>Flink is independent of <a href="https://hadoop.apache.org/">Apache Hadoop</a> and runs without any Hadoop dependencies.</p>
-<p>However, Flink integrates very well with many Hadoop components, for example <em>HDFS</em>, <em>YARN</em>, or <em>HBase</em>.
+<p>However, Flink integrates very well with many Hadoop components, for example, <em>HDFS</em>, <em>YARN</em>, or <em>HBase</em>.
When running together with these components, Flink can use HDFS to read data, or write results and checkpoints/snapshots.
Flink can be easily deployed via YARN and integrates with the YARN and HDFS Kerberos security modules.</p>
@@ -252,14 +252,20 @@ as well as the program configuration, etc.) to the parallel worker processes.
Because of that, all functions that you pass to the API must be serializable, as defined by
<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html">java.io.Serializable</a>.</p>
-<p>If your function is an anonymous inner class, consider the following:
- - make the function a standalone class, or a static inner class
- - use a Java 8 lambda function.</p>
+<p>If your function is an anonymous inner class, consider the following:</p>
-<p>Is your function is already a static class, check the fields that you assign when you create
-an instance of the class. One of the fields most likely holds a non-serializable type.
- - In Java, use a <code>RichFunction</code> and initialize the problematic fields in the <code>open()</code> method.
- - In Scala, you can often simply use “lazy val” to defer initialization until the distributed execution happens. This may come at a minor performance cost. You can naturally also use a <code>RichFunction</code> in Scala.</p>
+<ul>
+ <li>Make the function a standalone class, or a static inner class.</li>
+ <li>Use a Java 8 lambda function.</li>
+</ul>
+
+<p>If your function is already a static class, check the fields that you assign when you create
+an instance of the class. One of the fields most likely holds a non-serializable type.</p>
+
+<ul>
+ <li>In Java, use a <code>RichFunction</code> and initialize the problematic fields in the <code>open()</code> method.</li>
+ <li>In Scala, you can often simply use “lazy val” to defer initialization until the distributed execution happens. This may come at a minor performance cost. You can naturally also use a <code>RichFunction</code> in Scala.</li>
+</ul>
<h2 id="using-the-scala-api-i-get-an-error-about-implicit-values-and-evidence-parameters">Using the Scala API, I get an error about implicit values and evidence parameters.</h2>
@@ -287,13 +293,13 @@ multiple versions of the class <code>com.foo.X</code> have been loaded by differ
<ul>
<li>
- <p>Class duplication through <code>child-first</code> classloading. That is an intended mechanism to allow users to use different versions of the same
+ <p>Class duplication through <code>child-first</code> classloading. That is an intentional mechanism to allow users to use different versions of the same
dependencies that Flink uses. However, if different copies of these classes move between Flink’s core and the user application code, such an exception
can occur. To verify that this is the reason, try setting <code>classloader.resolve-order: parent-first</code> in the configuration.
If that makes the error disappear, please write to the mailing list to check if that may be a bug.</p>
</li>
<li>
- <p>Caching of classes from different execution attempts, for example by utilities like Guava’s Interners, or Avro’s Schema cache.
+ <p>Caching of classes from different execution attempts, for example, by utilities like Guava’s Interners, or Avro’s Schema cache.
Try to not use interners, or reduce the scope of the interner/cache to make sure a new cache is created whenever a new task
execution is started.</p>
</li>
@@ -308,10 +314,13 @@ is loaded during the execution compared to the version that code was compiled ag
by Flink’s core, or other dependencies in the classpath (for example from Hadoop). That requires <code>child-first</code> classloading
to be activated, which is the default.</p>
-<p>If you see these problems in Flink 1.4+, one of the following may be true:
- - You have a dependency version conflict within your application code. Make sure all your dependency versions are consistent.
- - You are conflicting with a library that Flink cannot support via <code>child-first</code> classloading. Currently these are the
- Scala standard library classes, as well as Flink’s own classes, logging APIs, and any Hadoop core classes.</p>
+<p>If you see these problems in Flink 1.4+, one of the following may be true:</p>
+
+<ul>
+ <li>You have a dependency version conflict within your application code. Make sure all your dependency versions are consistent.</li>
+ <li>You are conflicting with a library that Flink cannot support via <code>child-first</code> classloading. Currently these are the
+Scala standard library classes, as well as Flink’s own classes, logging APIs, and any Hadoop core classes.</li>
+</ul>
<h2 id="my-datastream-application-produces-no-output-even-though-events-are-going-in">My DataStream application produces no output, even though events are going in.</h2>
@@ -332,14 +341,13 @@ You can adjust all these values via <code>taskmanager.network.memory.fraction</c
<h2 id="my-job-fails-with-various-exceptions-from-the-hdfshadoop-code-what-can-i-do">My job fails with various exceptions from the HDFS/Hadoop code. What can I do?</h2>
-<p>The most common cause for that is that the Hadoop version in Flink’s classpath is different than the
+<p>The most common cause for that is that the Hadoop version in Flink’s classpath is different from the
Hadoop version of the cluster you want to connect to (HDFS / YARN).</p>
<p>The easiest way to fix that is to pick a Hadoop-free Flink version and simply export the Hadoop path and
classpath from the cluster.</p>
-
</div>
</div>
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/how-to-contribute.html
----------------------------------------------------------------------
diff --git a/content/how-to-contribute.html b/content/how-to-contribute.html
index 9b81321..a27e9d9 100644
--- a/content/how-to-contribute.html
+++ b/content/how-to-contribute.html
@@ -164,13 +164,13 @@
<h2 id="file-a-bug-report">File a bug report</h2>
-<p>Please let us know if you experienced a problem with Flink and file a bug report. Open <a href="http://issues.apache.org/jira/browse/FLINK">Flink’s JIRA</a> and click on the blue <strong>Create</strong> button at the top. Please give detailed information about the problem you encountered and, if possible, add a description that helps to reproduce the problem. Thank you very much.</p>
+<p>Please let us know if you experienced a problem with Flink and file a bug report. Open <a href="http://issues.apache.org/jira/browse/FLINK">Flink’s Jira</a>, log in if necessary, and click on the red <strong>Create</strong> button at the top. Please give detailed information about the problem you encountered and, if possible, add a description that helps to reproduce the problem. Thank you very much.</p>
<hr />
<h2 id="propose-an-improvement-or-a-new-feature">Propose an improvement or a new feature</h2>
-<p>Our community is constantly looking for feedback to improve Apache Flink. If you have an idea how to improve Flink or have a new feature in mind that would be beneficial for Flink users, please open an issue in <a href="http://issues.apache.org/jira/browse/FLINK">Flink’s JIRA</a>. The improvement or new feature should be described in appropriate detail and include the scope and its requirements if possible. Detailed information is important for a few reasons:</p>
+<p>Our community is constantly looking for feedback to improve Apache Flink. If you have an idea how to improve Flink or have a new feature in mind that would be beneficial for Flink users, please open an issue in <a href="http://issues.apache.org/jira/browse/FLINK">Flink’s Jira</a>. The improvement or new feature should be described in appropriate detail and include the scope and its requirements if possible. Detailed information is important for a few reasons:</p>
<ul>
<li>It ensures your requirements are met when the improvement or feature is implemented.</li>
@@ -193,7 +193,7 @@ discussions on existing proposals.</p>
<p>Most communication in the Apache Flink community happens on two mailing lists:</p>
<ul>
- <li>The user mailing lists <code>user@flink.apache.org</code> is the place where users of Apache Flink ask questions and seek for help or advice. Joining the user list and helping other users is a very good way to contribute to Flink’s community. Furthermore, there is the <a href="http://stackoverflow.com/questions/tagged/apache-flink">[apache-flink]</a> tag on Stack Overflow if you’d like to help Flink users (and harvest some points) there.</li>
+ <li>The user mailing list <code>user@flink.apache.org</code> is the place where users of Apache Flink ask questions and seek help or advice. Joining the user list and helping other users is a very good way to contribute to Flink’s community. Furthermore, there is the <a href="http://stackoverflow.com/questions/tagged/apache-flink">[apache-flink]</a> tag on Stack Overflow if you’d like to help Flink users (and harvest some points) there.</li>
<li>The development mailing list <code>dev@flink.apache.org</code> is the place where Flink developers exchange ideas and discuss new features, upcoming releases, and the development process in general. If you are interested in contributing code to Flink, you should join this mailing list.</li>
</ul>
@@ -208,7 +208,7 @@ discussions on existing proposals.</p>
<ol>
<li>Building a new release candidate and starting a vote (usually for 72 hours).</li>
<li>Testing the release candidate and voting (<code>+1</code> if no issues were found, <code>-1</code> if the release candidate has issues).</li>
- <li>Going back to step 1 if the release candidate had issues otherwise we publish the release.</li>
+ <li>Going back to step 1 if the release candidate had issues. Otherwise we publish the release.</li>
</ol>
<p>Our wiki contains a page that summarizes the <a href="https://cwiki.apache.org/confluence/display/FLINK/Releasing">test procedure for a release</a>. Release testing is a big effort if done by a small group of people but can be easily scaled out to more people. The Flink community encourages everybody to participate in the testing of a release candidate. By testing a release candidate, you can ensure that the next Flink release is working properly for your setup and help to improve the quality of releases.</p>
@@ -217,7 +217,7 @@ discussions on existing proposals.</p>
<h2 id="contribute-code">Contribute code</h2>
-<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 our <a href="/contribute-code.html">Contribute code</a> guide. The guide does also include instructions to setup a development environment, our coding guidelines and code style, and explains how to submit a code contribution.</p>
+<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 our <a href="/contribute-code.html">Contribute code</a> guide. The guide also includes instructions on how to setup a development environment, our coding guidelines and code style, and explains how to submit a code contribution.</p>
<p><strong>Please read the <a href="/contribute-code.html">Contribute code</a> guide before you start to work on a code contribution.</strong></p>
@@ -225,7 +225,7 @@ discussions on existing proposals.</p>
<h3 class="no_toc" id="looking-for-an-issue-to-work-on">Looking for an issue to work on?</h3>
-<p>We maintain a list of all known bugs, proposed improvements and suggested features in <a href="https://issues.apache.org/jira/browse/FLINK/?selectedTab=com.atlassian.jira.jira-projects-plugin:issues-panel">Flink’s JIRA</a>. Issues that we believe are good tasks for new contributors are tagged with a special “starter” tag. Those tasks are supposed to be rather easy to solve and will help you to become familiar with the project and the contribution process.</p>
+<p>We maintain a list of all known bugs, proposed improvements, and suggested features in <a href="https://issues.apache.org/jira/browse/FLINK/?selectedTab=com.atlassian.jira.jira-projects-plugin:issues-panel">Flink’s Jira</a>. Issues that we believe are good tasks for new contributors are tagged with a special “starter” tag. Those tasks are supposed to be rather easy to solve and will help you to become familiar with the project and the contribution process.</p>
<p>Please have a look at the list of <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20FLINK%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20starter%20ORDER%20BY%20priority%20DESC">starter issues</a>, if you are looking for an issue to work on. You can of course also choose <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20FLINK%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20priority%20DESC">any other issue</a> to work on. Feel free to ask questions about issues that you would be interested in working on.</p>
@@ -236,7 +236,7 @@ discussions on existing proposals.</p>
<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>
<ul>
- <li>Please report missing, incorrect, or out-dated documentation as a <a href="http://issues.apache.org/jira/browse/FLINK">JIRA issue</a>.</li>
+ <li>Please report missing, incorrect, or outdated documentation as a <a href="http://issues.apache.org/jira/browse/FLINK">Jira issue</a>.</li>
<li>Flink’s documentation is written in Markdown and located in the <code>docs</code> folder in <a href="/community.html#main-source-repositories">Flink’s source code repository</a>. See the <a href="/contribute-documentation.html">Contribute documentation</a> guidelines for detailed instructions for how to update and improve the documentation and to contribute your changes.</li>
</ul>
@@ -255,7 +255,7 @@ discussions on existing proposals.</p>
<p>We welcome any contribution to improve our website.</p>
<ul>
- <li>Please open a <a href="http://issues.apache.org/jira/browse/FLINK">JIRA issue</a> if you think our website could be improved.</li>
+ <li>Please open a <a href="http://issues.apache.org/jira/browse/FLINK">Jira issue</a> if you think our website could be improved.</li>
<li>Please follow the <a href="/improve-website.html">Improve the website</a> guidelines if you would like to update and improve the website.</li>
</ul>
@@ -263,12 +263,12 @@ discussions on existing proposals.</p>
<h2 id="more-ways-to-contribute">More ways to contribute…</h2>
-<p>There are many more ways to contribute to the Flink community. For example you can</p>
+<p>There are many more ways to contribute to the Flink community. For example you can:</p>
<ul>
- <li>give a talk about Flink and tell others how you use it.</li>
- <li>organize a local Meetup or user group.</li>
- <li>talk to people about Flink.</li>
+ <li>Give a talk about Flink and tell others how you use it.</li>
+ <li>Organize a local Meetup or user group.</li>
+ <li>Talk to people about Flink.</li>
<li>…</li>
</ul>
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/improve-website.html
----------------------------------------------------------------------
diff --git a/content/improve-website.html b/content/improve-website.html
index cdb151b..3e424c9 100644
--- a/content/improve-website.html
+++ b/content/improve-website.html
@@ -160,9 +160,9 @@
<h2 id="obtain-the-website-sources">Obtain the website sources</h2>
-<p>The website of Apache Flink is hosted in a dedicated <a href="http://git-scm.com/">git</a> repository which is mirrored to Github at <a href="https://github.com/apache/flink-web">https://github.com/apache/flink-web</a>.</p>
+<p>The website of Apache Flink is hosted in a dedicated <a href="http://git-scm.com/">git</a> repository which is mirrored to GitHub at <a href="https://github.com/apache/flink-web">https://github.com/apache/flink-web</a>.</p>
-<p>The easiest way to contribute website updates is to fork <a href="https://github.com/apache/flink-web">the mirrored website 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>The easiest way to contribute website updates is to fork <a href="https://github.com/apache/flink-web">the mirrored website 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>
@@ -212,7 +212,7 @@ git checkout asf-site
<p>Commit your changes to your local git repository. <strong>Please Make sure that your commit does not include translated files (any files in the <code>content/</code> directory).</strong> Unless your contribution is a major rework of the website, please squash it into a single commit.</p>
</li>
<li>
- <p>Push the commit to a dedicated branch of your fork of the Flink repository at Github.</p>
+ <p>Push the commit to a dedicated branch of your fork of the Flink repository at GitHub.</p>
<p><code>
git push origin myBranch
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/introduction.html
----------------------------------------------------------------------
diff --git a/content/introduction.html b/content/introduction.html
index 3ab664f..0b4acc6 100644
--- a/content/introduction.html
+++ b/content/introduction.html
@@ -298,7 +298,7 @@ Below is a high-level overview of Apache Flink and stream processing. For a more
<p>In summary, Apache Flink is an open-source stream processing framework that eliminates the “performance vs. reliability” tradeoff often associated with open-source streaming engines and performs consistently in both categories. Following this introduction, we recommend you try our <a href="http://ci.apache.org/projects/flink/flink-docs-release-1.5/quickstart/setup_quickstart.html" target="_blank">quickstart</a>, <a href="/downloads.html">download</a> the most recent stable version of Flink, or review the <a href="http://ci.apache.org/projects/flink/flink-docs-release-1.5/index.html" target="_blank">documentation</a>.</p>
-<p>And we encourage you to join the Flink user mailing list and to share your questions with the community. We’re here to help you get the most out of Flink.</p>
+<p>And we encourage you to join the Flink <a href="/community.html#mailing-lists">user mailing list</a> and to share your questions with the community. We’re here to help you get the most out of Flink.</p>
</div>
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/poweredby.html
----------------------------------------------------------------------
diff --git a/content/poweredby.html b/content/poweredby.html
index 2a902c2..f7d05b0 100644
--- a/content/poweredby.html
+++ b/content/poweredby.html
@@ -151,7 +151,7 @@
</style>
</head>
-<p>To demonstrate Flink's capabilities, we've collected a few examples Flink use cases inside of companies. The <a href="https://cwiki.apache.org/confluence/display/FLINK/Powered+by+Flink" target="_blank"><small><span class="glyphicon glyphicon-new-window"></span></small> Powered by Flink directory</a> has a comprehensive list of companies and organizations using Flink.</p>
+<p>To demonstrate Flink's capabilities, we've collected a few examples of Flink use cases inside of companies. The <a href="https://cwiki.apache.org/confluence/display/FLINK/Powered+by+Flink" target="_blank"><small><span class="glyphicon glyphicon-new-window"></span></small> Powered by Flink directory</a> has a comprehensive list of companies and organizations using Flink.</p>
<p>Would you like to be included on this page? Please reach out to the <a href="/community.html#mailing-lists">Flink user mailing list</a> and let us know.</p>
@@ -175,7 +175,7 @@
</div>
<div class="height col-md-3 col-sm-4 col-xs-6">
<img src="/img/poweredby/dtrb-logo.png" width="175" alt="Drivetribe" /><br />
- Drivetribe, a digital community founded by the former hosts of "Top Gear", uses Flink for metrics and content recommendations. <br /><br /><a href="https://data-artisans.com/drivetribe-cqrs-apache-flink/" target="_blank"><small><span class="glyphicon glyphicon-new-window"></span></small> Read about Flink in the Drivetribe stack</a>
+ Drivetribe, a digital community founded by the former hosts of “Top Gear”, uses Flink for metrics and content recommendations. <br /><br /><a href="https://data-artisans.com/drivetribe-cqrs-apache-flink/" target="_blank"><small><span class="glyphicon glyphicon-new-window"></span></small> Read about Flink in the Drivetribe stack</a>
</div>
<div class="height col-md-3 col-sm-4 col-xs-6">
@@ -217,8 +217,8 @@
</div>
<div class="height col-md-3 col-sm-4 col-xs-6">
<img src="/img/poweredby/zalando-logo.jpg" width="175" alt="Zalando" /><br />
- Zalando, one of the largest ecommerce companies in Europe, uses Flink for real-time process monitoring and ETL. <br /><br /><a href="https://tech.zalando.de/blog/apache-showdown-flink-vs.-spark/" target="_blank"><small><span class="glyphicon glyphicon-new-window"></span></small> Read more on the Zalando Tech Blog</a>
-
+ Zalando, one of the largest e-commerce companies in Europe, uses Flink for real-time process monitoring and ETL. <br /><br /><a href="https://tech.zalando.de/blog/apache-showdown-flink-vs.-spark/" target="_blank"><small><span class="glyphicon glyphicon-new-window"></span></small> Read more on the Zalando Tech Blog</a>
+
</div>
http://git-wip-us.apache.org/repos/asf/flink-web/blob/0b278cc2/content/usecases.html
----------------------------------------------------------------------
diff --git a/content/usecases.html b/content/usecases.html
index 87e1423..5e5d6fd 100644
--- a/content/usecases.html
+++ b/content/usecases.html
@@ -163,7 +163,7 @@
<p><strong>A variety of (sometimes unreliable) data sources:</strong> When data is generated by millions of different users or devices, it’s safe to assume that some events will arrive out of the order they actually occurred–and in the case of more significant upstream failures, some events might come <em>hours</em> later than they’re supposed to. Late data needs to be handled so that results are accurate.</p>
</li>
<li>
- <p><strong>Applications with state:</strong> When applications become more complex than simple filtering or enhancing of single data records, managing state within these applications (e.g., counters, windows of past data, state machines, embedded databases) becomes hard. Flink provides tools so that state is efficient, fault tolerant, and manageable from the outside so you don’t have to build these capabilities yourself.</p>
+ <p><strong>Applications with state:</strong> When applications become more complex than simple filtering or enhancing of single data records, managing state within these applications (e.g., counters, windows of past data, state machines, embedded databases) becomes hard. Flink provides tools so that state is efficient, fault-tolerant, and manageable from the outside so you don’t have to build these capabilities yourself.</p>
</li>
<li>
<p><strong>Data that is processed quickly:</strong> There is a focus in these use cases on real-time or near-real-time scenarios, where insights from data should be available at nearly the same moment that the data is generated. Flink is fully capable of meeting these latency requirements when necessary.</p>