Apache Beam (incubating) provides a portable API layer for building sophisticated data-parallel processing engines that may be executed across a diversity of exeuction engines, or runners. The core concepts of this layer are based upon the Beam Model (formerly referred to as the Dataflow Model), and implemented to varying degrees in each Beam runner. To help clarify the capabilities of individual runners, we’ve created the capability matrix below.

- - - The Apache Beam project is in the process of bootstrapping. This includes the creation of project resources, the refactoring of the initial code submission, and the formulation of project documentation, planning, and design documents. For more information about Beam see the getting started page. -

+ + +The Apache Beam project is in the process of bootstrapping. This includes the creation of project resources, the refactoring of the initial code submission, and the formulation of project documentation, planning, and design documents. For more information about Beam see the getting started page. +

Documentation Coming Soon

@@ -112,7 +110,6 @@

Go Back to the main Beam site.

http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/2a61d388/content/contribution-guide/index.html ---------------------------------------------------------------------- diff --git a/content/contribution-guide/index.html b/content/contribution-guide/index.html index c4e22a7..28a08c8 100644 --- a/content/contribution-guide/index.html +++ b/content/contribution-guide/index.html @@ -174,9 +174,9 @@

Engage

Mailing list(s)

We discuss design and implementation issues on dev@beam.incubator.apache.org mailing list, which is archived here. Join by emailing dev-subscribe@beam.incubator.apache.org.

If interested, you can also join user@beam.incubator.apache.org and commits@beam.incubator.apache.org too.

Apache JIRA

We use Apache JIRA 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.

@@ -223,9 +223,10 @@

Clone Beam’s read-only GitHub mirror.

$ git clone https://github.com/apache/incubator-beam.git
+$ git clone https://github.com/apache/incubator-beam.git
 $ cd incubator-beam
 
+
 
 Add your forked repository as an additional Git remote, where you’ll push your changes.
 
@@ -234,7 +235,7 @@ $ cd incubator-beam
 You are now ready to start developing!
 
 Create a branch in your fork
-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 master, feature-specific, and release-specific branches. If you are unsure, initialize with the state of the master branch.
+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 master, feature-specific, and release-specific branches. If you are unsure, initialize with the state of the master branch.
 
 $ git fetch --all
 $ git checkout -b <my-branch> origin/master
@@ -244,10 +245,11 @@ $ git checkout -b <my-branch> origin/master

Syncing and pushing your branch

Periodically while you work, and certainly before submitting a pull request, you should update your branch with the most recent changes to the target branch.

$ git pull --rebase
+$ git pull --rebase
 
+
 
-Remember to always use --rebase parameter to avoid extraneous merge commits.
+Remember to always use --rebase parameter to avoid extraneous merge commits.
 
 To push your local, committed changes to your (forked) repository on GitHub, run:
 
@@ -258,8 +260,9 @@ $ git checkout -b <my-branch> origin/master

For contributions to the Java code, run unit tests locally via Maven. Alternatively, you can use Travis-CI.

$ mvn clean verify
+$ mvn clean verify
 
+
 
 Review
 Once the initial code is complete and the tests pass, it’s time to start the code review process. We review and discuss all code, no matter who authors it. It’s a great way to build community, since you can learn from other developers, and they become familiar with your contribution. It also builds a strong project by encouraging a high quality bar and keeping code consistent throughout the project.
@@ -267,8 +270,9 @@ $ git checkout -b <my-branch> origin/master

Create a pull request

Organize your commits to make your reviewer’s job easier. Use the following command to re-order, squash, edit, or change description of individual commits.

$ git rebase -i origin/master
+$ git rebase -i origin/master
 
+
 
 Navigate to the Beam GitHub mirror to create a pull request. The title of the pull request should be strictly in the following format:
 
@@ -315,19 +319,22 @@ $ git push <GitHub_user> --delete <my-branch>One-time Setup
 Add the Apache Git remote in your local clone, by running:
 
-$ git remote add apache https://git-wip-us.apache.org/repos/asf/incubator-beam.git
+$ git remote add apache https://git-wip-us.apache.org/repos/asf/incubator-beam.git
 
+
 
-We recommend renaming the origin remote to github, to avoid confusion when dealing with this many remotes.
+We recommend renaming the origin remote to github, to avoid confusion when dealing with this many remotes.
 
-$ git remote rename origin github
+$ git remote rename origin github
 
+
 
-For the github remote, add an additional fetch reference, which will cause every pull request to be made available as a remote branch in your workspace.
+For the github remote, add an additional fetch reference, which will cause every pull request to be made available as a remote branch in your workspace.
 
-$ git config --local --add remote.github.fetch \
+$ git config --local --add remote.github.fetch \
     '+refs/pull/*/head:refs/remotes/github/pr/*'
 
+
 
 You can confirm your configuration by running the following command.
 
@@ -364,10 +371,11 @@ $ git checkout -b finish-pr-<pull-request-#> github/pr/<pull-
   Reorganize commits that are part of the pull request, such as squash them into fewer commits that make sense for a historical perspective.
 
 
-You will often need the following command, assuming you’ll be merging changes into the master branch:
+You will often need the following command, assuming you’ll be merging changes into the master branch:
 
-$ git rebase -i apache/master
+$ git rebase -i apache/master
 
+
 
 Please make sure to retain authorship of original commits to give proper credit to the contributor. You are welcome to change their commits slightly (e.g., fix a typo) and squash them, but more substantive changes should be a separate commit and review.
 
@@ -380,12 +388,13 @@ $ git merge --no-ff \
     -m $'[BEAM-<JIRA-issue-#>] <Title>\n\nThis closes #<pull-request-#>' \
     finish-pr-<pull-request-#>
 
-Always use --no-ff 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.
+Always use --no-ff 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.
 
-At this point, you want to ensure everything is right. Test it with mvn verify. Run gitk or git log --graph, etc. When you are happy with how it looks, push it. This is the point of no return – proceed with caution.
+At this point, you want to ensure everything is right. Test it with mvn verify. Run gitk or git log --graph, etc. When you are happy with how it looks, push it. This is the point of no return – proceed with caution.
 
-$ git push apache HEAD:master
+$ git push apache HEAD:master
 
+
 
 Done. You can delete the local finish-pr-<pull-request-#> branch if you like.
 

http://git-wip-us.apache.org/repos/asf/incubator-beam-site/blob/2a61d388/content/docs/index.html
----------------------------------------------------------------------
diff --git a/content/docs/index.html b/content/docs/index.html
index ba64568..7327bed 100644
--- a/content/docs/index.html
+++ b/content/docs/index.html
@@ -98,13 +98,11 @@
     
 
       
-        
-  

-  
-  
-  The Apache Beam project is in the process of bootstrapping. This includes the creation of project resources, the refactoring of the initial code submission, and the formulation of project documentation, planning, and design documents. For more information about Beam see the getting started page.
-  
-
+        
+
+
+The Apache Beam project is in the process of bootstrapping. This includes the creation of project resources, the refactoring of the initial code submission, and the formulation of project documentation, planning, and design documents. For more information about Beam see the getting started page.
+
 
 Apache Beam Documentation

Apache Beam Capability Matrix

Documentation Coming Soon

Engage

Mailing list(s)

Apache JIRA

Create a branch in your fork

Syncing and pushing your branch

Review

Create a pull request

Apache Beam Documentation