You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2020/12/17 22:12:38 UTC
[GitHub] [beam] TheNeuralBit commented on a change in pull request #13565: [BEAM-11424-11423-11368][Website revamp] Implemented contribution guide, become a committer pages and twitter feed
TheNeuralBit commented on a change in pull request #13565:
URL: https://github.com/apache/beam/pull/13565#discussion_r545429399
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,57 +22,65 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+</br>
+
+<div class="arrow-lists-desktop">
+
+## Overview
-The Apache Beam community welcomes contributions from anyone!
+</br>
-If you have questions, please [reach out to the Beam community](/contribute/get-help).
+There are lots of opportunities to contribute. You can for example:
-There are lots of opportunities to contribute:
+<div class="arrow-list">
- - 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](/community/contact-us/)
- - improve the documentation
- - file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
- - test releases
- - review [changes](https://github.com/apache/beam/pulls)
- - write new examples
- - improve your favorite language SDK (Java, Python, Go, etc)
- - improve specific runners (Apache Flink, Apache Spark, Google
- Cloud Dataflow, etc)
- - improve or add IO connectors
- - add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
- - improve the developer experience (for example, Windows guides)
- - add answers to the [contribution FAQ](
- https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ)
- - organize local meetups of users or contributors to Apache Beam
+- 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](/community/contact-us/)
+- file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
+- review [changes](https://github.com/apache/beam/pulls)
+- work on the core programming model (what is a Beam pipeline and how does it
+ run?)
+- improve the developer experience (for example, Windows guides)
+- organize local meetups of users or contributors to Apache Beam
-Most importantly, if you have an idea of how to contribute, then do it!
+</div>
+
+...and many more. Most importantly, if you have an idea of how to contribute, then do it!
+
+</br>
## Contributing code
+</br>
+
Below is a tutorial for contributing code to Beam, covering our tools and typical process in
detail.
+</br>
+
### Prerequisites
-To contribute code, you need
+<div class="arrow-list">
+
+- a GitHub account
+- a Linux, macOS, or Microsoft Windows development environment with Java JDK 8 installed
+- [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website
+ changes locally
+- [Go](https://golang.org) 1.12 or later installed for Go SDK development
+- Python 3.6, 3.7, and 3.8. Yes, you need all four versions installed.
+
+ pip, setuptools, virtualenv, and tox installed for Python development
+
+- for large contributions, a signed [Individual Contributor License
+ Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
+ Software Foundation (ASF).
- - a GitHub account
- - a Linux, macOS, or Microsoft Windows development environment with Java JDK 8 installed
- - [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website
- changes locally
- - [Go](https://golang.org) 1.12 or later installed for Go SDK development
- - Python 3.6, 3.7, and 3.8. Yes, you need all three versions installed.
- - pip, setuptools, virtualenv, and tox installed for Python development
- - for large contributions, a signed [Individual Contributor License
- Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
- Software Foundation (ASF).
+</div>
Review comment:
Is it possible to get the appearance we want without making changes to the content?
1) It will be a challenge to avoid merge conflicts between the `website-revamp` branch and `master` if we start making changes to content
2) Appearance should be as independent from content as possible (i.e. we shouldn't have `<div>`s and `<br>`s in the markdown)
The biggest change in this page is making all the bulleted lists use "arrow-list", and adding some extra `<br>`s, maybe that could be done with a custom layout instead?
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,57 +22,65 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+</br>
+
+<div class="arrow-lists-desktop">
+
+## Overview
-The Apache Beam community welcomes contributions from anyone!
+</br>
-If you have questions, please [reach out to the Beam community](/contribute/get-help).
+There are lots of opportunities to contribute. You can for example:
-There are lots of opportunities to contribute:
+<div class="arrow-list">
- - 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](/community/contact-us/)
- - improve the documentation
- - file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
- - test releases
- - review [changes](https://github.com/apache/beam/pulls)
- - write new examples
- - improve your favorite language SDK (Java, Python, Go, etc)
- - improve specific runners (Apache Flink, Apache Spark, Google
- Cloud Dataflow, etc)
- - improve or add IO connectors
- - add new transform libraries (statistics, ML, image processing, etc)
- - work on the core programming model (what is a Beam pipeline and how does it
- run?)
- - improve the developer experience (for example, Windows guides)
- - add answers to the [contribution FAQ](
- https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ)
- - organize local meetups of users or contributors to Apache Beam
+- 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](/community/contact-us/)
+- file [bug reports](https://issues.apache.org/jira/projects/BEAM/issues)
+- review [changes](https://github.com/apache/beam/pulls)
+- work on the core programming model (what is a Beam pipeline and how does it
+ run?)
+- improve the developer experience (for example, Windows guides)
+- organize local meetups of users or contributors to Apache Beam
-Most importantly, if you have an idea of how to contribute, then do it!
+</div>
+
+...and many more. Most importantly, if you have an idea of how to contribute, then do it!
+
+</br>
## Contributing code
+</br>
+
Below is a tutorial for contributing code to Beam, covering our tools and typical process in
detail.
+</br>
+
### Prerequisites
-To contribute code, you need
+<div class="arrow-list">
+
+- a GitHub account
+- a Linux, macOS, or Microsoft Windows development environment with Java JDK 8 installed
+- [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website
+ changes locally
+- [Go](https://golang.org) 1.12 or later installed for Go SDK development
+- Python 3.6, 3.7, and 3.8. Yes, you need all four versions installed.
+
+ pip, setuptools, virtualenv, and tox installed for Python development
+
+- for large contributions, a signed [Individual Contributor License
+ Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
+ Software Foundation (ASF).
- - a GitHub account
- - a Linux, macOS, or Microsoft Windows development environment with Java JDK 8 installed
- - [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website
- changes locally
- - [Go](https://golang.org) 1.12 or later installed for Go SDK development
- - Python 3.6, 3.7, and 3.8. Yes, you need all three versions installed.
- - pip, setuptools, virtualenv, and tox installed for Python development
- - for large contributions, a signed [Individual Contributor License
- Agreement](https://www.apache.org/licenses/icla.pdf) (ICLA) to the Apache
- Software Foundation (ASF).
+</div>
Review comment:
Any changes to the actual content of the page should be done on master, instead of on the website-revamp branch
##########
File path: website/www/site/content/en/contribute/become-a-committer.md
##########
@@ -15,83 +16,31 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-# Become a Committer
-
-An Apache Beam
-[committer](https://www.apache.org/foundation/how-it-works.html#committers) has
-write access to the repository for merging pull requests, but you don't have
-to be a code contributor to become a committer. Becoming a committer means that
-you have the project's trust. Read the [ASF
-documentation](https://www.apache.org/dev/committers.html#committer-responsibilities)
-for more about being a committer in the Apache Software Foundation.
-
-The [PMC](https://www.apache.org/foundation/how-it-works.html#pmc-members)
-makes someone a committer via nomination, discussion, and then majority vote.
-We use data from as many sources as possible to inform our reasoning. Here are
-some examples:
-
- - [dev@ archives](https://lists.apache.org/list.html?dev@beam.apache.org) and [statistics](https://lists.apache.org/trends.html?dev@beam.apache.org)
- - [user@ archives](https://lists.apache.org/list.html?user@beam.apache.org) and [statistics](https://lists.apache.org/trends.html?user@beam.apache.org)
- - [`apache-beam` StackOverflow tag](https://stackoverflow.com/questions/tagged/apache-beam)
- - Git metrics for [Beam](https://github.com/apache/beam/graphs/contributors)
- - Code reviews given and received on
- [Beam](https://github.com/apache/beam/pulls)
- - Clear areas of ownership (a runner, a DSL, IO connector, documentation,
- etc.)
- - Public events
- - Firsthand PMC testimonials
-
-The PMC has assembled the following set of guidelines for becoming a committer.
-
-## An Apache Beam committer...
-
-### Takes many forms
-
-There are many actions other than coding that build the trust we place in a
-committer - code review, design discussion, user support, community outreach, improving
-infrastructure, documentation, project management, etc.
-
-### Knows, upholds, and reinforces the Apache Software Foundation code of conduct
-
-See the [ASF
-documentation](https://www.apache.org/foundation/policies/conduct.html). In
-particular, they manifestly strive to:
-
- - Be open
- - Be empathetic
- - Be welcoming
- - Be friendly
- - Be patient
- - Be collaborative
- - Be inquisitive
- - Be careful in the words that they choose
-
-### Knows, upholds, and reinforces the responsibilities of an Apache Software Foundation committer
-
-See the [ASF documentation](https://www.apache.org/dev/committers.html#committer-responsibilities).
-
- - They help create a product that will outlive the interest of any particular
- volunteer (including themselves)
- - They grow and maintain the health of the Apache community
- - They help out with surrounding work, such as the website & documentation
- - They help users
- - They can be trusted to decide when code is ready for release, or when to ask
- someone else to make the judgment
- - They can be trusted to decide when to merge code (if a code contributor) or
- when to ask someone else to make the judgment
-
-### Knows, upholds, and reinforces the Beam community’s practices
-
- - They have a proven commitment to the project
- - They share their intentions with the community
- - They accept and integrate community feedback in their plans, designs,
- code, etc.
- - They earnestly try to make Beam better with their contributions
- - In particular, if a code contributor:
- - They earnestly try to make Beam better with their own code
- - They earnestly try to make Beam better with code review
- - They accept and integrate feedback on their code
- - They know, follow, and enforce Beam’s practices while
- reviewing/merging code - style, documentation, testing, backward
- compatibility, etc.
+# Become a Beam Committer
+
+</br>
+
+An Apache Beam [committer](https://www.apache.org/foundation/how-it-works.html#committers) takes many forms. There are many actions other than coding that build the trust we place in a committer - code review, design discussion, user support, community outreach, improving infrastructure, documentation, project management, etc.
+
+</br>
+
+### What does it mean being a commiter?
Review comment:
```suggestion
### What does it mean being a committer?
```
This mistake is in a few places, including in the path ` website/www/site/assets/icons/contributor/become a commiter/`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org