Regenerate html.
Project: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/commit/61d87859 Tree: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/tree/61d87859 Diff: http://git-wip-us.apache.org/repos/asf/incubator-beam-site/diff/61d87859 Branch: refs/heads/asf-site Commit: 61d8785939ec55834d175c67a0fd07da951567b7 Parents: c765b7e Author: Frances Perry <f...@google.com> Authored: Tue Oct 18 21:00:27 2016 -0700 Committer: Frances Perry <f...@google.com> Committed: Tue Oct 18 21:03:35 2016 -0700 ---------------------------------------------------------------------- .../2016/03/17/capability-matrix.html | 6 +- .../2016/04/03/presentation-materials.html | 6 +- .../sdk/2016/02/25/python-sdk-now-public.html | 6 +- .../beam/release/2016/06/15/first-release.html | 6 +- .../10/11/strata-hadoop-world-and-beam.html | 6 +- .../website/2016/02/22/beam-has-a-logo.html | 6 +- .../blog/2016/05/18/splitAtFraction-method.html | 6 +- .../05/27/where-is-my-pcollection-dot-map.html | 6 +- .../06/13/flink-batch-runner-milestone.html | 6 +- content/blog/2016/08/03/six-months.html | 6 +- content/blog/index.html | 6 +- content/coming-soon.html | 6 +- .../contribute/contribution-guide/index.html | 272 +++++++++++++------ content/contribute/design-principles/index.html | 233 ++++++++++++++++ content/contribute/index.html | 6 +- content/contribute/source-repository/index.html | 6 +- content/contribute/testing/index.html | 49 ++-- content/contribute/work-in-progress/index.html | 222 +++++++++++++++ content/feed.xml | 4 +- content/index.html | 6 +- content/learn/index.html | 6 +- content/learn/presentation-materials/index.html | 6 +- content/learn/programming-guide/index.html | 6 +- content/learn/resources/index.html | 6 +- .../learn/runners/capability-matrix/index.html | 8 +- content/learn/runners/dataflow/index.html | 6 +- content/learn/runners/direct/index.html | 6 +- content/learn/runners/flink/index.html | 6 +- content/learn/runners/index.html | 6 +- content/learn/runners/spark/index.html | 6 +- content/learn/sdks/index.html | 6 +- content/learn/sdks/java/index.html | 6 +- content/learn/sdks/javadoc/index.html | 6 +- content/privacy_policy/index.html | 6 +- content/project/logos/index.html | 6 +- content/project/public-meetings/index.html | 6 +- content/project/team/index.html | 6 +- content/use/beam-overview/index.html | 6 +- content/use/index.html | 6 +- content/use/issue-tracking/index.html | 6 +- content/use/mailing-lists/index.html | 39 +-- content/use/quickstart/index.html | 6 +- content/use/releases/index.html | 6 +- content/use/walkthroughs/index.html | 6 +- 44 files changed, 841 insertions(+), 208 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/beam/capability/2016/03/17/capability-matrix.html ---------------------------------------------------------------------- diff --git a/content/beam/capability/2016/03/17/capability-matrix.html b/content/beam/capability/2016/03/17/capability-matrix.html index cbf07e3..60513d1 100644 --- a/content/beam/capability/2016/03/17/capability-matrix.html +++ b/content/beam/capability/2016/03/17/capability-matrix.html @@ -96,12 +96,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/beam/capability/2016/04/03/presentation-materials.html ---------------------------------------------------------------------- diff --git a/content/beam/capability/2016/04/03/presentation-materials.html b/content/beam/capability/2016/04/03/presentation-materials.html index 6cc61f9..775b6fd 100644 --- a/content/beam/capability/2016/04/03/presentation-materials.html +++ b/content/beam/capability/2016/04/03/presentation-materials.html @@ -96,12 +96,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/beam/python/sdk/2016/02/25/python-sdk-now-public.html ---------------------------------------------------------------------- diff --git a/content/beam/python/sdk/2016/02/25/python-sdk-now-public.html b/content/beam/python/sdk/2016/02/25/python-sdk-now-public.html index a8d2f9e..d78f34c 100644 --- a/content/beam/python/sdk/2016/02/25/python-sdk-now-public.html +++ b/content/beam/python/sdk/2016/02/25/python-sdk-now-public.html @@ -96,12 +96,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/beam/release/2016/06/15/first-release.html ---------------------------------------------------------------------- diff --git a/content/beam/release/2016/06/15/first-release.html b/content/beam/release/2016/06/15/first-release.html index 3774073..1eb58b9 100644 --- a/content/beam/release/2016/06/15/first-release.html +++ b/content/beam/release/2016/06/15/first-release.html @@ -96,12 +96,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/beam/update/2016/10/11/strata-hadoop-world-and-beam.html ---------------------------------------------------------------------- diff --git a/content/beam/update/2016/10/11/strata-hadoop-world-and-beam.html b/content/beam/update/2016/10/11/strata-hadoop-world-and-beam.html index d402fa2..46f91d2 100644 --- a/content/beam/update/2016/10/11/strata-hadoop-world-and-beam.html +++ b/content/beam/update/2016/10/11/strata-hadoop-world-and-beam.html @@ -96,12 +96,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/beam/update/website/2016/02/22/beam-has-a-logo.html ---------------------------------------------------------------------- diff --git a/content/beam/update/website/2016/02/22/beam-has-a-logo.html b/content/beam/update/website/2016/02/22/beam-has-a-logo.html index 8c0ebc4..233fd09 100644 --- a/content/beam/update/website/2016/02/22/beam-has-a-logo.html +++ b/content/beam/update/website/2016/02/22/beam-has-a-logo.html @@ -96,12 +96,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/blog/2016/05/18/splitAtFraction-method.html ---------------------------------------------------------------------- diff --git a/content/blog/2016/05/18/splitAtFraction-method.html b/content/blog/2016/05/18/splitAtFraction-method.html index d485db6..e0f06ca 100644 --- a/content/blog/2016/05/18/splitAtFraction-method.html +++ b/content/blog/2016/05/18/splitAtFraction-method.html @@ -96,12 +96,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/blog/2016/05/27/where-is-my-pcollection-dot-map.html ---------------------------------------------------------------------- diff --git a/content/blog/2016/05/27/where-is-my-pcollection-dot-map.html b/content/blog/2016/05/27/where-is-my-pcollection-dot-map.html index d6ed173..5178343 100644 --- a/content/blog/2016/05/27/where-is-my-pcollection-dot-map.html +++ b/content/blog/2016/05/27/where-is-my-pcollection-dot-map.html @@ -96,12 +96,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/blog/2016/06/13/flink-batch-runner-milestone.html ---------------------------------------------------------------------- diff --git a/content/blog/2016/06/13/flink-batch-runner-milestone.html b/content/blog/2016/06/13/flink-batch-runner-milestone.html index 46a9466..df9f323 100644 --- a/content/blog/2016/06/13/flink-batch-runner-milestone.html +++ b/content/blog/2016/06/13/flink-batch-runner-milestone.html @@ -96,12 +96,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/blog/2016/08/03/six-months.html ---------------------------------------------------------------------- diff --git a/content/blog/2016/08/03/six-months.html b/content/blog/2016/08/03/six-months.html index 6b66c8f..c5b0650 100644 --- a/content/blog/2016/08/03/six-months.html +++ b/content/blog/2016/08/03/six-months.html @@ -96,12 +96,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/blog/index.html ---------------------------------------------------------------------- diff --git a/content/blog/index.html b/content/blog/index.html index 00f0469..c287f49 100644 --- a/content/blog/index.html +++ b/content/blog/index.html @@ -97,12 +97,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/coming-soon.html ---------------------------------------------------------------------- diff --git a/content/coming-soon.html b/content/coming-soon.html index 9fcf1e2..024a84b 100644 --- a/content/coming-soon.html +++ b/content/coming-soon.html @@ -97,12 +97,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/contribute/contribution-guide/index.html ---------------------------------------------------------------------- diff --git a/content/contribute/contribution-guide/index.html b/content/contribute/contribution-guide/index.html index ac11d8a..49da3cc 100644 --- a/content/contribute/contribution-guide/index.html +++ b/content/contribute/contribution-guide/index.html @@ -97,12 +97,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> @@ -143,47 +145,50 @@ <h1 id="apache-beam-contribution-guide">Apache Beam Contribution Guide</h1> <ul id="markdown-toc"> - <li><a href="#apache-beam-contribution-guide" id="markdown-toc-apache-beam-contribution-guide">Apache Beam Contribution Guide</a> <ul> - <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> - </ul> - </li> - <li><a href="#design" id="markdown-toc-design">Design</a></li> - <li><a href="#code" id="markdown-toc-code">Code</a> <ul> - <li><a href="#one-time-setup" id="markdown-toc-one-time-setup">One-time Setup</a> <ul> - <li><a href="#potentially-submit-contributor-license-agreement" id="markdown-toc-potentially-submit-contributor-license-agreement">[Potentially] Submit Contributor License Agreement</a></li> - <li><a href="#obtain-a-github-account" id="markdown-toc-obtain-a-github-account">Obtain a GitHub account</a></li> - <li><a href="#fork-the-repository-on-github" id="markdown-toc-fork-the-repository-on-github">Fork the repository on GitHub</a></li> - <li><a href="#clone-the-repository-locally" id="markdown-toc-clone-the-repository-locally">Clone the repository locally</a></li> - </ul> - </li> - <li><a href="#create-a-branch-in-your-fork" id="markdown-toc-create-a-branch-in-your-fork">Create a branch in your fork</a></li> - <li><a href="#syncing-and-pushing-your-branch" id="markdown-toc-syncing-and-pushing-your-branch">Syncing and pushing your branch</a></li> - <li><a href="#testing" id="markdown-toc-testing">Testing</a></li> - </ul> - </li> - <li><a href="#review" id="markdown-toc-review">Review</a> <ul> - <li><a href="#create-a-pull-request" id="markdown-toc-create-a-pull-request">Create a pull request</a></li> - <li><a href="#code-review-and-revision" id="markdown-toc-code-review-and-revision">Code Review and Revision</a></li> - <li><a href="#lgtm" id="markdown-toc-lgtm">LGTM</a></li> - <li><a href="#deleting-your-branch" id="markdown-toc-deleting-your-branch">Deleting your branch</a></li> + <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> + </ul> + </li> + <li><a href="#design" id="markdown-toc-design">Design</a></li> + <li><a href="#code" id="markdown-toc-code">Code</a> <ul> + <li><a href="#one-time-setup" id="markdown-toc-one-time-setup">One-time Setup</a> <ul> + <li><a href="#potentially-submit-contributor-license-agreement" id="markdown-toc-potentially-submit-contributor-license-agreement">[Potentially] Submit Contributor License Agreement</a></li> + <li><a href="#obtain-a-github-account" id="markdown-toc-obtain-a-github-account">Obtain a GitHub account</a></li> + <li><a href="#fork-the-repository-on-github" id="markdown-toc-fork-the-repository-on-github">Fork the repository on GitHub</a></li> + <li><a href="#clone-the-repository-locally" id="markdown-toc-clone-the-repository-locally">Clone the repository locally</a></li> </ul> </li> - <li><a href="#commit-committers-only" id="markdown-toc-commit-committers-only">Commit (committers only)</a> <ul> - <li><a href="#one-time-setup-1" id="markdown-toc-one-time-setup-1">One-time Setup</a></li> - <li><a href="#contributor-license-agreement" id="markdown-toc-contributor-license-agreement">Contributor License Agreement</a></li> - <li><a href="#tests" id="markdown-toc-tests">Tests</a></li> - <li><a href="#finishing-touches" id="markdown-toc-finishing-touches">Finishing touches</a></li> - <li><a href="#merge-process" id="markdown-toc-merge-process">Merge process</a></li> + <li><a href="#create-a-branch-in-your-fork" id="markdown-toc-create-a-branch-in-your-fork">Create a branch in your fork</a></li> + <li><a href="#syncing-and-pushing-your-branch" id="markdown-toc-syncing-and-pushing-your-branch">Syncing and pushing your branch</a></li> + <li><a href="#testing" id="markdown-toc-testing">Testing</a></li> + </ul> + </li> + <li><a href="#review" id="markdown-toc-review">Review</a> <ul> + <li><a href="#create-a-pull-request" id="markdown-toc-create-a-pull-request">Create a pull request</a></li> + <li><a href="#code-review-and-revision" id="markdown-toc-code-review-and-revision">Code Review and Revision</a></li> + <li><a href="#lgtm" id="markdown-toc-lgtm">LGTM</a></li> + <li><a href="#deleting-your-branch" id="markdown-toc-deleting-your-branch">Deleting your branch</a></li> + </ul> + </li> + <li><a href="#commit-committers-only" id="markdown-toc-commit-committers-only">Commit (committers only)</a> <ul> + <li><a href="#one-time-setup-1" id="markdown-toc-one-time-setup-1">One-time Setup</a></li> + <li><a href="#contributor-license-agreement" id="markdown-toc-contributor-license-agreement">Contributor License Agreement</a></li> + <li><a href="#tests" id="markdown-toc-tests">Tests</a></li> + <li><a href="#finishing-touches" id="markdown-toc-finishing-touches">Finishing touches</a></li> + <li><a href="#merge-process" id="markdown-toc-merge-process">Merge process</a></li> + </ul> + </li> + <li><a href="#special-cases" id="markdown-toc-special-cases">Special Cases</a> <ul> + <li><a href="#feature-branches" id="markdown-toc-feature-branches">Feature Branches</a> <ul> + <li><a href="#developing" id="markdown-toc-developing">Developing</a></li> + <li><a href="#merging-into-master" id="markdown-toc-merging-into-master">Merging into Master</a></li> </ul> </li> - <li><a href="#additional-projects" id="markdown-toc-additional-projects">Additional Projects</a> <ul> - <li><a href="#website" id="markdown-toc-website">Website</a> <ul> - <li><a href="#editing-the-website" id="markdown-toc-editing-the-website">Editing the website</a></li> - <li><a href="#committing-website-changes" id="markdown-toc-committing-website-changes">Committing website changes</a></li> - </ul> - </li> + <li><a href="#website" id="markdown-toc-website">Website</a> <ul> + <li><a href="#one-time-setup-2" id="markdown-toc-one-time-setup-2">One-time Setup</a></li> + <li><a href="#working-on-your-change" id="markdown-toc-working-on-your-change">Working on your change</a></li> + <li><a href="#committing-website-changes" id="markdown-toc-committing-website-changes">Committing website changes</a></li> </ul> </li> </ul> @@ -199,7 +204,7 @@ <p><strong>For larger contributions or those that affect multiple components:</strong></p> <ol> - <li><strong>Engage</strong>: We encourage you to work with the Beam community on the <a href="https://issues.apache.org/jira/browse/BEAM";>Apache JIRA issue tracker</a> and <a href="http://beam.incubator.apache.org/mailing_lists/";>developerâs mailing list</a> to identify good areas for contribution.</li> + <li><strong>Engage</strong>: We encourage you to work with the Beam community on the <a href="https://issues.apache.org/jira/browse/BEAM";>Apache JIRA issue tracker</a> and <a href="http://beam.incubator.apache.org/use/mailing-lists/";>developerâs mailing list</a> to identify good areas for contribution.</li> <li><strong>Design:</strong> More complicated contributions will likely benefit from some early discussion in order to scope and design them well.</li> </ol> @@ -216,27 +221,28 @@ <h2 id="engage">Engage</h2> <h3 id="mailing-lists">Mailing list(s)</h3> -<p>We discuss design and implementation issues on d...@beam.incubator.apache.org mailing list, which is archived <a href="http://mail-archives.apache.org/mod_mbox/incubator-beam-dev/";>here</a>. Join by emailing <a href="mailto:dev-subscribe@beam.incubator.apache.org"><code class="highlighter-rouge">dev-subscr...@beam.incubator.apache.org</code></a>.</p> +<p>We discuss design and implementation issues on d...@beam.incubator.apache.org mailing list, which is archived <a href="https://lists.apache.org/list.html?d...@beam.apache.org";>here</a>. Join by emailing <a href="mailto:dev-subscribe@beam.incubator.apache.org"><code class="highlighter-rouge">dev-subscr...@beam.incubator.apache.org</code></a>.</p> -<p>If interested, you can also join <a href="http://mail-archives.apache.org/mod_mbox/incubator-beam-user/";><code class="highlighter-rouge">u...@beam.incubator.apache.org</code></a> and <a href="http://mail-archives.apache.org/mod_mbox/incubator-beam-commits/";><code class="highlighter-rouge">commits@beam.incubator.apache.org</code></a> too.</p> +<p>If interested, you can also join the other <a href="http://beam.incubator.apache.org/use/mailing-lists/";>mailing lists</a> too.</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> <p>If you do not already have an Apache JIRA account, sign up <a href="https://issues.apache.org/jira/";>here</a>.</p> -<p>If a quick <a href="https://issues.apache.org/jira/issues/?jql=project%3DBEAM%20AND%20text%20~%20%22the%20thing%20I%20want%20to%20contribute%22";>search</a> doesnât turn up an existing JIRA issue for the work you want to contribute, create it. Please discuss your proposal with a committer or the <a href="https://issues.apache.org/jira/browse/BEAM/?selectedTab=com.atlassian.jira.jira-projects-plugin:components-panel";>component lead</a> in JIRA or, alternatively, on the developer mailing list.</p> +<p>If a quick <a href="https://issues.apache.org/jira/issues/?jql=project%3DBEAM%20AND%20text%20~%20%22the%20thing%20I%20want%20to%20contribute%22";>search</a> doesnât turn up an existing JIRA issue for the work you want to contribute, create it. Please discuss your idea with a committer or the <a href="https://issues.apache.org/jira/browse/BEAM/?selectedTab=com.atlassian.jira.jira-projects-plugin:components-panel";>component lead</a> in JIRA or, alternatively, on the developer mailing list.</p> <p>If thereâs an existing JIRA issue for your intended contribution, please comment about your intended work. Once the work is understood, a committer will assign the issue to you. (If you donât have a JIRA role yet, youâll be added to the âcontributorâ role.) If an issue is currently assigned, please check with the current assignee before reassigning.</p> -<p>For moderate or large contributions, you should not start coding or writing a design doc unless there is a corresponding JIRA issue assigned to you for that work. Simple changes, like fixing typos, do not require an associated issue.</p> +<p>For moderate or large contributions, you should not start coding or writing a design document unless there is a corresponding JIRA issue assigned to you for that work. Simple changes, like fixing typos, do not require an associated issue.</p> <h2 id="design">Design</h2> + <p>To avoid potential frustration during the code review cycle, we encourage you to clearly scope and design non-trivial contributions with the Beam community before you start coding.</p> <p>Generally, the JIRA issue is the best place to gather relevant design docs, comments, or references. Itâs great to explicitly include relevant stakeholders early in the conversation. For designs that may be generally interesting, we also encourage conversations on the developerâs mailing list.</p> -<p>We suggest using <a href="https://docs.google.com/";>Google Docs</a> for sharing designs that may benefit from diagrams or comments. Please remember to make the document world-commentable and add a link to it from the relevant JIRA issue. We also track Beam-related documents in <a href="https://drive.google.com/folderview?id=0B-IhJZh9Ab52OFBVZHpsNjc4eXc&usp=sharing";>this shared folder</a>.</p> +<p>We suggest using <a href="https://docs.google.com/";>Google Docs</a> for sharing designs that may benefit from diagrams or comments. Please remember to make the document world-commentable and add a link to it from the relevant JIRA issue. You may want to start from this <a href="https://docs.google.com/document/d/1qYQPGtabN5-E4MjHsecqqC7PXvJtXvZukPfLXQ8rHJs/edit?usp=sharing";>template</a>.</p> <h2 id="code">Code</h2> <p>To contribute code to Apache Beam, youâll have to do a few administrative steps once, and then follow a few guidelines for each contribution.</p> @@ -272,15 +278,19 @@ $ cd incubator-beam <p>Add your forked repository as an additional Git remote, where youâll push your changes.</p> -<pre><code>$ git remote add <b><GitHub_user></b> g...@github.com:<b><GitHub_user></b>/incubator-beam.git</code></pre> +<div class="highlighter-rouge"><pre class="highlight"><code>$ git remote add <GitHub_user> g...@github.com:<GitHub_user>/incubator-beam.git +</code></pre> +</div> <p>You are now ready to start developing!</p> <h3 id="create-a-branch-in-your-fork">Create a branch in your fork</h3> <p>Youâll work on your contribution in a branch in your own (forked) repository. Create a local branch, initialized with the state of the branch you expect your changes to be merged into. Keep in mind that we use several branches, including <code class="highlighter-rouge">master</code>, feature-specific, and release-specific branches. If you are unsure, initialize with the state of the <code class="highlighter-rouge">master</code> branch.</p> -<pre><code>$ git fetch --all -$ git checkout -b <b><my-branch></b> origin/master</code></pre> +<div class="highlighter-rouge"><pre class="highlight"><code>$ git fetch --all +$ git checkout -b <my-branch> origin/master +</code></pre> +</div> <p>At this point, you can start making and committing changes to this branch in a standard way.</p> @@ -295,7 +305,9 @@ $ git checkout -b <b><my-branch></b> origin/master</code></pre> <p>To push your local, committed changes to your (forked) repository on GitHub, run:</p> -<pre><code>$ git push <b><GitHub_user> <my-branch></b></code></pre> +<div class="highlighter-rouge"><pre class="highlight"><code>$ git push <GitHub_user> <my-branch> +</code></pre> +</div> <h3 id="testing">Testing</h3> <p>All code should have appropriate unit testing coverage. New code should have new tests in the same contribution. Bug fixes should include a regression test to prevent the issue from reoccurring.</p> @@ -318,15 +330,19 @@ $ git checkout -b <b><my-branch></b> origin/master</code></pre> <p>Navigate to the <a href="https://github.com/apache/incubator-beam";>Beam GitHub mirror</a> to create a pull request. The title of the pull request should be strictly in the following format:</p> -<pre><code>[BEAM-<b><JIRA-issue-#></b>] Title of the pull request</code></pre> +<div class="highlighter-rouge"><pre class="highlight"><code>[BEAM-<JIRA-issue-#>] <Title of the pull request> +</code></pre> +</div> <p>Please include a descriptive pull request message to help make the reviewerâs job easier. Itâs fine to refer to existing design docs or the contents of the associated JIRA as appropriate.</p> <p>If you know a good committer to review your pull request, please make a comment like the following. If not, donât worry â a committer will pick it up.</p> -<pre><code>Hi @<b><GitHub-reviewer-username></b>, can you please take a look?</code></pre> +<div class="highlighter-rouge"><pre class="highlight"><code>Hi @<GitHub-reviewer-username>, can you please take a look? +</code></pre> +</div> -<p>When choosing a reviewer, think about who is the expert on the relevant code, who the stakeholders are for this change, and who else would benefit from becoming familiar with the code. If youâd appreciate comments from additional folks but already have a main reviewer, you can explicitly cc them using <code>@<b><GitHub-reviewer-username></b></code>.</p> +<p>When choosing a reviewer, think about who is the expert on the relevant code, who the stakeholders are for this change, and who else would benefit from becoming familiar with the code. If youâd appreciate comments from additional folks but already have a main reviewer, you can explicitly cc them using <code class="highlighter-rouge">@<GitHub-reviewer-username></code>.</p> <h3 id="code-review-and-revision">Code Review and Revision</h3> <p>During the code review process, donât rebase your branch or otherwise modify published commits, since this can remove existing comment history and be confusing to the reviewer. When you make a revision, always push it in a new commit.</p> @@ -345,9 +361,11 @@ $ git checkout -b <b><my-branch></b> origin/master</code></pre> <p>From another local branch, run:</p> -<pre><code>$ git fetch --all -$ git branch -d <b><my-branch></b> -$ git push <b><GitHub_user></b> --delete <b><my-branch></b></code></pre> +<div class="highlighter-rouge"><pre class="highlight"><code>$ git fetch --all +$ git branch -d <my-branch> +$ git push <GitHub_user> --delete <my-branch> +</code></pre> +</div> <h2 id="commit-committers-only">Commit (committers only)</h2> <p>Once the code has been peer reviewed by a committer, the next step is for the committer to merge it into the <a href="https://git-wip-us.apache.org/repos/asf/incubator-beam.git";>authoritative Apache repository</a>, not the read-only GitHub mirror. (In the case that the author is also a committer, it is acceptable for either the author or reviewer to do the merge. Just be explicit about whose job it is!)</p> @@ -380,13 +398,15 @@ $ git push <b><GitHub_user></b> --delete <b><my-branch></b></code></ <p>You can confirm your configuration by running the following command.</p> -<pre><code>$ git remote -v +<div class="highlighter-rouge"><pre class="highlight"><code>$ git remote -v apache https://git-wip-us.apache.org/repos/asf/incubator-beam.git (fetch) apache https://git-wip-us.apache.org/repos/asf/incubator-beam.git (push) github https://github.com/apache/incubator-beam.git (fetch) github https://github.com/apache/incubator-beam.git (push) -<b><username></b> g...@github.com:<b><username></b>/beam.git (fetch) -<b><username></b> g...@github.com:<b><username></b>/beam.git (push)</code></pre> +<username> g...@github.com:<username>/beam.git (fetch) +<username> g...@github.com:<username>/beam.git (push) +</code></pre> +</div> <h3 id="contributor-license-agreement">Contributor License Agreement</h3> <p>If you are merging a larger contribution, please make sure that the contributor has an ICLA on file with the Apache Secretary. You can view the list of committers <a href="http://home.apache.org/phonebook.html?unix=committers";>here</a>, as well as <a href="http://home.apache.org/unlistedclas.html";>ICLA-signers who arenât yet committers</a>.</p> @@ -401,9 +421,10 @@ github https://github.com/apache/incubator-beam.git (push) <p>Fetch references from all remote repositories, and checkout the specific pull request branch.</p> -<pre> -</code>$ git fetch --all -$ git checkout -b finish-pr-<b><pull-request-#></b> github/pr/<b><pull-request-#></b></code></pre> +<div class="highlighter-rouge"><pre class="highlight"><code>$ git fetch --all +$ git checkout -b finish-pr-<pull-request-#> github/pr/<pull-request-#> +</code></pre> +</div> <p>At this point, you can commit any final touches to the pull request. For example, you should:</p> @@ -424,13 +445,15 @@ $ git checkout -b finish-pr-<b><pull-request-#></b> github/pr/<b><pull- <h3 id="merge-process">Merge process</h3> <p>Once you are ready to merge, fetch all remotes, checkout the destination branch and merge the changes.</p> -<pre><code>$ git fetch --all +<div class="highlighter-rouge"><pre class="highlight"><code>$ git fetch --all $ git checkout apache/master $ git merge --no-ff \ - -m $'[BEAM-<b><JIRA-issue-#></b>] <b><Title></b>\n\nThis closes #<b><pull-request-#></b>' \ - finish-pr-<b><pull-request-#></b></code></pre> + -m $'[BEAM-<JIRA-issue-#&>;</b>] <Title>\n\nThis closes #<pull-request-#>' \ + finish-pr-<pull-request-#> +</code></pre> +</div> -<p>Always use <code class="highlighter-rouge">--no-ff</code> option and the specific commit message âThis closes #<b><pull request #></b>ââ â it ensures proper marking in the tooling. It would be nice to include additional information in the merge commit message, such as the title and summary of the pull request.</p> +<p>Always use <code class="highlighter-rouge">--no-ff</code> option and the specific commit message âThis closes #<pull request #>ââ â it ensures proper marking in the tooling. It would be nice to include additional information in the merge commit message, such as the title and summary of the pull request.</p> <p>At this point, you want to ensure everything is right. Test it with <code class="highlighter-rouge">mvn verify</code>. Run <code class="highlighter-rouge">gitk</code> or <code class="highlighter-rouge">git log --graph,</code> etc. When you are happy with how it looks, push it. This is the point of no return â proceed with caution.</p> @@ -438,36 +461,115 @@ $ git merge --no-ff \ </code></pre> </div> -<p>Done. You can delete the local <code>finish-pr-<b><pull-request-#></b></code> branch if you like.</p> +<p>Done. You can delete the local <code>finish-pr-<pull-request-#></code> branch if you like.</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> + +<h3 id="feature-branches">Feature Branches</h3> + +<p>Some larger features are developed on a feature branch before being merged into <code class="highlighter-rouge">master</code>. In particular, this is often used for initial development of new components like SDKs or runners.</p> + +<h4 id="developing">Developing</h4> + +<p>To contribute code on a feature branch, use the same process as above, but replace <code class="highlighter-rouge">master</code> with the <a href="/contribute/work-in-progress/#feature-branches">name of the branch</a>.</p> + +<p>In additional, youâll want to frequently merge in changes from <code class="highlighter-rouge">master</code> in order to prevent life on the branch from deviating too far from reality.</p> + +<p>Since feature branches are often used for new components, you may find that there is no <a href="/project/team/">committer</a> familiar with all the details of the new language or runner. In that case, consider asking someone else familiar with the technology to do an initial review before looping in a committer for a final review and merge.</p> -<h2 id="additional-projects">Additional Projects</h2> +<h4 id="merging-into-master">Merging into Master</h4> + +<p>In order for a feature branch to be merged into <code class="highlighter-rouge">master</code>, new components and major features should aim to meet the following guidelines.</p> + +<ol> + <li>Have at least 2 contributors interested in maintaining it, and 1 committer interested in supporting it</li> + <li>Provide both end-user and developer-facing documentation</li> + <li>Have at least a basic level of unit test coverage</li> + <li>Run all existing applicable integration tests with other Beam components and create additional tests as appropriate</li> +</ol> + +<p>Additionally, â¦</p> + +<p>A new runner should:</p> + +<ol> + <li>Be able to handle a subset of the model that address a significant set of use cases (aka. âtraditional batchâ or âprocessing time streamingâ)</li> + <li>Update the capability matrix with the current status</li> + <li>Add a webpage under <code class="highlighter-rouge">learn/runners</code></li> +</ol> + +<p>A new SDK should:</p> + +<ol> + <li>Provide the ability to construct graphs with all the basic building blocks of the model (ParDo, GroupByKey, Window, Trigger, etc)</li> + <li>Begin fleshing out the common composite transforms (Count, Join, etc) and IO connectors (Text, Kafka, etc)</li> + <li>Have at least one runner that can execute the complete model (may be a direct runner)</li> + <li>Provide integration tests for executing against current and future runners</li> + <li>Add a webpage under <code class="highlighter-rouge">learn/sdks</code></li> +</ol> <h3 id="website">Website</h3> -<p>We use the same general review-then-commit process for changes to the Beam website, which uses <a href="https://github.com/apache/incubator-beam-site";>this GitHub Mirror</a>. The website uses the <a href="http://jekyllrb.com";>Jekyll</a> framework to make website development easier. The <a href="https://github.com/apache/incubator-beam-site/blob/asf-site/README.md";>README file</a> in the website repository has more information on how to:</p> -<ul> - <li>Install Jekyll</li> - <li>Make changes to the website</li> - <li>Test your changes</li> -</ul> +<p>The Beam website is in the <a href="https://github.com/apache/incubator-beam-site";>Beam Site GitHub mirror</a> repository in the <code class="highlighter-rouge">asf-site</code> branch (<em>not</em> <code class="highlighter-rouge">master</code>).</p> + +<p>The repository contains:</p> + +<ol> + <li><code class="highlighter-rouge">_<directory></code>: the infrastructure for building, testing, and styling the website</li> + <li><code class="highlighter-rouge">_posts</code>: blog post entries</li> + <li><code class="highlighter-rouge">use/</code>, <code class="highlighter-rouge">learn/</code>, and <code class="highlighter-rouge">contribute/</code>: markdown files containing the bulk of the content</li> + <li><code class="highlighter-rouge">content/</code>: html generated from the markdown by jekyll (which is what is actually hosted on the website)</li> +</ol> + +<p>Issues are tracked in the <a href="https://issues.apache.org/jira/browse/BEAM/component/12328906";>website</a> component in JIRA.</p> + +<h4 id="one-time-setup-2">One-time Setup</h4> + +<p>The website uses <a href="http://jekyllrb.com";>Jekyll</a>, a ruby-based development framework. The <a href="https://github.com/apache/incubator-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> + +<div class="highlighter-rouge"><pre class="highlight"><code>$ git clone -b asf-site https://github.com/apache/incubator-beam-site.git +$ cd incubator-beam-site +$ git remote add <GitHub_user> g...@github.com:<GitHub_user>/incubator-beam-site.git +$ git fetch --all +$ git checkout -b <my-branch> origin/asf-site +</code></pre> +</div> + +<h4 id="working-on-your-change">Working on your change</h4> + +<p>While you are working on your pull request, you can test and develop live by running the following command in the root folder of the website:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>$ jekyll serve +</code></pre> +</div> + +<p>Jekyll will start a webserver on port 4000. As you make changes to the content, Jekyll will rebuild it automatically.</p> + +<p>In addition, you can run the tests to valid your links using:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>$ rake test +</code></pre> +</div> + +<p>Both of these commands will cause the <code class="highlighter-rouge">content/</code> directory to be generated. Merging autogenerated content can get tricky, so please leave this directory out of your commits and pull request by doing:</p> + +<div class="highlighter-rouge"><pre class="highlight"><code>$ git checkout -- content +</code></pre> +</div> -<h4 id="editing-the-website">Editing the website</h4> -<p>You can checkout the website repository with the following commands. This will allow you to edit the website in a local environment provided you have installed <a href="http://jekyllrb.com";>Jekyll</a> and understand how to use it.</p> +<p>When you are ready, submit a pull request using the <a href="https://github.com/apache/incubator-beam-site";>Beam Site GitHub mirror</a>, including the JIRA issue as usual.</p> -<pre><code>git clone -b asf-site https://github.com/apache/incubator-beam-site.git -cd incubator-beam-site -git remote add <b><GitHub_user></b> g...@github.com:<b><GitHub_user></b>/incubator-beam-site.git -git fetch --all -git checkout -b <b><my-branch></b> origin/asf-site</code></pre> +<p>During review, committers will patch in your PR, generate the static <code class="highlighter-rouge">content/</code>, and review the changes.</p> <h4 id="committing-website-changes">Committing website changes</h4> -<p>Committers can commit website changes with the following commands. <strong>Changes to the website must follow the same process outlined above</strong> for changes to the Apache Beam code base.</p> +<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> -<pre><code>git remote add apache https://git-wip-us.apache.org/repos/asf/incubator-beam-site.git -git remote rename origin github -git config --local --add remote.github.fetch \ - '+refs/pull/*/head:refs/remotes/github/pr/*'</code></pre> +<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> </div> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/contribute/design-principles/index.html ---------------------------------------------------------------------- diff --git a/content/contribute/design-principles/index.html b/content/contribute/design-principles/index.html new file mode 100644 index 0000000..5134d05 --- /dev/null +++ b/content/contribute/design-principles/index.html @@ -0,0 +1,233 @@ +<!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"> + + <title>Design Principles in Beam</title> + <meta name="description" content="Apache Beam is an open source, unified model and set of language-specific SDKs for defining and executing data processing workflows, and also data ingestion and integration flows, supporting Enterprise Integration Patterns (EIPs) and Domain Specific Languages (DSLs). Dataflow pipelines simplify the mechanics of large-scale batch and streaming data processing and can run on a number of runtimes like Apache Flink, Apache Spark, and Google Cloud Dataflow (a cloud service). Beam also brings DSL in different languages, allowing users to easily implement their data integration processes. +"> + + <link rel="stylesheet" href="/styles/site.css"> + <link rel="stylesheet" href="/css/theme.css"> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.0/jquery.min.js";></script> + <script src="/js/bootstrap.min.js"></script> + <link rel="canonical" href="http://beam.incubator.apache.org/contribute/design-principles/"; data-proofer-ignore> + <link rel="alternate" type="application/rss+xml" title="Apache Beam (incubating)" href="http://beam.incubator.apache.org/feed.xml";> + <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-73650088-1', 'auto'); + ga('send', 'pageview'); + + </script> + <link rel="shortcut icon" type="image/x-icon" href="/images/favicon.ico"> +</head> + + + <body role="document"> + + <nav class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <a href="/" class="navbar-brand" > + <img alt="Brand" style="height: 25px" src="/images/beam_logo_navbar.png"> + </a> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Use <span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="/use">User Hub</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">General</li> + <li><a href="/use/beam-overview/">Beam Overview</a></li> + <li><a href="/use/quickstart/">Quickstart</a></li> + <li><a href="/use/releases">Release Information</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Example Walkthroughs</li> + <li><a href="/use/walkthroughs/">WordCount</a></li> + <li><a href="/use/walkthroughs/">Mobile Gaming</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Support</li> + <li><a href="/use/mailing-lists/">Mailing Lists</a></li> + <li><a href="/use/issue-tracking/">Issue Tracking</a></li> + <li><a href="http://stackoverflow.com/questions/tagged/apache-beam";>Beam on StackOverflow</a></li> + <li><a href="http://apachebeam.slack.com";>Beam Slack Channel</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Learn <span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="/learn">Learner Hub</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Beam Concepts</li> + <li><a href="/learn/programming-guide/">Programming Guide</a></li> + <li><a href="/learn/presentation-materials/">Presentation Materials</a></li> + <li><a href="/learn/resources/">Additional Resources</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">SDKs</li> + <li><a href="/learn/sdks/java/">Java SDK</a></li> + <li><a href="/learn/sdks/javadoc/">Java SDK API Reference</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Runners</li> + <li><a href="/learn/runners/capability-matrix/">Capability Matrix</a></li> + <li><a href="/learn/runners/direct/">Direct Runner</a></li> + <li><a href="/learn/runners/flink/">Apache Flink Runner</a></li> + <li><a href="/learn/runners/spark/">Apache Spark Runner</a></li> + <li><a href="/learn/runners/dataflow/">Cloud Dataflow Runner</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Contribute <span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="/contribute">Contributor Hub</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Basics</li> + <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> + <li><a href="/use/mailing-lists/">Mailing Lists</a></li> + <li><a href="/contribute/source-repository/">Source Repository</a></li> + <li><a href="/use/issue-tracking/">Issue Tracking</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> + <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> + </ul> + </li> + <li><a href="/blog">Blog</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Project<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="/project/logos/">Logos and design</a></li> + <li><a href="/project/public-meetings/">Public Meetings</a></li> + <li><a href="/project/team/">Team</a></li> + </ul> + </li> + </ul> + <ul class="nav navbar-nav navbar-right"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false"><img src="https://www.apache.org/foundation/press/kit/feather_small.png"; alt="Apache Logo" style="height:24px;">Apache Software Foundation<span class="caret"></span></a> + <ul class="dropdown-menu dropdown-menu-right"> + <li><a href="http://www.apache.org/";>ASF Homepage</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="https://www.apache.org/foundation/policies/conduct";>Code of Conduct</a></li> + </ul> + </li> + </ul> + </div><!--/.nav-collapse --> + </div> +</nav> + + +<link rel="stylesheet" href=""> + + + <div class="container" role="main"> + + <div class="row"> + <h1 id="design-principles-in-the-apache-beam-project">Design Principles in the Apache Beam Project</h1> + +<p>Joshua Blochâs <a href="https://www.infoq.com/articles/API-Design-Joshua-Bloch";>API Design Bumper Stickers</a> are a great list of what makes for good API design. In addition, we have specific design principles we follow in Beam.</p> + +<ul id="markdown-toc"> + <li><a href="#use-cases" id="markdown-toc-use-cases">Use cases</a> <ul> + <li><a href="#unify-the-model" id="markdown-toc-unify-the-model">Unify the model</a></li> + <li><a href="#separate-data-shapes-and-runtime-requirements" id="markdown-toc-separate-data-shapes-and-runtime-requirements">Separate data shapes and runtime requirements</a></li> + <li><a href="#make-efficient-things-easy-rather-than-make-easy-things-efficient" id="markdown-toc-make-efficient-things-easy-rather-than-make-easy-things-efficient">Make efficient things easy, rather than make easy things efficient</a></li> + </ul> + </li> + <li><a href="#usability" id="markdown-toc-usability">Usability</a> <ul> + <li><a href="#validate-early" id="markdown-toc-validate-early">Validate Early</a></li> + <li><a href="#public-apis-like-diamonds-are-forever-at-least-until-the-next-major-version" id="markdown-toc-public-apis-like-diamonds-are-forever-at-least-until-the-next-major-version">Public APIs, like diamonds, are forever (at least until the next major version)</a></li> + <li><a href="#examples-should-be-pedagogical" id="markdown-toc-examples-should-be-pedagogical">Examples should be pedagogical</a></li> + </ul> + </li> + <li><a href="#extensibility" id="markdown-toc-extensibility">Extensibility</a> <ul> + <li><a href="#use-ptransforms-for-modularity" id="markdown-toc-use-ptransforms-for-modularity">Use PTransforms for modularity</a></li> + <li><a href="#keep-beam-sdks-consistent" id="markdown-toc-keep-beam-sdks-consistent">Keep Beam SDKs consistent</a></li> + <li><a href="#when-in-rome-python-do-as-the-romans-pythonians-do" id="markdown-toc-when-in-rome-python-do-as-the-romans-pythonians-do">When in <del>Rome</del> Python, do as the <del>Romans</del> Pythonians do</a></li> + <li><a href="#encourage-dsls" id="markdown-toc-encourage-dsls">Encourage DSLs</a></li> + <li><a href="#design-for-the-model-not-specific-runners" id="markdown-toc-design-for-the-model-not-specific-runners">Design for the model, not specific runners</a></li> + </ul> + </li> +</ul> + +<h2 id="use-cases">Use cases</h2> + +<h3 id="unify-the-model">Unify the model</h3> +<p>Provide one model that works over both bounded (aka. batch) and unbounded (aka. streaming) datasets. Pay special attention to windows / triggers / state / timers, which often trip up folks used to a batch world. Provide users with the right abstractions to adjust latency and completeness guarantees to cover both traditional batch and streaming use cases.</p> + +<h3 id="separate-data-shapes-and-runtime-requirements">Separate data shapes and runtime requirements</h3> +<p>The model should focus on letting users describe their data and processing, without exposing any details of a specific runtime system. For example, bounded and unbounded describe the shape of data, but batch and streaming describe the behavior of specific runtime systems. Good test cases are to imagine a mythical micro-batching runner that sits somewhere between batch and streaming or a engine that dynamically switches between streaming and batch depending on the backlog.</p> + +<h3 id="make-efficient-things-easy-rather-than-make-easy-things-efficient">Make efficient things easy, rather than make easy things efficient</h3> +<p>Donât prevent efficiency for ease of use. Design APIs that provide the information necessary for efficiently executing at scale. Provide class hierarchies and wrappers to make the common cases simpler.</p> + +<h2 id="usability">Usability</h2> + +<h3 id="validate-early">Validate Early</h3> +<p>Validate constraints on graph shape, runner requirements, etc as early in the compile time - construction time - submission time - execution time spectrum as reasonably possible in order to provide a smoother user experience.</p> + +<h3 id="public-apis-like-diamonds-are-forever-at-least-until-the-next-major-version">Public APIs, like diamonds, are forever (at least until the next major version)</h3> +<p>Backwards incompatible changes can only be made in the next major version. Because of the burden major versions place on users (code has to be modified, conflicting dependency nightmares, etc), we aim to do this infrequently. Clearly mark APIs that are considered experimental (may change at any point) and deprecated (will be removed in the next major version). Consider what APIs are more amenable to future changes (abstract classes vs. interfaces, etc.)</p> + +<h3 id="examples-should-be-pedagogical">Examples should be pedagogical</h3> +<p>Canonical examples help people ingrain the principles. Design examples that teach complex concepts in modular chunks. If you canât explain the concept easily, then the API isnât right. Examples should withstand random copy-pasting.</p> + +<h2 id="extensibility">Extensibility</h2> + +<h3 id="use-ptransforms-for-modularity">Use PTransforms for modularity</h3> +<p>Composite transformations (transformations formed by a subgraph of other transformations) are treated as first class objects. They can be named and applied directly in any pipeline to nicely encapsulate concepts. This removes the artificial separation between those built into PCollection and those provided by users. In addition, PTransforms can be used as a clear concept in graphical monitoring and provide a way to scope metadata like aggregators, logging, and resources. Use these when building pipelines.</p> + +<h3 id="keep-beam-sdks-consistent">Keep Beam SDKs consistent</h3> +<p>Beam SDKs should expose the complete set of concepts in the programming model. They should all use the same set of abstractions and be able to share conceptual documentation.</p> + +<h3 id="when-in-rome-python-do-as-the-romans-pythonians-do">When in <del>Rome</del> Python, do as the <del>Romans</del> Pythonians do</h3> +<p>Each SDK must feel right to those who live and breath that language. Adapt the general Beam concepts into language-dependent styles when the benefits clearly outweigh the drawbacks.</p> + +<h3 id="encourage-dsls">Encourage DSLs</h3> +<p>Many use cases or user communities can be served by provided âwrapperâ SDKs that provide a simpler or domain-specific set of abstractions that then build on a Beam SDK and take advantage of Beam Runners.</p> + +<h3 id="design-for-the-model-not-specific-runners">Design for the model, not specific runners</h3> + +<p>The Beam APIs should serve all runners. Behind every runner-specific hook, there is a general principle in the model. Design APIs that generalize across multiple runners.</p> + + + </div> + + + <hr> + <div class="row"> + <div class="col-xs-12"> + <footer> + <p class="text-center">© Copyright 2016 + <a href="http://www.apache.org";>The Apache Software Foundation.</a> All Rights Reserved.</p> + <p class="text-center"><a href="/privacy_policy">Privacy Policy</a> | + <a href="/feed.xml">RSS Feed</a></p> + </footer> + </div> + </div> + <!-- container div end --> +</div> + + + </body> + +</html> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/contribute/index.html ---------------------------------------------------------------------- diff --git a/content/contribute/index.html b/content/contribute/index.html index 24b2bf0..ab19fe4 100644 --- a/content/contribute/index.html +++ b/content/contribute/index.html @@ -97,12 +97,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/contribute/source-repository/index.html ---------------------------------------------------------------------- diff --git a/content/contribute/source-repository/index.html b/content/contribute/source-repository/index.html index f362c39..8c5c4fd 100644 --- a/content/contribute/source-repository/index.html +++ b/content/contribute/source-repository/index.html @@ -97,12 +97,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/contribute/testing/index.html ---------------------------------------------------------------------- diff --git a/content/contribute/testing/index.html b/content/contribute/testing/index.html index b5718fa..4ee52e8 100644 --- a/content/contribute/testing/index.html +++ b/content/contribute/testing/index.html @@ -97,12 +97,14 @@ <li role="separator" class="divider"></li> <li class="dropdown-header">Basics</li> <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> - <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> <li><a href="/use/mailing-lists/">Mailing Lists</a></li> <li><a href="/contribute/source-repository/">Source Repository</a></li> <li><a href="/use/issue-tracking/">Issue Tracking</a></li> <li role="separator" class="divider"></li> - <li class="dropdown-header">Technical Resources</li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> </ul> </li> @@ -143,29 +145,26 @@ <h1 id="beam-testing-documentation">Beam Testing Documentation</h1> <ul id="markdown-toc"> - <li><a href="#beam-testing-documentation" id="markdown-toc-beam-testing-documentation">Beam Testing Documentation</a> <ul> - <li><a href="#overview" id="markdown-toc-overview">Overview</a></li> - <li><a href="#testing-matrix" id="markdown-toc-testing-matrix">Testing Matrix</a> <ul> - <li><a href="#java-sdk" id="markdown-toc-java-sdk">Java SDK</a></li> - <li><a href="#python-sdk" id="markdown-toc-python-sdk">Python SDK</a></li> - </ul> - </li> - <li><a href="#testing-scenarios" id="markdown-toc-testing-scenarios">Testing Scenarios</a> <ul> - <li><a href="#precommit" id="markdown-toc-precommit">Precommit</a></li> - <li><a href="#postcommit" id="markdown-toc-postcommit">Postcommit</a></li> - </ul> - </li> - <li><a href="#testing-types" id="markdown-toc-testing-types">Testing Types</a> <ul> - <li><a href="#unit" id="markdown-toc-unit">Unit</a></li> - <li><a href="#runnableonservice-working-title" id="markdown-toc-runnableonservice-working-title">RunnableOnService (Working Title)</a></li> - <li><a href="#e2e" id="markdown-toc-e2e">E2E</a></li> - </ul> - </li> - <li><a href="#testing-systems" id="markdown-toc-testing-systems">Testing Systems</a> <ul> - <li><a href="#e2e-testing-framework" id="markdown-toc-e2e-testing-framework">E2E Testing Framework</a></li> - <li><a href="#runnableonservice-tests" id="markdown-toc-runnableonservice-tests">RunnableOnService Tests</a></li> - </ul> - </li> + <li><a href="#overview" id="markdown-toc-overview">Overview</a></li> + <li><a href="#testing-matrix" id="markdown-toc-testing-matrix">Testing Matrix</a> <ul> + <li><a href="#java-sdk" id="markdown-toc-java-sdk">Java SDK</a></li> + <li><a href="#python-sdk" id="markdown-toc-python-sdk">Python SDK</a></li> + </ul> + </li> + <li><a href="#testing-scenarios" id="markdown-toc-testing-scenarios">Testing Scenarios</a> <ul> + <li><a href="#precommit" id="markdown-toc-precommit">Precommit</a></li> + <li><a href="#postcommit" id="markdown-toc-postcommit">Postcommit</a></li> + </ul> + </li> + <li><a href="#testing-types" id="markdown-toc-testing-types">Testing Types</a> <ul> + <li><a href="#unit" id="markdown-toc-unit">Unit</a></li> + <li><a href="#runnableonservice-working-title" id="markdown-toc-runnableonservice-working-title">RunnableOnService (Working Title)</a></li> + <li><a href="#e2e" id="markdown-toc-e2e">E2E</a></li> + </ul> + </li> + <li><a href="#testing-systems" id="markdown-toc-testing-systems">Testing Systems</a> <ul> + <li><a href="#e2e-testing-framework" id="markdown-toc-e2e-testing-framework">E2E Testing Framework</a></li> + <li><a href="#runnableonservice-tests" id="markdown-toc-runnableonservice-tests">RunnableOnService Tests</a></li> </ul> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/contribute/work-in-progress/index.html ---------------------------------------------------------------------- diff --git a/content/contribute/work-in-progress/index.html b/content/contribute/work-in-progress/index.html new file mode 100644 index 0000000..3da51ce --- /dev/null +++ b/content/contribute/work-in-progress/index.html @@ -0,0 +1,222 @@ +<!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"> + + <title>In Progress Work in Beam</title> + <meta name="description" content="Apache Beam is an open source, unified model and set of language-specific SDKs for defining and executing data processing workflows, and also data ingestion and integration flows, supporting Enterprise Integration Patterns (EIPs) and Domain Specific Languages (DSLs). Dataflow pipelines simplify the mechanics of large-scale batch and streaming data processing and can run on a number of runtimes like Apache Flink, Apache Spark, and Google Cloud Dataflow (a cloud service). Beam also brings DSL in different languages, allowing users to easily implement their data integration processes. +"> + + <link rel="stylesheet" href="/styles/site.css"> + <link rel="stylesheet" href="/css/theme.css"> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.0/jquery.min.js";></script> + <script src="/js/bootstrap.min.js"></script> + <link rel="canonical" href="http://beam.incubator.apache.org/contribute/work-in-progress/"; data-proofer-ignore> + <link rel="alternate" type="application/rss+xml" title="Apache Beam (incubating)" href="http://beam.incubator.apache.org/feed.xml";> + <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-73650088-1', 'auto'); + ga('send', 'pageview'); + + </script> + <link rel="shortcut icon" type="image/x-icon" href="/images/favicon.ico"> +</head> + + + <body role="document"> + + <nav class="navbar navbar-default navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <a href="/" class="navbar-brand" > + <img alt="Brand" style="height: 25px" src="/images/beam_logo_navbar.png"> + </a> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Use <span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="/use">User Hub</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">General</li> + <li><a href="/use/beam-overview/">Beam Overview</a></li> + <li><a href="/use/quickstart/">Quickstart</a></li> + <li><a href="/use/releases">Release Information</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Example Walkthroughs</li> + <li><a href="/use/walkthroughs/">WordCount</a></li> + <li><a href="/use/walkthroughs/">Mobile Gaming</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Support</li> + <li><a href="/use/mailing-lists/">Mailing Lists</a></li> + <li><a href="/use/issue-tracking/">Issue Tracking</a></li> + <li><a href="http://stackoverflow.com/questions/tagged/apache-beam";>Beam on StackOverflow</a></li> + <li><a href="http://apachebeam.slack.com";>Beam Slack Channel</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Learn <span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="/learn">Learner Hub</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Beam Concepts</li> + <li><a href="/learn/programming-guide/">Programming Guide</a></li> + <li><a href="/learn/presentation-materials/">Presentation Materials</a></li> + <li><a href="/learn/resources/">Additional Resources</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">SDKs</li> + <li><a href="/learn/sdks/java/">Java SDK</a></li> + <li><a href="/learn/sdks/javadoc/">Java SDK API Reference</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Runners</li> + <li><a href="/learn/runners/capability-matrix/">Capability Matrix</a></li> + <li><a href="/learn/runners/direct/">Direct Runner</a></li> + <li><a href="/learn/runners/flink/">Apache Flink Runner</a></li> + <li><a href="/learn/runners/spark/">Apache Spark Runner</a></li> + <li><a href="/learn/runners/dataflow/">Cloud Dataflow Runner</a></li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Contribute <span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="/contribute">Contributor Hub</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Basics</li> + <li><a href="/contribute/contribution-guide/">Contribution Guide</a></li> + <li><a href="/contribute/work-in-progress/">Work In Progress</a></li> + <li><a href="/use/mailing-lists/">Mailing Lists</a></li> + <li><a href="/contribute/source-repository/">Source Repository</a></li> + <li><a href="/use/issue-tracking/">Issue Tracking</a></li> + <li role="separator" class="divider"></li> + <li class="dropdown-header">Technical References</li> + <li><a href="/contribute/testing/">Testing</a></li> + <li><a href="/contribute/design-principles/">Design Principles</a></li> + <li><a href="https://goo.gl/nk5OM0";>Technical Vision</a></li> + </ul> + </li> + <li><a href="/blog">Blog</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Project<span class="caret"></span></a> + <ul class="dropdown-menu"> + <li><a href="/project/logos/">Logos and design</a></li> + <li><a href="/project/public-meetings/">Public Meetings</a></li> + <li><a href="/project/team/">Team</a></li> + </ul> + </li> + </ul> + <ul class="nav navbar-nav navbar-right"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false"><img src="https://www.apache.org/foundation/press/kit/feather_small.png"; alt="Apache Logo" style="height:24px;">Apache Software Foundation<span class="caret"></span></a> + <ul class="dropdown-menu dropdown-menu-right"> + <li><a href="http://www.apache.org/";>ASF Homepage</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="https://www.apache.org/foundation/policies/conduct";>Code of Conduct</a></li> + </ul> + </li> + </ul> + </div><!--/.nav-collapse --> + </div> +</nav> + + +<link rel="stylesheet" href=""> + + + <div class="container" role="main"> + + <div class="row"> + <h1 id="work-in-progress-in-the-apache-beam-project">Work In Progress in the Apache Beam Project</h1> + +<p>As mentioned in the <a href="/contribute/contribution-guide/">Contribution Guide</a>, all work in Beam is tracked in our <a href="https://issues.apache.org/jira/browse/BEAM";>Apache JIRA</a>. In addition, the following types of work may be of particular interest to the Beam community.</p> + +<ul id="markdown-toc"> + <li><a href="#starter-tasks" id="markdown-toc-starter-tasks">Starter Tasks</a></li> + <li><a href="#feature-branches" id="markdown-toc-feature-branches">Feature Branches</a></li> +</ul> + +<h2 id="starter-tasks">Starter Tasks</h2> + +<p>The community regular tags good getting started tasks with the label <code class="highlighter-rouge">starter</code>. Use a quick <a href="https://issues.apache.org/jira/issues?jql=project%20%3D%20BEAM%20AND%20status%20%3D%20Open%20AND%20labels%20%3D%20starter";>JIRA search</a> to identify ways you can get started <a href="/contribute/contribution-guide/">contributing</a> to Beam.</p> + +<h2 id="feature-branches">Feature Branches</h2> + +<p>Larger features with multiple active developers may be developed on a <a href="/contribute/contribution-guide/#feature-branches">feature branch</a> before being merged in the master branch. In particular, this is often used for initial development of new components like SDKs or runners.</p> + +<p>Current branches include:</p> + +<table class="table"> + <thead> + <tr> + <th>Feature</th> + <th>Branch</th> + <th>JIRA Component</th> + <th>More Info</th> + </tr> + </thead> + <tbody> + <tr> + <td>Apache Apex Runner</td> + <td><a href="https://github.com/apache/incubator-beam/tree/apex-runner";>apex-runner</a></td> + <td><a href="https://issues.apache.org/jira/browse/BEAM/component/12331007";>runner-apex</a></td> + <td>-</td> + </tr> + <tr> + <td>Apache Gearpump Runner</td> + <td><a href="https://github.com/apache/incubator-beam/tree/gearpump-runner";>gearpump-runner</a></td> + <td><a href="https://issues.apache.org/jira/browse/BEAM/component/12330829";>runner-gearpump</a></td> + <td><a href="https://github.com/apache/incubator-beam/blob/gearpump-runner/runners/gearpump/README.md";>README</a></td> + </tr> + <tr> + <td>Python SDK</td> + <td><a href="https://github.com/apache/incubator-beam/tree/python-sdk";>python-sdk</a></td> + <td><a href="https://issues.apache.org/jira/browse/BEAM/component/12328910";>sdk-py</a></td> + <td><a href="https://github.com/apache/incubator-beam/blob/python-sdk/sdks/python/README.md";>README</a></td> + </tr> + <tr> + <td>Apache Spark 2.0 Runner</td> + <td><a href="https://github.com/apache/incubator-beam/tree/runners-spark2";>runners-spark2</a></td> + <td>-</td> + <td><a href="https://lists.apache.org/thread.html/e38ac4e4914a6cb1b865b1f32a6ca06c2be28ea4aa0f6b18393de66f@%3Cdev.beam.apache.org%3E";>thread</a></td> + </tr> + </tbody> +</table> + + + </div> + + + <hr> + <div class="row"> + <div class="col-xs-12"> + <footer> + <p class="text-center">© Copyright 2016 + <a href="http://www.apache.org";>The Apache Software Foundation.</a> All Rights Reserved.</p> + <p class="text-center"><a href="/privacy_policy">Privacy Policy</a> | + <a href="/feed.xml">RSS Feed</a></p> + </footer> + </div> + </div> + <!-- container div end --> +</div> + + + </body> + +</html> http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/61d87859/content/feed.xml ---------------------------------------------------------------------- diff --git a/content/feed.xml b/content/feed.xml index 1639c21..b9015ce 100644 --- a/content/feed.xml +++ b/content/feed.xml @@ -6,8 +6,8 @@ </description> <link>http://beam.incubator.apache.org/</link> <atom:link href="http://beam.incubator.apache.org/feed.xml"; rel="self" type="application/rss+xml"/> - <pubDate>Wed, 12 Oct 2016 14:03:58 -0700</pubDate> - <lastBuildDate>Wed, 12 Oct 2016 14:03:58 -0700</lastBuildDate> + <pubDate>Tue, 18 Oct 2016 20:58:20 -0700</pubDate> + <lastBuildDate>Tue, 18 Oct 2016 20:58:20 -0700</lastBuildDate> <generator>Jekyll v3.2.0</generator> <item>
![https://www.apache.org/foundation/press/kit/feather_small.png"](https://www.apache.org/foundation/press/kit/feather_small.png"){kind=link}