TheNeuralBit commented on a change in pull request #13565:
URL: https://github.com/apache/beam/pull/13565#discussion_r570314467
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
+
+## Overview
+
+</a>
+
+<div class="collapse dont-collapse-sm" id="collapseOverview">
-The Apache Beam community welcomes contributions from anyone!
+There are lots of opportunities to contribute. You can for example:
-If you have questions, please [reach out to the Beam
community](/contribute/get-help).
+* ask or answer questions on [[email protected]](/community/contact-us/) or
+ [stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
+* review proposed design ideas on
[[email protected]](/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
-There are lots of opportunities to contribute:
+...and many more. Most importantly, if you have an idea of how to contribute,
then do it!
Review comment:
This `...` doesn't render correctly:
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
+
+## Overview
+
+</a>
+
+<div class="collapse dont-collapse-sm" id="collapseOverview">
-The Apache Beam community welcomes contributions from anyone!
+There are lots of opportunities to contribute. You can for example:
-If you have questions, please [reach out to the Beam
community](/contribute/get-help).
+* ask or answer questions on [[email protected]](/community/contact-us/) or
+ [stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
+* review proposed design ideas on
[[email protected]](/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
-There are lots of opportunities to contribute:
+...and many more. Most importantly, if you have an idea of how to contribute,
then do it!
- - ask or answer questions on [[email protected]](/community/contact-us/) or
-[stackoverflow](https://stackoverflow.com/questions/tagged/apache-beam)
- - review proposed design ideas on
[[email protected]](/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
+</div>
-Most importantly, if you have an idea of how to contribute, then do it!
+<a class="arrow-list-header" data-toggle="collapse"
href="#collapseContributing" role="button" aria-expanded="false"
aria-controls="collapseContributing">
+ {{< figure src="/images/arrow-icon_list.svg">}}
## Contributing code
+ </a>
+
+<div class="collapse dont-collapse-sm" id="collapseContributing">
+
Below is a tutorial for contributing code to Beam, covering our tools and
typical process in
detail.
### Prerequisites
-To contribute code, you need
+* 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).
Review comment:
Can we just keep this section the same as it was before? The change
doesn't seem to be substantive, just changing bullet points.
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -97,16 +107,7 @@ $ export
GOPATH=`pwd`/sdks/go/examples/.gogradle/project_gopath
$ go get github.com/linkedin/goavro
```
-gLinux users should configure their machines for sudoless Docker.
-
-Alternatively, you can use the Docker based local development environment to
wrap your clone of the Beam repo
-into a container meeting the requirements above.
-
-You can start this container using the
[start-build-env.sh](https://github.com/apache/beam/blob/master/start-build-env.sh)
-script which is part of the Beam repo:
-```
-./start-build-env.sh
-```
Review comment:
This section is missing in the new version.
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -21,55 +24,61 @@ See the License for the specific language governing
permissions and
limitations under the License.
-->
-# Apache Beam Contribution Guide
+# Contribution guide
+
+<a class="arrow-list-header" data-toggle="collapse" href="#collapseOverview"
role="button" aria-expanded="false" aria-controls="collapseOverview">
+ {{< figure src="/images/arrow-icon_list.svg">}}
Review comment:
Can you confirm that these expand buttons are working as intended? The
behavior seems odd to me.
On desktop:
- Content is always expanded, no arrow shows up. This could be intentional,
but also ...
- The headings look like links, and when I hover the underline goes away,
but its not actually clickable.
On mobile:
- The contributing code section only collapses to down to "To install these
in a debian-based distribution"
##########
File path: website/www/site/content/en/contribute/_index.md
##########
@@ -127,173 +128,9 @@ script which is part of the Beam repo:
1. Assign the issue to yourself. To get the permission to do so, email
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).
+ 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](/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](/community/contact-us).
-
-### Development Setup {#development-setup}
-
-1. If you need help with git forking, cloning, branching, committing, pull
requests, and squashing commits, see
- [Git workflow
tips](https://cwiki.apache.org/confluence/display/BEAM/Git+Tips)
-1. Familiarize yourself with gradle and the project structure. At the root of
the git repository, run:
Review comment:
I don't think that's a good idea. Before we remove a completele remove a
section there should be a discussion on the mailing list to make sure the
community agrees this section isn't valuable.
Could you leave it in for now? We can file a follow-up jira to consider
removing it.
----------------------------------------------------------------
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:
[email protected]
