ajamato commented on a change in pull request #14477: URL: https://github.com/apache/beam/pull/14477#discussion_r610852574
########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -73,20 +73,33 @@ detail. ### Prerequisites - - 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 + - A GitHub account. Review comment: We should have this page on the it to the Wiki IMO. And consolidate the overlap in Developer Guides tree https://cwiki.apache.org/confluence/display/BEAM/Developer+Guides Java Tips, Python Tips, etc have setup instructions. I recommend making a page on the wiki with setup instructions that setup everything (Java, Python, etc.) Link to the other wiki pages, or port the contents to this main setup page. Also, the wiki is easier to update when you have a suggestion (which I do pretty often). ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -73,20 +73,33 @@ detail. ### Prerequisites - - 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 + - A GitHub account. + - A Linux, macOS, or Microsoft Windows development environment + - Required *only* For Windows: + - Java JDK 8 installed + - [Docker](https://www.docker.com/) installed for some tasks including building worker containers and testing this website + changes locally. + - For SDK Development: + - [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 + - Required *only* For Windows: + - pip, setuptools, virtualenv, and tox installed for Python development Review comment: These tools are also needed on linux/mac. Our python tips section asks you to use them https://cwiki.apache.org/confluence/display/BEAM/Python+Tips I don't think they were automatically installed. I ran the setup instructions on that page a few months ago, and they worked for me. ########## File path: website/www/site/content/en/contribute/_index.md ########## @@ -98,27 +111,44 @@ sudo apt-get install \ docker-ce ``` -On some systems (like Ubuntu 20.04) these need to be installed also +2. On some systems (like Ubuntu 20.04) these need to be installed also + ``` pip3 install grpcio-tools mypy-protobuf ``` -You also need to [install Go](https://golang.org/doc/install). - -Once Go is installed, install goavro: +3. If you you develop in GO: + 1. Install [Go](https://golang.org/doc/install). + 1. Check BEAM repo is in: `$GOPATH/src/github.com/apache/` + 1. At the end, it should look like this: `$GOPATH/src/github.com/apache/beam` +4. Once Go is installed, install goavro: ``` $ export GOPATH=`pwd`/sdks/go/examples/.gogradle/project_gopath $ go get github.com/linkedin/goavro ``` -gLinux users should configure their machines for sudoless Docker. +**Important**: gLinux users should configure their machines for sudoless Docker. + +##### Automated script for Linux and macOS + +You can install these in a Debian-based distribution for Linux or macOs using the [local-env-setup.sh](https://github.com/apache/beam/blob/master/local-env-setup.sh) +script, which is part of the Beam repo: Review comment: I think it would help here if you would please describe which tools the script installs. Or mention that the script will print a message or something about which tools its installing. -- 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]
