Regenerate website
Project: http://git-wip-us.apache.org/repos/asf/beam-site/repo Commit: http://git-wip-us.apache.org/repos/asf/beam-site/commit/bb97dd38 Tree: http://git-wip-us.apache.org/repos/asf/beam-site/tree/bb97dd38 Diff: http://git-wip-us.apache.org/repos/asf/beam-site/diff/bb97dd38 Branch: refs/heads/asf-site Commit: bb97dd381e7420ce08580770ddb0580b467b37c7 Parents: 578e1ac Author: Davor Bonaci <[email protected]> Authored: Mon Jan 9 18:03:28 2017 -0800 Committer: Davor Bonaci <[email protected]> Committed: Mon Jan 9 18:03:28 2017 -0800 ---------------------------------------------------------------------- .../contribute/contribution-guide/index.html | 36 ++++++++++---------- content/contribute/testing/index.html | 9 +++-- 2 files changed, 22 insertions(+), 23 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/beam-site/blob/bb97dd38/content/contribute/contribution-guide/index.html ---------------------------------------------------------------------- diff --git a/content/contribute/contribution-guide/index.html b/content/contribute/contribution-guide/index.html index 1c77574..667bc8a 100644 --- a/content/contribute/contribution-guide/index.html +++ b/content/contribute/contribution-guide/index.html @@ -149,7 +149,7 @@ <ul id="markdown-toc"> <li><a href="#engage" id="markdown-toc-engage">Engage</a> <ul> <li><a href="#mailing-lists" id="markdown-toc-mailing-lists">Mailing list(s)</a></li> - <li><a href="#apache-jira" id="markdown-toc-apache-jira">Apache JIRA</a></li> + <li><a href="#jira-issue-tracker" id="markdown-toc-jira-issue-tracker">JIRA issue tracker</a></li> </ul> </li> <li><a href="#design" id="markdown-toc-design">Design</a></li> @@ -207,7 +207,7 @@ </li> </ul> -<p>The Apache Beam community welcomes contributions from anyone with a passion for data processing! Beam has many different opportunities for contributions â write new examples, add new user-facing libraries (new statistical libraries, new IO connectors, etc), work on the core programming model, build specific runners (Apache Flink, Apache Spark, Google Cloud Dataflow, etc), or participate on the documentation effort.</p> +<p>The Apache Beam community welcomes contributions from anyone with a passion for data processing! Beam has many different opportunities for contributions â write new examples, add new user-facing libraries (new statistical libraries, new IO connectors, etc), work on the core programming model, build specific runners (Apache Apex, Apache Flink, Apache Spark, Google Cloud Dataflow, etc), or participate on the documentation effort.</p> <p>We use a review-then-commit workflow in Beam for all contributions.</p> @@ -233,12 +233,12 @@ <h2 id="engage">Engage</h2> <h3 id="mailing-lists">Mailing list(s)</h3> -<p>We discuss design and implementation issues on [email protected] mailing list, which is archived <a href="https://lists.apache.org/[email protected]";>here</a>. Join by emailing <a href="mailto:[email protected]";><code class="highlighter-rouge">[email protected]</code></a>.</p> +<p>We discuss design and implementation issues on the [email protected] mailing list, which is archived <a href="https://lists.apache.org/[email protected]";>here</a>. Join by emailing <a href="mailto:[email protected]";><code class="highlighter-rouge">[email protected]</code></a>.</p> -<p>If interested, you can also join the other <a href="/use/mailing-lists/">mailing lists</a> too.</p> +<p>If interested, you can also join the other <a href="/use/mailing-lists/">mailing lists</a>.</p> -<h3 id="apache-jira">Apache JIRA</h3> -<p>We use <a href="https://issues.apache.org/jira/browse/BEAM";>Apache JIRA</a> as an issue tracking and project management tool, as well as a way to communicate among a very diverse and distributed set of contributors. To be able to gather feedback, avoid frustration, and avoid duplicated efforts all Beam-related work should be tracked there.</p> +<h3 id="jira-issue-tracker">JIRA issue tracker</h3> +<p>We use the Apache Software Foundationâs <a href="https://issues.apache.org/jira/browse/BEAM";>JIRA</a> as an issue tracking and project management tool, as well as a way to communicate among a very diverse and distributed set of contributors. To be able to gather feedback, avoid frustration, and avoid duplicated efforts all Beam-related work should be tracked there.</p> <p>If you do not already have an Apache JIRA account, sign up <a href="https://issues.apache.org/jira/";>here</a>.</p> @@ -264,7 +264,7 @@ <h4 id="potentially-submit-contributor-license-agreement">[Potentially] Submit Contributor License Agreement</h4> <p>Apache Software Foundation (ASF) desires that all contributors of ideas, code, or documentation to the Apache projects complete, sign, and submit an <a href="https://www.apache.org/licenses/icla.txt";>Individual Contributor License Agreement</a> (ICLA). 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.</p> -<p>We require you to have an ICLA on file with the Apache Secretary for larger contributions only. For smaller ones, however, we rely on <a href="http://www.apache.org/licenses/LICENSE-2.0#contributions";>clause five</a> of the Apache License, Version 2.0, describing licensing of intentionally submitted contributions and do not require an ICLA in that case.</p> +<p>We require you to have an ICLA on file with the Apache Secretary for larger contributions only. For smaller ones, however, we rely on <a href="http://www.apache.org/licenses/LICENSE-2.0#contributions";>clause five</a> of the Apache License, Version 2.0, describing licensing of intentionally submitted contributions and do not require an ICLA in that case.</p> <h4 id="obtain-a-github-account">Obtain a GitHub account</h4> <p>We use GitHubâs pull request functionality to review proposed code changes.</p> @@ -284,7 +284,7 @@ <p>Clone Beamâs read-only GitHub mirror.</p> <div class="highlighter-rouge"><pre class="highlight"><code>$ git clone https://github.com/apache/beam.git -$ cd incubator-beam +$ cd beam </code></pre> </div> @@ -361,7 +361,7 @@ Start eclipse with a fresh workspace in a separate directory from your checkout. <ol> <li> - <p>Install m2e-apt: Beam uses apt annotation processing to provide auto generated code. One example is the usage of <a href="https://github.com/google/auto/tree/master/value";>google auto value</a>. By default m2e does not support this and you will see compile errors.</p> + <p>Install m2e-apt: Beam uses apt annotation processing to provide auto generated code. One example is the usage of <a href="https://github.com/google/auto/tree/master/value";>Google AutoValue</a>. By default m2e does not support this and you will see compile errors.</p> <p>Help -> Eclipse Marketplace @@ -384,7 +384,7 @@ Start eclipse with a fresh workspace in a separate directory from your checkout. <p>File -> Import⦠-> Existing Maven Projects - -> Browse to the directory you cloned into and select incubator-beam + -> Browse to the directory you cloned into and select âbeamâ -> make sure all beam projects are selected -> Finalize</p> </li> @@ -413,7 +413,7 @@ $ git checkout -b <my-branch> origin/master <p>To push your local, committed changes to your (forked) repository on GitHub, run:</p> -<div class="highlighter-rouge"><pre class="highlight"><code>$ git push <GitHub_user> <my-branch> +<div class="highlighter-rouge"><pre class="highlight"><code>$ git push <GitHub_user> <my-branch> </code></pre> </div> @@ -569,7 +569,7 @@ $ git merge --no-ff \ </code></pre> </div> -<p>Done. You can delete the local <code>finish-pr-<pull-request-#></code> branch if you like.</p> +<p>Done. You can delete the local <code class="highlighter-rouge">finish-pr-<pull-request-#></code> branch if you like.</p> <h2 id="granting-more-rights-to-a-contributor">Granting more rights to a contributor</h2> @@ -586,7 +586,7 @@ evaluates the overall impact across all the dimensions above.</p> <h2 id="special-cases">Special Cases</h2> -<p>The directions above assume you are submitting code to the <code class="highlighter-rouge">incubator-beam</code> repositoryâs <code class="highlighter-rouge">master</code> branch. In addition, there are a few other locations where code is maintained. Generally these follow the same <em>engage</em>-<em>design</em>-<strong>code</strong>-<strong>review</strong>-<strong>commit</strong> process as above, with some minor adjustments to commands.</p> +<p>The directions above assume you are submitting code to the <code class="highlighter-rouge">beam</code> repositoryâs <code class="highlighter-rouge">master</code> branch. In addition, there are a few other locations where code is maintained. Generally these follow the same <em>engage</em>-<em>design</em>-<strong>code</strong>-<strong>review</strong>-<strong>commit</strong> process as above, with some minor adjustments to commands.</p> <h3 id="feature-branches">Feature Branches</h3> @@ -650,11 +650,11 @@ fixing, then those should get a full review from another committer.</p> <p>The <a href="https://github.com/apache/beam-site/blob/asf-site/README.md";>README file</a> in the website repository has more information on how to set up the required dependencies for your development environment.</p> -<p>The general guidelines for cloning a repository can be adjusted to use the <code class="highlighter-rouge">asf-site</code> branch of <code class="highlighter-rouge">incubator-beam-site</code>:</p> +<p>The general guidelines for cloning a repository can be adjusted to use the <code class="highlighter-rouge">asf-site</code> branch of <code class="highlighter-rouge">beam-site</code>:</p> <div class="highlighter-rouge"><pre class="highlight"><code>$ git clone -b asf-site https://github.com/apache/beam-site.git -$ cd incubator-beam-site -$ git remote add <GitHub_user> [email protected]:<GitHub_user>/incubator-beam-site.git +$ cd beam-site +$ git remote add <GitHub_user> [email protected]:<GitHub_user>/beam-site.git $ git fetch --all $ git checkout -b <my-branch> origin/asf-site </code></pre> @@ -688,9 +688,9 @@ $ git checkout -b <my-branch> origin/asf-site <h4 id="committing-website-changes">Committing website changes</h4> -<p>Follow the same committer process as above, but using <code class="highlighter-rouge">incubator-beam-site</code> and <code class="highlighter-rouge">asf-site</code>.</p> +<p>Follow the same committer process as above, but using repository <code class="highlighter-rouge">apache/beam-site</code> and branch <code class="highlighter-rouge">asf-site</code>.</p> -<p>In addition, the committer is responsible for doing the final <code class="highlighter-rouge">jekyll build</code> to generate the static content, so follow the instructions above to install jekyll.</p> +<p>In addition, the committer is responsible for doing the final <code class="highlighter-rouge">jekyll build</code> to generate the static content, so follow the instructions above to install <code class="highlighter-rouge">jekyll</code>.</p> </div> http://git-wip-us.apache.org/repos/asf/beam-site/blob/bb97dd38/content/contribute/testing/index.html ---------------------------------------------------------------------- diff --git a/content/contribute/testing/index.html b/content/contribute/testing/index.html index 5daa4eb..ae785e7 100644 --- a/content/contribute/testing/index.html +++ b/content/contribute/testing/index.html @@ -406,7 +406,7 @@ details on those testing types.</p> <h3 id="python-sdk">Python SDK</h3> <p>The Python SDK is currently under development on a feature branch. We have initial -postcommit tests by a Jenkins build; precommit testing and a full testing +postcommit tests by a Jenkins build; precommit testing and a full testing matrix will be coming soon.</p> <h2 id="testing-scenarios">Testing Scenarios</h2> @@ -419,8 +419,8 @@ precommit and postcommit testing.</p> <p>For precommit testing, Beam uses <a href="https://builds.apache.org/view/Beam/";>Jenkins</a>, -<a href="http://travis-ci.org/apache/incubator-beam";>Travis</a>, and a code coverage tool -called <a href="https://coveralls.io/github/apache/incubator-beam";>Coveralls</a>, hooked up +<a href="http://travis-ci.org/apache/beam";>Travis</a>, and a code coverage tool +called <a href="https://coveralls.io/github/apache/beam";>Coveralls</a>, hooked up to <a href="https://github.com/apache/beam";>Github</a>, to ensure that pull requests meet a certain quality bar. These precommits verify correctness via two of the below testing tools: unit tests (with coverage monitored by Coveralls) @@ -433,7 +433,7 @@ that this hits the appropriate tradeoff between a desire for short (ideally function in the way in which they are intended.</p> <p>Precommit tests are kicked off when a user makes a Pull Request against the -apache/incubator-beam repository and the Travis, Jenkins, and Coveralls statuses +<code class="highlighter-rouge">apache/beam</code> repository and the Travis, Jenkins, and Coveralls statuses are displayed at the bottom of the pull request page. Clicking on âDetailsâ will open the status page in the selected tool; there, test status and output can be viewed.</p> @@ -536,7 +536,6 @@ which enables test authors to write simple functionality verification. They are meant to use some of the built-in utilities of the SDK, namely PAssert, to verify that the simple pipelines they run end in the correct state.</p> - </div>
