http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/faq.html ---------------------------------------------------------------------- diff --git a/content/faq.html b/content/faq.html index 7456bcb..294e6f7 100644 --- a/content/faq.html +++ b/content/faq.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> @@ -166,41 +168,41 @@ under the License. <div class="page-toc"> <ul id="markdown-toc"> - <li><a href="#general" id="markdown-toc-general">General</a> <ul> - <li><a href="#is-flink-a-hadoop-project" id="markdown-toc-is-flink-a-hadoop-project">Is Flink a Hadoop Project?</a></li> - <li><a href="#do-i-have-to-install-apache-hadoop-to-use-flink" id="markdown-toc-do-i-have-to-install-apache-hadoop-to-use-flink">Do I have to install Apache Hadoop to use Flink?</a></li> + <li><a href="#general">General</a> <ul> + <li><a href="#is-flink-a-hadoop-project">Is Flink a Hadoop Project?</a></li> + <li><a href="#do-i-have-to-install-apache-hadoop-to-use-flink">Do I have to install Apache Hadoop to use Flink?</a></li> </ul> </li> - <li><a href="#usage" id="markdown-toc-usage">Usage</a> <ul> - <li><a href="#how-do-i-assess-the-progress-of-a-flink-program" id="markdown-toc-how-do-i-assess-the-progress-of-a-flink-program">How do I assess the progress of a Flink program?</a></li> - <li><a href="#how-can-i-figure-out-why-a-program-failed" id="markdown-toc-how-can-i-figure-out-why-a-program-failed">How can I figure out why a program failed?</a></li> - <li><a href="#how-do-i-debug-flink-programs" id="markdown-toc-how-do-i-debug-flink-programs">How do I debug Flink programs?</a></li> - <li><a href="#what-is-the-parallelism-how-do-i-set-it" id="markdown-toc-what-is-the-parallelism-how-do-i-set-it">What is the parallelism? How do I set it?</a></li> + <li><a href="#usage">Usage</a> <ul> + <li><a href="#how-do-i-assess-the-progress-of-a-flink-program">How do I assess the progress of a Flink program?</a></li> + <li><a href="#how-can-i-figure-out-why-a-program-failed">How can I figure out why a program failed?</a></li> + <li><a href="#how-do-i-debug-flink-programs">How do I debug Flink programs?</a></li> + <li><a href="#what-is-the-parallelism-how-do-i-set-it">What is the parallelism? How do I set it?</a></li> </ul> </li> - <li><a href="#errors" id="markdown-toc-errors">Errors</a> <ul> - <li><a href="#why-am-i-getting-a-nonserializableexception-" id="markdown-toc-why-am-i-getting-a-nonserializableexception-">Why am I getting a âNonSerializableExceptionâ ?</a></li> - <li><a href="#in-scala-api-i-get-an-error-about-implicit-values-and-evidence-parameters" id="markdown-toc-in-scala-api-i-get-an-error-about-implicit-values-and-evidence-parameters">In Scala API, I get an error about implicit values and evidence parameters</a></li> - <li><a href="#i-get-an-error-message-saying-that-not-enough-buffers-are-available-how-do-i-fix-this" id="markdown-toc-i-get-an-error-message-saying-that-not-enough-buffers-are-available-how-do-i-fix-this">I get an error message saying that not enough buffers are available. How do I fix this?</a></li> - <li><a href="#my-job-fails-early-with-a-javaioeofexception-what-could-be-the-cause" id="markdown-toc-my-job-fails-early-with-a-javaioeofexception-what-could-be-the-cause">My job fails early with a java.io.EOFException. What could be the cause?</a></li> - <li><a href="#my-job-fails-with-various-exceptions-from-the-hdfshadoop-code-what-can-i-do" id="markdown-toc-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?</a></li> - <li><a href="#in-eclipse-i-get-compilation-errors-in-the-scala-projects" id="markdown-toc-in-eclipse-i-get-compilation-errors-in-the-scala-projects">In Eclipse, I get compilation errors in the Scala projects</a></li> - <li><a href="#my-program-does-not-compute-the-correct-result-why-are-my-custom-key-types" id="markdown-toc-my-program-does-not-compute-the-correct-result-why-are-my-custom-key-types">My program does not compute the correct result. Why are my custom key types</a></li> - <li><a href="#i-get-a-javalanginstantiationexception-for-my-data-type-what-is-wrong" id="markdown-toc-i-get-a-javalanginstantiationexception-for-my-data-type-what-is-wrong">I get a java.lang.InstantiationException for my data type, what is wrong?</a></li> - <li><a href="#i-cant-stop-flink-with-the-provided-stop-scripts-what-can-i-do" id="markdown-toc-i-cant-stop-flink-with-the-provided-stop-scripts-what-can-i-do">I canât stop Flink with the provided stop-scripts. What can I do?</a></li> - <li><a href="#i-got-an-outofmemoryexception-what-can-i-do" id="markdown-toc-i-got-an-outofmemoryexception-what-can-i-do">I got an OutOfMemoryException. What can I do?</a></li> - <li><a href="#why-do-the-taskmanager-log-files-become-so-huge" id="markdown-toc-why-do-the-taskmanager-log-files-become-so-huge">Why do the TaskManager log files become so huge?</a></li> - <li><a href="#the-slot-allocated-for-my-task-manager-has-been-released-what-should-i-do" id="markdown-toc-the-slot-allocated-for-my-task-manager-has-been-released-what-should-i-do">The slot allocated for my task manager has been released. What should I do?</a></li> + <li><a href="#errors">Errors</a> <ul> + <li><a href="#why-am-i-getting-a-nonserializableexception-">Why am I getting a âNonSerializableExceptionâ ?</a></li> + <li><a href="#in-scala-api-i-get-an-error-about-implicit-values-and-evidence-parameters">In Scala API, I get an error about implicit values and evidence parameters</a></li> + <li><a href="#i-get-an-error-message-saying-that-not-enough-buffers-are-available-how-do-i-fix-this">I get an error message saying that not enough buffers are available. How do I fix this?</a></li> + <li><a href="#my-job-fails-early-with-a-javaioeofexception-what-could-be-the-cause">My job fails early with a java.io.EOFException. What could be the cause?</a></li> + <li><a href="#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?</a></li> + <li><a href="#in-eclipse-i-get-compilation-errors-in-the-scala-projects">In Eclipse, I get compilation errors in the Scala projects</a></li> + <li><a href="#my-program-does-not-compute-the-correct-result-why-are-my-custom-key-types">My program does not compute the correct result. Why are my custom key types</a></li> + <li><a href="#i-get-a-javalanginstantiationexception-for-my-data-type-what-is-wrong">I get a java.lang.InstantiationException for my data type, what is wrong?</a></li> + <li><a href="#i-cant-stop-flink-with-the-provided-stop-scripts-what-can-i-do">I canât stop Flink with the provided stop-scripts. What can I do?</a></li> + <li><a href="#i-got-an-outofmemoryexception-what-can-i-do">I got an OutOfMemoryException. What can I do?</a></li> + <li><a href="#why-do-the-taskmanager-log-files-become-so-huge">Why do the TaskManager log files become so huge?</a></li> + <li><a href="#the-slot-allocated-for-my-task-manager-has-been-released-what-should-i-do">The slot allocated for my task manager has been released. What should I do?</a></li> </ul> </li> - <li><a href="#yarn-deployment" id="markdown-toc-yarn-deployment">YARN Deployment</a> <ul> - <li><a href="#the-yarn-session-runs-only-for-a-few-seconds" id="markdown-toc-the-yarn-session-runs-only-for-a-few-seconds">The YARN session runs only for a few seconds</a></li> - <li><a href="#the-yarn-session-crashes-with-a-hdfs-permission-exception-during-startup" id="markdown-toc-the-yarn-session-crashes-with-a-hdfs-permission-exception-during-startup">The YARN session crashes with a HDFS permission exception during startup</a></li> + <li><a href="#yarn-deployment">YARN Deployment</a> <ul> + <li><a href="#the-yarn-session-runs-only-for-a-few-seconds">The YARN session runs only for a few seconds</a></li> + <li><a href="#the-yarn-session-crashes-with-a-hdfs-permission-exception-during-startup">The YARN session crashes with a HDFS permission exception during startup</a></li> </ul> </li> - <li><a href="#features" id="markdown-toc-features">Features</a> <ul> - <li><a href="#what-kind-of-fault-tolerance-does-flink-provide" id="markdown-toc-what-kind-of-fault-tolerance-does-flink-provide">What kind of fault-tolerance does Flink provide?</a></li> - <li><a href="#are-hadoop-like-utilities-such-as-counters-and-the-distributedcache-supported" id="markdown-toc-are-hadoop-like-utilities-such-as-counters-and-the-distributedcache-supported">Are Hadoop-like utilities, such as Counters and the DistributedCache supported?</a></li> + <li><a href="#features">Features</a> <ul> + <li><a href="#what-kind-of-fault-tolerance-does-flink-provide">What kind of fault-tolerance does Flink provide?</a></li> + <li><a href="#are-hadoop-like-utilities-such-as-counters-and-the-distributedcache-supported">Are Hadoop-like utilities, such as Counters and the DistributedCache supported?</a></li> </ul> </li> </ul> @@ -430,7 +432,7 @@ cluster.sh</code>). You can kill their processes on Linux/Mac as follows:</p> <ul> <li>Determine the process id (pid) of the JobManager / TaskManager process. You can use the <code>jps</code> command on Linux(if you have OpenJDK installed) or command -<code>ps -ef | grep java</code> to find all Java processes.</li> +<code>ps -ef | grep java</code> to find all Java processes. </li> <li>Kill the process with <code>kill -9 <pid></code>, where <code>pid</code> is the process id of the affected JobManager or TaskManager process.</li> </ul>
http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/features.html ---------------------------------------------------------------------- diff --git a/content/features.html b/content/features.html index 0ac66ef..237055b 100644 --- a/content/features.html +++ b/content/features.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/how-to-contribute.html ---------------------------------------------------------------------- diff --git a/content/how-to-contribute.html b/content/how-to-contribute.html index a29e46b..724221e 100644 --- a/content/how-to-contribute.html +++ b/content/how-to-contribute.html @@ -5,7 +5,7 @@ <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: How To Contribute</title> + <title>Apache Flink: Contributions Welcome!</title> <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon"> <link rel="icon" href="/favicon.ico" type="image/x-icon"> @@ -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> @@ -140,228 +142,168 @@ <div class="row"> <div class="col-sm-8 col-sm-offset-2"> <div class="row"> - <div class="col-sm-12"><h1>How To Contribute</h1></div> + <div class="col-sm-12"><h1>Contributions Welcome!</h1></div> </div> -<p>The Flink project welcomes all sort of contributions in the form of code (improvements, features, bugfixes), tests, documentation, and community participation (discussions & questions).</p> +<p>Apache Flink is developed by an open and friendly community. Everybody is cordially welcome to join the community and contribute to Apache Flink. There are several ways to interact with the community and to contribute to Flink including asking questions, filing bug reports, proposing new features, joining discussions on the mailing lists, contributing code or documentation, improving the website, or testing release candidates.</p> <div class="page-toc"> <ul id="markdown-toc"> - <li><a href="#easy-issues-for-starters" id="markdown-toc-easy-issues-for-starters">Easy Issues for Starters</a></li> - <li><a href="#contributing-code--documentation" id="markdown-toc-contributing-code--documentation">Contributing Code & Documentation</a> <ul> - <li><a href="#setting-up-the-infrastructure-and-creating-a-pull-request" id="markdown-toc-setting-up-the-infrastructure-and-creating-a-pull-request">Setting up the Infrastructure and Creating a Pull Request</a></li> - <li><a href="#verifying-the-compliance-of-your-code" id="markdown-toc-verifying-the-compliance-of-your-code">Verifying the Compliance of your Code</a></li> - </ul> - </li> - <li><a href="#contribute-changes-to-the-website" id="markdown-toc-contribute-changes-to-the-website">Contribute changes to the Website</a> <ul> - <li><a href="#files-and-directories-in-the-website-git-repository" id="markdown-toc-files-and-directories-in-the-website-git-repository">Files and Directories in the website git repository</a></li> - <li><a href="#the-buildsh-script" id="markdown-toc-the-buildsh-script">The <code>build.sh</code> script</a></li> - </ul> - </li> - <li><a href="#how-to-become-a-committer" id="markdown-toc-how-to-become-a-committer">How to become a committer</a> <ul> - <li><a href="#how-to-use-git-as-a-committer" id="markdown-toc-how-to-use-git-as-a-committer">How to use git as a committer</a></li> - </ul> - </li> - <li><a href="#snapshots-nightly-builds" id="markdown-toc-snapshots-nightly-builds">Snapshots (Nightly Builds)</a></li> + <li><a href="#ask-questions">Ask questions!</a></li> + <li><a href="#file-a-bug-report">File a bug report</a></li> + <li><a href="#propose-an-improvement-or-a-new-feature">Propose an improvement or a new feature</a></li> + <li><a href="#help-others-and-join-the-discussions">Help others and join the discussions</a></li> + <li><a href="#test-a-release-candidate">Test a release candidate</a></li> + <li><a href="#contribute-code">Contribute code</a></li> + <li><a href="#contribute-documentation">Contribute documentation</a></li> + <li><a href="#improve-the-website">Improve the website</a></li> + <li><a href="#more-ways-to-contribute">More ways to contributeâ¦</a></li> + <li><a href="#submit-a-contributor-license-agreement">Submit a Contributor License Agreement</a></li> + <li><a href="#how-to-become-a-committer">How to become a committer</a></li> </ul> </div> -<h2 id="easy-issues-for-starters">Easy Issues for Starters</h2> +<h2 id="ask-questions">Ask questions!</h2> -<p>We maintain all known issues and feature drafts in the <a href="https://issues.apache.org/jira/issues/?jql=project+%3D+FLINK";>Flink JIRA project</a>.</p> +<p>The Apache Flink community is eager to help and to answer your questions. We have a <a href="/community.html#mailing-lists">user mailing list</a>, hang out in an <a href="/community.html#irc">IRC channel</a>, and watch Stack Overflow on the <a href="http://stackoverflow.com/questions/tagged/apache-flink";>[apache-flink]</a> tag.</p> -<p>We also try to maintain a <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";>list of simple âstarter issuesâ</a> that we believe are good tasks for new contributors. Those tasks are meant to allow people to get into the project and become familiar with the process of contributing. Feel free to ask questions about issues that you would be interested in working on.</p> +<hr /> -<p>In addition, you can find a list of ideas for projects and improvements in the <a href="https://cwiki.apache.org/confluence/display/FLINK/Project+Ideas";>projects Wiki page</a>.</p> +<h2 id="file-a-bug-report">File a bug report</h2> -<h2 id="contributing-code--documentation">Contributing Code & Documentation</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>This section gives you a brief introduction in how to contribute code and documentation to Flink. We maintain both the code and the documentation in the same repository, so the process is essentially the same for both. We use <a href="http://git-scm.com/";>git</a> for the code and documentation version control. The documentation is located in the <code>docs/</code> subdirectory of the git repository.</p> +<hr /> -<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 basically a simpler way of offering a patch, by providing a pointer to a code branch that contains the change.</p> +<h2 id="propose-an-improvement-or-a-new-feature">Propose an improvement or a new feature</h2> -<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>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> -<h3 id="setting-up-the-infrastructure-and-creating-a-pull-request">Setting up the Infrastructure and Creating a Pull Request</h3> +<ul> + <li>It ensures your requirements are met when the improvement or feature is implemented.</li> + <li>It helps to estimate the effort and to design a solution that addresses your needs.</li> + <li>It allow for constructive discussions that might arise around this issue.</li> +</ul> -<ol> - <li> - <p>The first step is to create yourself a copy of the Flink code base. We suggest to fork the <a href="https://github.com/apache/flink";>Flink GitHub Mirror Repository</a> into your own <a href="https://github.com";>GitHub</a> account. You need to register on GitHub for that, if you have no account so far.</p> - </li> - <li> - <p>Next, clone your repository fork to your local machine.</p> - - <div class="highlight"><pre><code>git clone https://github.com/<your-user-name>/flink.git -</code></pre></div> - </li> - <li> - <p>It is typically helpful to switch to a <em>topic branch</em> for the changes. To create a dedicated branch based on the current master, use the following command:</p> - - <div class="highlight"><pre><code>git checkout -b myBranch master -</code></pre></div> - </li> - <li> - <p>Now you can create your changes, compile the code, and validate the changes. Here are some pointers on how to <a href="https://github.com/apache/flink/#building-apache-flink-from-source";>build the code</a>. -In addition to that, we recommend setting up Eclipse (or IntelliJ) using the âImport Maven Projectâ feature:</p> - - <ul> - <li>Select âImportâ from the âFileâ menu.</li> - <li>Expand the âMavenâ node, select âExisting Maven Projectsâ, and click the âNextâ button.</li> - <li>Select the root directory by clicking on the âBrowseâ button and navigate to the top folder of the cloned Flink git repository.</li> - <li>Ensure that all projects are selected and click the âFinishâ button.<br /><br /><!-- newline hack --></li> - </ul> - - <p>If you want to work on the Scala code you will need the following plugins:</p> - - <p><strong>Eclipse 4.x</strong>:</p> - - <ul> - <li>scala-ide: <code>http://download.scala-ide.org/sdk/e38/scala210/stable/site</code></li> - <li>m2eclipse-scala: <code>http://alchim31.free.fr/m2e-scala/update-site</code></li> - <li>build-helper-maven-plugin: <code>https://repository.sonatype.org/content/repositories/forge-sites/m2e-extras/0.15.0/N/0.15.0.201206251206/</code><br /><br /><!-- newline hack --></li> - </ul> - - <p><strong>Eclipse 3.7</strong>:</p> - - <ul> - <li>scala-ide: <code>http://download.scala-ide.org/sdk/e37/scala210/stable/site</code></li> - <li>m2eclipse-scala: <code>http://alchim31.free.fr/m2e-scala/update-site</code></li> - <li>build-helper-maven-plugin: <code>https://repository.sonatype.org/content/repositories/forge-sites/m2e-extras/0.14.0/N/0.14.0.201109282148/</code><br /><br /><!-- newline hack --></li> - </ul> - - <p>If you donât have the plugins your project will have build errors, but you can just close the Scala projects and ignore them.</p> - </li> - <li> - <p>After you have finalized your contribution, verify the compliance with the contribution guidelines (see below), and make the commit. To make the changes easily mergeable, please rebase them to the latest version of the main repositoryâs master branch. Assuming you created a topic branch (step 3), you can follow this sequence of commands to do that: -switch to the master branch, update it to the latest revision, switch back to your topic branch, and rebase it on top of the master branch.</p> - - <div class="highlight"><pre><code>git checkout master -git pull https://github.com/apache/flink.git master -git checkout myBranch -git rebase master -</code></pre></div> - <p>Have a look <a href="https://help.github.com/articles/using-git-rebase";>here</a> for more information about rebasing commits.</p> - </li> - <li> - <p>Push the 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 â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 send it.</p> - </li> -</ol> +<p>Detailed information is also required, if you plan to contribute the improvement or feature you proposed yourself. Please read the <a href="/contribute-code.html">Contribute code</a> guide in this case as well. </p> -<h3 id="verifying-the-compliance-of-your-code">Verifying the Compliance of your Code</h3> +<hr /> -<p>Before sending a patch or pull request, please verify that it complies with the guidelines of the project. While we try to keep the set of guidelines small and easy, it is important to follow those rules in order to guarantee good code quality, to allow efficient reviews, and to allow committers to easily merge your changes.</p> +<h2 id="help-others-and-join-the-discussions">Help others and join the discussions</h2> -<p>Please have a look at the <a href="/coding-guidelines.html">coding guidelines</a> for a guide to the format of code and pull requests.</p> +<p>Most communication in the Apache Flink community happens on two mailing lists:</p> -<p>Most important of all, verify that your changes are correct and do not break existing functionality. Run the existing tests by calling <code>mvn verify</code> in the root directory of the repository, and make sure that the tests succeed. 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. 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 donât 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 âflinkâ repository on <a href="https://travis-ci.org/profile";>Travis</a>.</p> +<ul> + <li>The user mailing lists <code>[email protected]</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 development mailing list <code>[email protected]</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> -<p>When contributing documentation, please review the rendered HTML versions of the documents you changed. You can look at the HTML pages by using the rendering script in preview mode.</p> +<p>You are very welcome to <a href="/community.html#mailing-lists">subscribe to both mailing lists</a>. In addition to the user list, there is also a <a href="/community.html#irc">Flink IRC</a> channel that you can join to talk to other users and contributors.</p> -<div class="highlight"><pre><code>cd docs -./build_docs.sh -p -</code></pre></div> -<p>Now, open your browser at <code>http://localhost:4000</code> and check out the pages you changed.</p> +<hr /> -<h2 id="contribute-changes-to-the-website">Contribute changes to the Website</h2> +<h2 id="test-a-release-candidate">Test a release candidate</h2> -<p>The website of Apache Flink is hosted in a separate Git repository. We suggest making a fork of the <a href="https://github.com/apache/flink-web";>flink-web GitHub mirror repository</a>.</p> +<p>Apache Flink is continuously improved by its active community. Every few weeks, we release a new version of Apache Flink with bug fixes, improvements, and new features. The process of releasing a new version consists of the following steps:</p> -<p>To make changes to the website, you have to checkout its source code first. The website resides in the <code>asf-site</code> branch of the repository:</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> +</ol> -<div class="highlight"><pre><code>git clone -b asf-site https://github.com/<your-user-name>/flink-web.git -cd flink-web -</code></pre></div> +<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> -<p>The <code>flink-web</code> directory contains the files that we use to build the website. We use <a href="http://jekyllrb.com/";>Jekyll</a> to generate static HTML files for the website.</p> +<hr /> -<h3 id="files-and-directories-in-the-website-git-repository">Files and Directories in the website git repository</h3> +<h2 id="contribute-code">Contribute code</h2> -<p>The files and directories in the website git repository have the following roles:</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 does also include instructions to setup a development environment, our coding guidelines and code style, and explains how to submit a code contribution.</p> -<ul> - <li>all files ending with <code>.md</code> are <a href="http://daringfireball.net/projects/markdown/";>Markdown</a> files. Those are the input for the HTML files.</li> - <li>regular directories (not starting with an underscore (<code>_</code>)) contain also <code>.md</code> files. The directory structure is also represented in the generated HTML files.</li> - <li>the <code>_posts</code> directory contains one Markdown file for each blog post on the website. To contribute a post, just add a new file there.</li> - <li>the <code>_includes/</code> directory contains includeable files such as the navigation bar or the footer.</li> - <li>the <code>docs/</code> directory contains copies of the documentation of Flink for different releases. There is a directory inside <code>docs/</code> for each stable release and the latest SNAPSHOT version. The build script is taking care of the maintenance of this directory.</li> - <li>the <code>content/</code> directory contains the generated HTML files from Jekyll. It is important to place the files in this directory since the Apache Infrastructure to host the Flink website is pulling the HTML content from his directory. (For committers: When pushing changes to the website repository, push also the updates in the <code>content/</code> directory!)</li> - <li>see the section below for the <code>build.sh</code> script.</li> -</ul> +<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> -<h3 id="the-buildsh-script">The <code>build.sh</code> script</h3> +<p>Please do also read the <a href="/how-to-contribute.html#submit-a-contributor-license-agreement">Submit a Contributor License Agreement</a> Section.</p> -<p>The <code>build.sh</code> script creates HTML files from the input Markdown files. Use the <code>-p</code> flag to let Jekyll serve a <strong>p</strong>review of the website on <code>http://localhost:4000/</code>.</p> +<h3 class="no_toc" id="looking-for-an-issue-to-work-on">Looking for an issue to work on?</h3> -<p>The build script also takes care of maintaining the <code>docs/</code> directory. Set the <code>-u</code> flag to <strong>u</strong>pdate documentation. This includes fetching the Flink git repository and copying different versions of the documentation.</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> -<h2 id="how-to-become-a-committer">How to become a committer</h2> +<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> -<p>There is no strict protocol for becoming a committer. Candidates for new committers are typically people that are active contributors and community members.</p> +<hr /> -<p>Being an active community member means participating on mailing list discussions, helping to answer questions, being respectful towards others, and following the meritocratic principles of community management. Since the âApache Wayâ has a strong focus on the project community, this part is very important.</p> +<h2 id="contribute-documentation">Contribute documentation</h2> -<p>Of course, contributing code to the project is important as well. A good way to start is contributing improvements, new features, or bugfixes. You need to show that you take responsibility for the code that you contribute, add tests/documentation, and help maintaining it.</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> -<p>Finally, candidates for new committers are suggested by current committers, mentors, or PMC members, and voted upon by the PMC.</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>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> -<h3 id="how-to-use-git-as-a-committer">How to use git as a committer</h3> +<hr /> -<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> +<h2 id="improve-the-website">Improve the website</h2> -<h4 id="main-source-repositories">Main source repositories</h4> +<p>The <a href="http://flink.apache.org";>Apache Flink website</a> presents Apache Flink and its community. It serves several purposes including:</p> -<p><strong>ASF writable</strong>: <code>https://git-wip-us.apache.org/repos/asf/flink.git</code></p> +<ul> + <li>Informing visitors about Apache Flink and its features.</li> + <li>Encouraging visitors to download and use Flink.</li> + <li>Encouraging visitors to engage with the community.</li> +</ul> -<p><strong>ASF read-only</strong>: <code>git://git.apache.org/repos/asf/flink.git</code></p> +<p>We welcome any contribution to improve our website.</p> -<p><strong>ASF read-only</strong>: <code>https://github.com/apache/flink.git</code></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 follow the <a href="/improve-website.html">Improve the website</a> guidelines if you would like to update and improve the website.</li> +</ul> -<p>Note: Flink does not build with Oracle JDK 6. It runs with Oracle JDK 6.</p> +<hr /> -<p>If you want to build for Hadoop 1, activate the build profile via <code>mvn clean package -DskipTests -Dhadoop.profile=1</code>.</p> +<h2 id="more-ways-to-contribute">More ways to contributeâ¦</h2> -<h4 id="website-repositories">Website repositories</h4> +<p>There are many more ways to contribute to the Flink community. For example you can</p> -<p><strong>ASF writable</strong>: <code>https://git-wip-us.apache.org/repos/asf/flink-web.git</code></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>â¦</li> +</ul> -<p><strong>ASF read-only</strong>: <code>git://git.apache.org/repos/asf/flink-web.git</code></p> +<hr /> -<p><strong>ASF read-only</strong>: <code>https://github.com/apache/flink-web.git</code></p> +<h2 id="submit-a-contributor-license-agreement">Submit a Contributor License Agreement</h2> -<p>Details on how to set the credentials for the ASF git repostiory are <a href="https://git-wip-us.apache.org/";>linked here</a>. -To merge pull requests from our Flink GitHub mirror, there is a script in the source <code>./tools/merge_pull_request.sh.template</code>. Rename it to <code>merge_pull_request.sh</code> with the appropriate settings and use it for merging.</p> +<p>Please submit a contributor license agreement to the Apache Software Foundation (ASF) if you would like to contribute to Apache Flink. The following quote from <a href="http://www.apache.org/licenses/#clas";>http://www.apache.org/licenses</a> gives more information about the ICLA and CCLA and why they are necessary.</p> -<h2 id="snapshots-nightly-builds">Snapshots (Nightly Builds)</h2> +<blockquote> + <p>The ASF desires that all contributors of ideas, code, or documentation to the Apache projects complete, sign, and submit (via postal mail, fax or email) an <a href="http://www.apache.org/licenses/icla.txt";>Individual Contributor License Agreement</a> (CLA) [ <a href="http://www.apache.org/licenses/icla.pdf";>PDF form</a> ]. The purpose of this agreement is to clearly define the terms under which intellectual property has been contributed to the ASF and thereby allow us to defend the project should there be a legal dispute regarding the software at some future time. A signed CLA is required to be on file before an individual is given commit rights to an ASF project.</p> -<p>Apache Flink <code>0.10-SNAPSHOT</code> is our latest development version.</p> + <p>For a corporation that has assigned employees to work on an Apache project, a <a href="http://www.apache.org/licenses/cla-corporate.txt";>Corporate CLA</a> (CCLA) is available for contributing intellectual property via the corporation, that may have been assigned as part of an employment agreement. Note that a Corporate CLA does not remove the need for every developer to sign their own CLA as an individual, to cover any of their contributions which are not owned by the corporation signing the CCLA.</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> + <p>â¦</p> +</blockquote> -<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> +<hr /> + +<h2 id="how-to-become-a-committer">How to become a committer</h2> + +<p>Committers are community members that have write access to the projectâs repositories, i.e., they can modify the code, documentation, and website by themselves and also accept other contributions. </p> + +<p>There is no strict protocol for becoming a committer. Candidates for new committers are typically people that are active contributors and community members.</p> + +<p>Being an active community member means participating on mailing list discussions, helping to answer questions, verifying release candidates, being respectful towards others, and following the meritocratic principles of community management. Since the âApache Wayâ has a strong focus on the project community, this part is <em>very</em> important.</p> + +<p>Of course, contributing code and documentation to the project is important as well. A good way to start is contributing improvements, new features, or bug fixes. You need to show that you take responsibility for the code that you contribute, add tests and documentation, and help maintaining it.</p> -<p>Add the <strong>Apache Snapshot repository</strong> to your Maven <code>pom.xml</code>:</p> +<p>Candidates for new committers are suggested by current committers or PMC members, and voted upon by the PMC. </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>If you would like to become a committer, you should engage with the community and start contributing to Apache Flink in any of the above ways. You might also want to talk to other committers and ask for their advice and guidance.</p> -<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> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/improve-website.html ---------------------------------------------------------------------- diff --git a/content/improve-website.html b/content/improve-website.html new file mode 100644 index 0000000..0e99bce --- /dev/null +++ b/content/improve-website.html @@ -0,0 +1,290 @@ +<!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: Improving the Website</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>Improving the Website</h1></div> + </div> + +<p>The <a href="http://flink.apache.org";>Apache Flink website</a> presents Apache Flink and its community. It serves several purposes including:</p> + +<ul> + <li>Informing visitors about Apache Flink and its features.</li> + <li>Encouraging visitors to download and use Flink.</li> + <li>Encouraging visitors to engage with the community.</li> +</ul> + +<p>We welcome any contribution to improve our website. This document contains all information that is necessary to improve Flinkâs website.</p> + +<div class="page-toc"> +<ul id="markdown-toc"> + <li><a href="#obtain-the-website-sources">Obtain the website sources</a></li> + <li><a href="#directory-structure-and-files">Directory structure and files</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> + <li><a href="#committer-section">Committer section</a></li> +</ul> + +</div> + +<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 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> + +<div class="highlight"><pre><code>git clone https://github.com/<your-user-name>/flink-web.git +</code></pre></div> + +<p>The <code>flink-web</code> directory contains the cloned repository. The website resides in the <code>asf-site</code> branch of the repository. Run the following commands to enter the directory and switch to the <code>asf-site</code> branch.</p> + +<div class="highlight"><pre><code>cd flink-web +git checkout asf-site +</code></pre></div> + +<h2 id="directory-structure-and-files">Directory structure and files</h2> + +<p>Flinkâs website is written in <a href="http://daringfireball.net/projects/markdown/";>Markdown</a>. Markdown is a lightweight markup language which can be translated to HTML. We use <a href="http://jekyllrb.com/";>Jekyll</a> to generate static HTML files from Markdown.</p> + +<p>The files and directories in the website git repository have the following roles:</p> + +<ul> + <li>All files ending with <code>.md</code> are Markdown files. These files are translated into static HTML files.</li> + <li>Regular directories (not starting with an underscore (<code>_</code>)) contain also <code>.md</code> files. The directory structure is reflected in the generated HTML files and the published website.</li> + <li>The <code>_posts</code> directory contains blog posts. Each blog post is written as one Markdown file. To contribute a post, add a new file there.</li> + <li>The <code>_includes/</code> directory contains includeable files such as the navigation bar or the footer.</li> + <li>The <code>docs/</code> directory contains copies of the documentation of Flink for different releases. There is a directory inside <code>docs/</code> for each stable release and the latest SNAPSHOT version. The build script is taking care of the maintenance of this directory.</li> + <li>The <code>content/</code> directory contains the generated HTML files from Jekyll. It is important to place the files in this directory since the Apache Infrastructure to host the Flink website is pulling the HTML content from his directory. (For committers: When pushing changes to the website git, push also the updates in the <code>content/</code> directory!)</li> +</ul> + +<h2 id="update-or-extend-the-documentation">Update or extend the documentation</h2> + +<p>You can update and extend the website by modifying or adding Markdown files or any other resources such as CSS files. To verify your changes start the build script in preview mode.</p> + +<div class="highlight"><pre><code>./build.sh -p +</code></pre></div> + +<p>The script compiles the Markdown files into HTML and starts a local webserver. Open your browser at <code>http://localhost:4000</code> to view the website including your changes. The served website is automatically re-compiled and updated when you modify and save any file 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 website contributions through the <a href="https://github.com/apache/flink-web";>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. <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><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-web</code>) and use the âCreate Pull Requestâ button to start creating a pull request. Make sure that the base fork is <code>apache/flink-web asf-site</code> and the head fork selects the branch with your changes. Give the pull request a meaningful description and submit it.</p> + </li> +</ol> + +<h2 id="committer-section">Committer section</h2> + +<p><strong>This section is only relevant for committers.</strong></p> + +<h3 class="no_toc" id="asf-website-git-repositories">ASF website git repositories</h3> + +<p><strong>ASF writable</strong>: https://git-wip-us.apache.org/repos/asf/flink-web.git</p> + +<p><strong>ASF read-only</strong>: git://git.apache.org/repos/asf/flink-web.git</p> + +<p>Details on how to set the credentials for the ASF git repository are <a href="https://git-wip-us.apache.org/";>linked here</a>.</p> + +<h3 class="no_toc" id="merging-a-pull-request">Merging a pull request</h3> + +<p>Contributions are expected to be done on the source files only (no modifications on the compiled files in the <code>content/</code> directory.). Before pushing a website change, please run the build script</p> + +<div class="highlight"><pre><code>./build.sh +</code></pre></div> + +<p>add the changes to the <code>content/</code> directory as an additional commit and push the changes to the ASF base repository.</p> + +<h3 class="no_toc" id="updating-the-documentation-directory">Updating the documentation directory</h3> + +<p>The build script does also take care of maintaining the <code>docs/</code> directory. Set the <code>-u</code> flag to update documentation. This includes fetching the Flink git repository and copying different versions of the documentation.</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/index.html ---------------------------------------------------------------------- diff --git a/content/index.html b/content/index.html index 3e04686..f2dd572 100644 --- a/content/index.html +++ b/content/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/material.html ---------------------------------------------------------------------- diff --git a/content/material.html b/content/material.html index 582cb4c..1af83cd 100644 --- a/content/material.html +++ b/content/material.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> @@ -145,14 +147,14 @@ <div class="page-toc"> <ul id="markdown-toc"> - <li><a href="#apache-flink-logos" id="markdown-toc-apache-flink-logos">Apache Flink Logos</a> <ul> - <li><a href="#portable-network-graphics-png" id="markdown-toc-portable-network-graphics-png">Portable Network Graphics (PNG)</a></li> - <li><a href="#scalable-vector-graphics-svg" id="markdown-toc-scalable-vector-graphics-svg">Scalable Vector Graphics (SVG)</a></li> - <li><a href="#photoshop-psd" id="markdown-toc-photoshop-psd">Photoshop (PSD)</a></li> + <li><a href="#apache-flink-logos">Apache Flink Logos</a> <ul> + <li><a href="#portable-network-graphics-png">Portable Network Graphics (PNG)</a></li> + <li><a href="#scalable-vector-graphics-svg">Scalable Vector Graphics (SVG)</a></li> + <li><a href="#photoshop-psd">Photoshop (PSD)</a></li> </ul> </li> - <li><a href="#color-scheme" id="markdown-toc-color-scheme">Color Scheme</a></li> - <li><a href="#slides" id="markdown-toc-slides">Slides</a></li> + <li><a href="#color-scheme">Color Scheme</a></li> + <li><a href="#slides">Slides</a></li> </ul> </div> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/news/2012/08/21/release02.html ---------------------------------------------------------------------- diff --git a/content/news/2012/08/21/release02.html b/content/news/2012/08/21/release02.html index 0cf23c6..7ec8fdf 100644 --- a/content/news/2012/08/21/release02.html +++ b/content/news/2012/08/21/release02.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/news/2012/10/15/icde2013.html ---------------------------------------------------------------------- diff --git a/content/news/2012/10/15/icde2013.html b/content/news/2012/10/15/icde2013.html index 89f16c9..387fe05 100644 --- a/content/news/2012/10/15/icde2013.html +++ b/content/news/2012/10/15/icde2013.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/news/2012/11/12/btw2013demo.html ---------------------------------------------------------------------- diff --git a/content/news/2012/11/12/btw2013demo.html b/content/news/2012/11/12/btw2013demo.html index 6ac3a9f..3b2f7ec 100644 --- a/content/news/2012/11/12/btw2013demo.html +++ b/content/news/2012/11/12/btw2013demo.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/news/2012/11/21/previewICDE2013.html ---------------------------------------------------------------------- diff --git a/content/news/2012/11/21/previewICDE2013.html b/content/news/2012/11/21/previewICDE2013.html index 91b71b3..9ff5a3e 100644 --- a/content/news/2012/11/21/previewICDE2013.html +++ b/content/news/2012/11/21/previewICDE2013.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/news/2013/03/27/www-demo-paper.html ---------------------------------------------------------------------- diff --git a/content/news/2013/03/27/www-demo-paper.html b/content/news/2013/03/27/www-demo-paper.html index e340937..392ccc5 100644 --- a/content/news/2013/03/27/www-demo-paper.html +++ b/content/news/2013/03/27/www-demo-paper.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/news/2013/10/21/cikm2013-paper.html ---------------------------------------------------------------------- diff --git a/content/news/2013/10/21/cikm2013-paper.html b/content/news/2013/10/21/cikm2013-paper.html index 58be4c0..9ec66c4 100644 --- a/content/news/2013/10/21/cikm2013-paper.html +++ b/content/news/2013/10/21/cikm2013-paper.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/news/2013/12/13/humboldt-innovation-award.html ---------------------------------------------------------------------- diff --git a/content/news/2013/12/13/humboldt-innovation-award.html b/content/news/2013/12/13/humboldt-innovation-award.html index 4258fb5..f19a6f5 100644 --- a/content/news/2013/12/13/humboldt-innovation-award.html +++ b/content/news/2013/12/13/humboldt-innovation-award.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/news/2014/01/10/stratosphere-hadoop-summit.html ---------------------------------------------------------------------- diff --git a/content/news/2014/01/10/stratosphere-hadoop-summit.html b/content/news/2014/01/10/stratosphere-hadoop-summit.html index 4bcbc2c..83d8555 100644 --- a/content/news/2014/01/10/stratosphere-hadoop-summit.html +++ b/content/news/2014/01/10/stratosphere-hadoop-summit.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/news/2014/01/12/0.4-migration-guide.html ---------------------------------------------------------------------- diff --git a/content/news/2014/01/12/0.4-migration-guide.html b/content/news/2014/01/12/0.4-migration-guide.html index 56fabaa..c53c425 100644 --- a/content/news/2014/01/12/0.4-migration-guide.html +++ b/content/news/2014/01/12/0.4-migration-guide.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/news/2014/01/13/stratosphere-release-0.4.html ---------------------------------------------------------------------- diff --git a/content/news/2014/01/13/stratosphere-release-0.4.html b/content/news/2014/01/13/stratosphere-release-0.4.html index a518834..2f86bfe 100644 --- a/content/news/2014/01/13/stratosphere-release-0.4.html +++ b/content/news/2014/01/13/stratosphere-release-0.4.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> @@ -145,7 +147,7 @@ <article> <p>13 Jan 2014</p> -<p>We are pleased to announce that version 0.4 of the Stratosphere system has been released.</p> +<p>We are pleased to announce that version 0.4 of the Stratosphere system has been released. </p> <p>Our team has been working hard during the last few months to create an improved and stable Stratosphere version. The new version comes with many new features, usability and performance improvements in all levels, including a new Scala API for the concise specification of programs, a Pregel-like API, support for Yarn clusters, and major performance improvements. The system features now first-class support for iterative programs and thus covers traditional analytical use cases as well as data mining and graph processing use cases with great performance.</p> @@ -173,7 +175,7 @@ Follow <a href="/docs/0.4/setup/yarn.html">our guide</a> on how to start a Strat <p>The high-level language Meteor now natively serializes JSON trees for greater performance and offers additional operators and file formats. We greatly empowered the user to write crispier scripts by adding second-order functions, multi-output operators, and other syntactical sugar. For developers of Meteor packages, the API is much more comprehensive and allows to define custom data types that can be easily embedded in JSON trees through ad-hoc byte code generation.</p> <h3 id="spargel-pregel-inspired-graph-processing">Spargel: Pregel Inspired Graph Processing</h3> -<p>Spargel is a vertex-centric API similar to the interface proposed in Googleâs Pregel paper and implemented in Apache Giraph. Spargel is implemented in 500 lines of code (including comments) on top of Stratosphereâs delta iterations feature. This confirms the flexibility of Stratosphereâs architecture.</p> +<p>Spargel is a vertex-centric API similar to the interface proposed in Googleâs Pregel paper and implemented in Apache Giraph. Spargel is implemented in 500 lines of code (including comments) on top of Stratosphereâs delta iterations feature. This confirms the flexibility of Stratosphereâs architecture. </p> <h3 id="web-frontend">Web Frontend</h3> <p>Using the new web frontend, you can monitor the progress of Stratosphere jobs. For finished jobs, the frontend shows a breakdown of the execution times for each operator. The webclient also visualizes the execution strategies chosen by the optimizer.</p> @@ -201,7 +203,7 @@ Follow <a href="/docs/0.4/setup/yarn.html">our guide</a> on how to start a Strat </ul> <h3 id="download-and-get-started-with-stratosphere-v04">Download and get started with Stratosphere v0.4</h3> -<p>There are several options for getting started with Stratosphere.</p> +<p>There are several options for getting started with Stratosphere. </p> <ul> <li>Download it on the <a href="/downloads">download page</a></li> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/news/2014/01/26/optimizer_plan_visualization_tool.html ---------------------------------------------------------------------- diff --git a/content/news/2014/01/26/optimizer_plan_visualization_tool.html b/content/news/2014/01/26/optimizer_plan_visualization_tool.html index 2004a46..f050f4a 100644 --- a/content/news/2014/01/26/optimizer_plan_visualization_tool.html +++ b/content/news/2014/01/26/optimizer_plan_visualization_tool.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/news/2014/01/28/querying_mongodb.html ---------------------------------------------------------------------- diff --git a/content/news/2014/01/28/querying_mongodb.html b/content/news/2014/01/28/querying_mongodb.html index 5ad57bd..032ef83 100644 --- a/content/news/2014/01/28/querying_mongodb.html +++ b/content/news/2014/01/28/querying_mongodb.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/news/2014/02/18/amazon-elastic-mapreduce-cloud-yarn.html ---------------------------------------------------------------------- diff --git a/content/news/2014/02/18/amazon-elastic-mapreduce-cloud-yarn.html b/content/news/2014/02/18/amazon-elastic-mapreduce-cloud-yarn.html index f34ec53..fe528fc 100644 --- a/content/news/2014/02/18/amazon-elastic-mapreduce-cloud-yarn.html +++ b/content/news/2014/02/18/amazon-elastic-mapreduce-cloud-yarn.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> @@ -215,7 +217,7 @@ ssh [email protected] -i ~/Downloads/work-laptop.pem</code></pre></div> <p>(Windows users have to follow <a href="http://docs.aws.amazon.com/ElasticMapReduce/latest/DeveloperGuide/emr-connect-master-node-ssh.html";>these instructions</a> to SSH into the machine running the master.) </br></br> -Once connected to the master, download and start Stratosphere for YARN:</p> +Once connected to the master, download and start Stratosphere for YARN: </p> <ul> <li>Download and extract Stratosphere-YARN</li> @@ -238,11 +240,11 @@ The arguments have the following meaning </ul> </ul> -<p>Once the output has changed from</p> +<p>Once the output has changed from </p> <div class="highlight"><pre><code class="language-bash" data-lang="bash">JobManager is now running on N/A:6123</code></pre></div> -<p>to</p> +<p>to </p> <div class="highlight"><pre><code class="language-bash" data-lang="bash">JobManager is now running on ip-172-31-13-68.us-west-2.compute.internal:6123</code></pre></div> http://git-wip-us.apache.org/repos/asf/flink-web/blob/415ee891/content/news/2014/02/24/stratosphere-google-summer-of-code-2014.html ---------------------------------------------------------------------- diff --git a/content/news/2014/02/24/stratosphere-google-summer-of-code-2014.html b/content/news/2014/02/24/stratosphere-google-summer-of-code-2014.html index 337808d..bd55996 100644 --- a/content/news/2014/02/24/stratosphere-google-summer-of-code-2014.html +++ b/content/news/2014/02/24/stratosphere-google-summer-of-code-2014.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/news/2014/04/16/stratosphere-goes-apache-incubator.html ---------------------------------------------------------------------- diff --git a/content/news/2014/04/16/stratosphere-goes-apache-incubator.html b/content/news/2014/04/16/stratosphere-goes-apache-incubator.html index f921cb4..6c3c696 100644 --- a/content/news/2014/04/16/stratosphere-goes-apache-incubator.html +++ b/content/news/2014/04/16/stratosphere-goes-apache-incubator.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/news/2014/05/31/release-0.5.html ---------------------------------------------------------------------- diff --git a/content/news/2014/05/31/release-0.5.html b/content/news/2014/05/31/release-0.5.html index f8d7480..98b2c7d 100644 --- a/content/news/2014/05/31/release-0.5.html +++ b/content/news/2014/05/31/release-0.5.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/news/2014/08/26/release-0.6.html ---------------------------------------------------------------------- diff --git a/content/news/2014/08/26/release-0.6.html b/content/news/2014/08/26/release-0.6.html index d985ac1..55c0598 100644 --- a/content/news/2014/08/26/release-0.6.html +++ b/content/news/2014/08/26/release-0.6.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/news/2014/09/26/release-0.6.1.html ---------------------------------------------------------------------- diff --git a/content/news/2014/09/26/release-0.6.1.html b/content/news/2014/09/26/release-0.6.1.html index a0175e7..801af9f 100644 --- a/content/news/2014/09/26/release-0.6.1.html +++ b/content/news/2014/09/26/release-0.6.1.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/news/2014/10/03/upcoming_events.html ---------------------------------------------------------------------- diff --git a/content/news/2014/10/03/upcoming_events.html b/content/news/2014/10/03/upcoming_events.html index 1326db6..2fc7d73 100644 --- a/content/news/2014/10/03/upcoming_events.html +++ b/content/news/2014/10/03/upcoming_events.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/news/2014/11/04/release-0.7.0.html ---------------------------------------------------------------------- diff --git a/content/news/2014/11/04/release-0.7.0.html b/content/news/2014/11/04/release-0.7.0.html index e2e4cd7..22b035b 100644 --- a/content/news/2014/11/04/release-0.7.0.html +++ b/content/news/2014/11/04/release-0.7.0.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> @@ -165,7 +167,7 @@ <p><strong>Record API deprecated:</strong> The (old) Stratosphere Record API has been marked as deprecated and is planned for removal in the 0.9.0 release.</p> -<p><strong>BLOB service:</strong> This release contains a new service to distribute jar files and other binary data among the JobManager, TaskManagers and the client.</p> +<p><strong>BLOB service:</strong> This release contains a new service to distribute jar files and other binary data among the JobManager, TaskManagers and the client. </p> <p><strong>Intermediate data sets:</strong> A major rewrite of the system internals introduces intermediate data sets as first class citizens. The internal state machine that tracks the distributed tasks has also been completely rewritten for scalability. While this is not visible as a user-facing feature yet, it is the foundation for several upcoming exciting features.</p>
