Skip to content

Commit

Permalink
Runners and Contribute pages migration (apache#32)
Browse files Browse the repository at this point in the history
* Migrated Runners page

* Migrated Contribute page

* Refactored redirected links
  • Loading branch information
bntnam authored and robertwb committed Apr 30, 2020
1 parent a9266ce commit 1c926d3
Show file tree
Hide file tree
Showing 42 changed files with 2,697 additions and 665 deletions.
2 changes: 1 addition & 1 deletion website/www/site/content/en/blog/capability-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,7 @@ capability-matrix-snapshot:
l2: ''
l3: ''

- name: 'Accumulating & Retracting'
- name: 'Accumulating & Retracting'
values:
- class: model
jira: BEAM-91
Expand Down
55 changes: 24 additions & 31 deletions website/www/site/content/en/contribute/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
---
layout: section
title: "Beam Contribution Guide"
permalink: /contribute/
section_menu: section-menu/contribute.html
redirect_from:
aliases:
- /contribution-guide/
- /contribute/contribution-guide/
- /docs/contribute/
Expand All @@ -28,15 +25,13 @@ limitations under the License.

The Apache Beam community welcomes contributions from anyone!

If you have questions, please [reach out to the Beam community]({{ site.baseurl }}/contribute/get-help).
If you have questions, please [reach out to the Beam community](/contribute/get-help).

There are lots of opportunities to contribute:

- ask or answer questions on [user@beam.apache.org]({{ site.baseurl
}}/community/contact-us/) or
- ask or answer questions on [user@beam.apache.org](/community/contact-us/) or
[stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
- review proposed design ideas on [dev@beam.apache.org]({{ site.baseurl
}}/community/contact-us/)
- review proposed design ideas on [dev@beam.apache.org](/community/contact-us/)
- improve the documentation
- file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
- test releases
Expand Down Expand Up @@ -101,10 +96,10 @@ gLinux users should configure their machines for sudoless Docker.

### Connect With the Beam community

1. Consider subscribing to the [dev@ mailing list]({{ site.baseurl}}/community/contact-us/), especially
1. Consider subscribing to the [dev@ mailing list](/community/contact-us/), especially
if you plan to make more than one change or the change will be large. All decisions happen on the
public dev list.
1. (Optionally) Join the [#beam channel of the ASF slack]({{ site.baseurl}}/community/contact-us/).
1. (Optionally) Join the [#beam channel of the ASF slack](/community/contact-us/).
1. Create an account on [Beam issue tracker (JIRA)](https://issues.apache.org/jira/projects/BEAM/issues)
(anyone can do this).

Expand All @@ -116,15 +111,15 @@ gLinux users should configure their machines for sudoless Docker.
1. If you want to get involved but don't have a project in mind, check our list of open starter tasks,
[https://s.apache.org/beam-starter-tasks](https://s.apache.org/beam-starter-tasks).
1. Assign the issue to yourself. To get the permission to do so, email
the [dev@ mailing list]({{ site.baseurl }}/community/contact-us)
the [dev@ mailing list](/community/contact-us)
to introduce yourself and to be added as a contributor in the Beam issue tracker including your
ASF Jira Username. For example [this welcome email](
https://lists.apache.org/thread.html/e6018c2aaf7dc7895091434295e5b0fafe192b975e3e3761fcf0cda7@%3Cdev.beam.apache.org%3E).
1. If your change is large or it is your first change, it is a good idea to
[discuss it on the dev@ mailing list]({{ site.baseurl }}/community/contact-us/).
[discuss it on the dev@ mailing list](/community/contact-us/).
1. For large changes create a design doc
([template](https://s.apache.org/beam-design-doc-template),
[examples](https://s.apache.org/beam-design-docs)) and email it to the [dev@ mailing list]({{ site.baseurl }}/community/contact-us).
[examples](https://s.apache.org/beam-design-docs)) and email it to the [dev@ mailing list](/community/contact-us).

### Development Setup

Expand Down Expand Up @@ -195,15 +190,15 @@ gLinux users should configure their machines for sudoless Docker.
that start various post-commit tests suites. Use these sparingly because post-commit tests consume shared development resources.

1. Pull requests can only be merged by a
[Beam committer]({{ site.baseurl }}/contribute/team/).
[Beam committer](/contribute/team).
To find a committer for your area, either:
- look in the OWNERS file of the directory where you changed files, or
- look for similar code merges, or
- ask on [dev@beam.apache.org]({{ site.baseurl }}/community/contact-us/)
- ask on [dev@beam.apache.org](/community/contact-us/)

Use `R: @username` in the pull request to notify a reviewer.

1. If you don't get any response in 3 business days, email the [dev@ mailing list]({{ site.baseurl }}/community/contact-us) to ask for someone to look at your pull
1. If you don't get any response in 3 business days, email the [dev@ mailing list](/community/contact-us) to ask for someone to look at your pull
request.

### Make the reviewer's job easier
Expand Down Expand Up @@ -245,41 +240,39 @@ unassigned from the author but will stay open.
Anyone can access it and browse issues. Anyone can register an account and login
to create issues or add comments. Only contributors can be assigned issues. If
you want to be assigned issues, a PMC member can add you to the project contributor
group. Email the [dev@ mailing list]({{ site.baseurl }}/community/contact-us)
group. Email the [dev@ mailing list](/community/contact-us)
to ask to be added as a contributor in the Beam issue tracker, and include your ASF Jira username.

- [Beam Wiki Space](https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam):
Anyone has read access. If you wish to contribute changes, please create an account and request edit access on the
[dev@ mailing list]({{ site.baseurl }}/community/contact-us) (include your Wiki account user ID).
[dev@ mailing list](/community/contact-us) (include your Wiki account user ID).

- Pull requests can only be merged by a
[Beam committer]({{ site.baseurl }}/contribute/team/).
[Beam committer](/contribute/team).

- [Voting on a release](https://www.apache.org/foundation/voting.html): Everyone can vote. Only
[Beam PMC]({{ site.baseurl }}/contribute/team/) members should mark their votes as binding.
[Beam PMC](/contribute/team) members should mark their votes as binding.

## Communication

All communication is expected to align with the [Code of Conduct](https://www.apache.org/foundation/policies/conduct).

Discussion about contributing code to Beam happens on the [dev@ mailing list]({{ site.baseurl
}}/community/contact-us/). Introduce yourself!
Discussion about contributing code to Beam happens on the [dev@ mailing list](/community/contact-us/). Introduce yourself!

Questions can be asked on the [#beam channel of the ASF slack]({{ site.baseurl
}}/community/contact-us/). Introduce yourself!
Questions can be asked on the [#beam channel of the ASF slack](/community/contact-us/). Introduce yourself!

## Additional resources

If you are contributing a `PTransform` to Beam, we have an extensive
[PTransform Style Guide]({{ site.baseurl }}/contribute/ptransform-style-guide).
[PTransform Style Guide](/contribute/ptransform-style-guide).

If you are contributing a Runner to Beam, refer to the
[Runner authoring guide]({{ site.baseurl }}/contribute/runner-guide/)
[Runner authoring guide](/contribute/runner-guide/)

Review [design documents](https://s.apache.org/beam-design-docs).

A great way to contribute is to join an existing effort. For the most
intensive efforts, check out the [roadmap]({{site.baseurl}}/roadmap/).
intensive efforts, check out the [roadmap](/roadmap/).

You can also find a more exhaustive list on the [Beam developers' wiki](
https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam)
Expand All @@ -288,9 +281,9 @@ https://cwiki.apache.org/confluence/display/BEAM/Apache+Beam)

If you run into any issues, check out the [contribution FAQ](
https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ) or ask on
on the [dev@ mailing list]({{ site.baseurl}}/community/contact-us/) or
[#beam channel of the ASF slack]({{ site.baseurl}}/community/contact-us/).
on the [dev@ mailing list](/community/contact-us/) or
[#beam channel of the ASF slack](/community/contact-us/).
----

If you didn't find the information you were looking for in this guide, please
[reach out to the Beam community]({{ site.baseurl }}/community/contact-us).
[reach out to the Beam community](/community/contact-us).
3 changes: 0 additions & 3 deletions website/www/site/content/en/contribute/become-a-committer.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: "Become A Committer"
permalink: /contribute/become-a-committer/
section_menu: section-menu/contribute.html
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
7 changes: 2 additions & 5 deletions website/www/site/content/en/contribute/committer-guide.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: "Beam Committer Guide"
permalink: /contribute/committer-guide/
section_menu: section-menu/contribute.html
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -74,9 +71,9 @@ spotted, even after the merge happens.

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 [here](https://home.apache.org/phonebook.html?unix=committers), as
committers [here](http://home.apache.org/phonebook.html?unix=committers), as
well as [ICLA-signers who aren’t yet
committers](https://home.apache.org/unlistedclas.html).
committers](http://home.apache.org/unlistedclas.html).

For smaller contributions, however, this is not required. In this case, we rely
on [clause five](http://www.apache.org/licenses/LICENSE-2.0#contributions) of
Expand Down
5 changes: 1 addition & 4 deletions website/www/site/content/en/contribute/dependencies.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: 'Dependencies Guide'
section_menu: section-menu/contribute.html
permalink: /contribute/dependencies/
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -92,4 +89,4 @@ __Dependencies of Java SDK components that may cause issues to other components

## Dependency updates and backwards compatibility

Beam releases [adhere to]({{ site.baseurl }}/get-started/downloads/) semantic versioning. Hence, community members should take care when updating dependencies. Minor version updates to dependencies should be backwards compatible in most cases. Some updates to dependencies though may result in backwards incompatible API or functionality changes to Beam. PR reviewers and committers should take care to detect any dependency updates that could potentially introduce backwards incompatible changes to Beam before merging and PRs that update dependencies should include a statement regarding this verification in the form of a PR comment. Dependency updates that result in backwards incompatible changes to non-experimental features of Beam should be held till the next major version release of Beam. Any exceptions to this policy should only occur in extreme cases (for example, due to a security vulnerability of an existing dependency that is only fixed in a subsequent major version) and should be discussed on the Beam dev list. Note that backwards incompatible changes to experimental features may be introduced in a minor version release.
Beam releases [adhere to](/get-started/downloads/) semantic versioning. Hence, community members should take care when updating dependencies. Minor version updates to dependencies should be backwards compatible in most cases. Some updates to dependencies though may result in backwards incompatible API or functionality changes to Beam. PR reviewers and committers should take care to detect any dependency updates that could potentially introduce backwards incompatible changes to Beam before merging and PRs that update dependencies should include a statement regarding this verification in the form of a PR comment. Dependency updates that result in backwards incompatible changes to non-experimental features of Beam should be held till the next major version release of Beam. Any exceptions to this policy should only occur in extreme cases (for example, due to a security vulnerability of an existing dependency that is only fixed in a subsequent major version) and should be discussed on the Beam dev list. Note that backwards incompatible changes to experimental features may be introduced in a minor version release.
8 changes: 4 additions & 4 deletions website/www/site/content/en/contribute/design-documents.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
---
layout: section
title: 'Beam Design Documents'
section_menu: section-menu/contribute.html
permalink: /contribute/design-documents/
redirect_to: https://cwiki.apache.org/confluence/display/BEAM/Design+Documents
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -18,3 +14,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

<!--
This page will be redirected to https://cwiki.apache.org/confluence/display/BEAM/Design+Documents
-->
8 changes: 2 additions & 6 deletions website/www/site/content/en/contribute/feature-branches.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: "Beam Feature Branches"
permalink: /contribute/feature-branches/
section_menu: section-menu/contribute.html
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -34,8 +31,7 @@ thorough and trustworthy.
## Establishing a feature branch

If your project is large enough to need a feature branch, there should
be a discussion on the mailing list. The first step is to [engage]({{
site.baseurl }}/contribute/#connect-with-the-beam-community) there to raise awareness
be a discussion on the mailing list. The first step is to [engage](/contribute/#connect-with-the-beam-community) there to raise awareness
that you want to start a large project. Almost any project should be accepted
-- there is no real cost to letting a feature branch exist -- but you may find
other interested contributors or gain other advice from the community.
Expand All @@ -47,7 +43,7 @@ directly to GitHub or ASF's gitbox.
## Developing on a feature branch

To contribute code on a feature branch, use the same process as in the
[Contribution Guide]({{ site.baseurl}}/contribute/contribution-guide/), but
[Contribution Guide](/contribute/contribution-guide/), but
replace `master` with the name of the feature branch.

Since feature branches are often used for new components, you may find that
Expand Down
9 changes: 3 additions & 6 deletions website/www/site/content/en/contribute/get-help.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: "Get Help Contributing"
permalink: /contribute/get-help/
section_menu: section-menu/contribute.html
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -22,6 +19,6 @@ limitations under the License.

If you have any trouble contributing, don't give up!

- Check the [FAQ on our developers' wiki ![External link to Beam developers' Wiki]({{ site.baseurl }}/images/external-link-icon.png){:width="14px" :height="14px"}](https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ){:target="_blank"}.
- Send email to the Beam developer community on [dev@beam.apache.org]({{ site.baseurl }}/community/contact-us)
- Find someone to chat with in realtime at [#beam on Slack]({{ site.baseurl }}/community/contact-us).
- Check the <a href="https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ" target="_blank">FAQ on our developers' wiki <img src="/images/external-link-icon.png" alt="External link to Beam developers' Wiki" width="14px" height="14px"></a>.
- Send email to the Beam developer community on [dev@beam.apache.org](/community/contact-us)
- Find someone to chat with in realtime at [#beam on Slack](/community/contact-us).
3 changes: 0 additions & 3 deletions website/www/site/content/en/contribute/jira-priorities.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: "Jira Priorities"
permalink: /contribute/jira-priorities/
section_menu: section-menu/contribute.html
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
3 changes: 0 additions & 3 deletions website/www/site/content/en/contribute/postcommits-guides.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: 'Post-commit tests processes guides'
permalink: /contribute/postcommits-guides/
section_menu: section-menu/contribute.html
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: 'Post-commit policies details'
permalink: /contribute/postcommits-policies-details/
section_menu: section-menu/contribute.html
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
21 changes: 9 additions & 12 deletions website/www/site/content/en/contribute/postcommits-policies.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: 'Post-commit tests policies'
section_menu: section-menu/contribute.html
permalink: /contribute/postcommits-policies/
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -36,11 +33,11 @@ to run, and it is often hard to triage test failures.
To ensure that Beam's post-commit tests are reliable and healthy, the Beam
community follows these post-commit test policies:

* [Rollback first]({{ site.baseurl }}/contribute/postcommits-policies-details/index.html#rollback_first)
* [A failing test is a critical bug]({{ site.baseurl }}/contribute/postcommits-policies-details/index.html#failing_test_is_critical_bug)
* [A flaky test is a critical bug]({{ site.baseurl }}/contribute/postcommits-policies-details/index.html#flake_is_failing)
* [Flaky tests must either be fixed or removed]({{ site.baseurl }}/contribute/postcommits-policies-details/index.html#remove_flake)
* [Fixes for post-commit failures should include a corresponding new pre-commit test]({{ site.baseurl }}/contribute/postcommits-policies-details/index.html#precommit_for_postcommit)
* [Rollback first](/contribute/postcommits-policies-details/index.html#rollback_first)
* [A failing test is a critical bug](/contribute/postcommits-policies-details/index.html#failing_test_is_critical_bug)
* [A flaky test is a critical bug](/contribute/postcommits-policies-details/index.html#flake_is_failing)
* [Flaky tests must either be fixed or removed](/contribute/postcommits-policies-details/index.html#remove_flake)
* [Fixes for post-commit failures should include a corresponding new pre-commit test](/contribute/postcommits-policies-details/index.html#precommit_for_postcommit)


## Post-commit test failure scenarios
Expand All @@ -51,13 +48,13 @@ When a post-commit test fails, follow the provided steps for your situation.

1. Create a [JIRA issue](https://s.apache.org/beam-test-failure) and assign it to yourself.
1. Do high level triage of the failure.
1. [Assign the JIRA issue to a relevant person]({{ site.baseurl }}/contribute/postcommits-guides/index.html#find_specialist).
1. [Assign the JIRA issue to a relevant person](/contribute/postcommits-guides/index.html#find_specialist).

### I was assigned a JIRA issue for a test failure {#assigned-failing-test}

1. [Rollback the culprit change]({{ site.baseurl }}/contribute/postcommits-guides/index.html#rollback).
1. [Rollback the culprit change](/contribute/postcommits-guides/index.html#rollback).
1. If you determine that rollback will take longer than 8 hours, [disable the
test temporarily]({{ site.baseurl }}/contribute/postcommits-guides/index.html#disabling) while you rollback or create a
test temporarily](/contribute/postcommits-guides/index.html#disabling) while you rollback or create a
fix.

> Note: Rollback is always the first course of action. If a fix is trivial,
Expand Down Expand Up @@ -87,7 +84,7 @@ If the bug is not in your code, here is how to "create a fix":

1. File a ticket for the existing bug, if it does not already exist.
Remember that
[a flaky test is a critical bug]({{ site.baseurl }}/contribute/postcommits-policies-details/index.html#flake_is_failing). Other
[a flaky test is a critical bug](/contribute/postcommits-policies-details/index.html#flake_is_failing). Other
bad tests are similar: they may fail for arbitrary reasons having nothing
to do with what is being tested, making our signal unreliable.
2. Mark the problematic test to be skipped, with a link to the JIRA ticket.
Expand Down
3 changes: 0 additions & 3 deletions website/www/site/content/en/contribute/precommit-policies.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: "Pre-commit Test Policies"
permalink: /contribute/precommit-policies/
section_menu: section-menu/contribute.html
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
---
layout: section
title: "Pre-commit Slowness Triage Guide"
permalink: /contribute/precommit-triage-guide/
section_menu: section-menu/contribute.html
---
<!--
Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
Loading

0 comments on commit 1c926d3

Please sign in to comment.