[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=371346&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-371346 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 14/Jan/20 04:18 Start Date: 14/Jan/20 04:18 Worklog Time Spent: 10m Work Description: kennknowles commented on issue #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#issuecomment-573992574 Ah, sorry. I somehow failed to send my comment, which was that we should keep `CONTRIBUTING.md` just to have a pointer to the primary instructions. This file is treated specially by GitHub. It is not terribly important. I don't know the real impact. 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 371346) Time Spent: 3h (was: 2h 50m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Assignee: elharo >Priority: Major > Fix For: Not applicable > > Time Spent: 3h > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=370684&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-370684 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Jan/20 09:48 Start Date: 13/Jan/20 09:48 Worklog Time Spent: 10m Work Description: iemejia commented on issue #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#issuecomment-573580737 Done, merged manually. Thanks for the reminder @aaltay and sorry @elharo for taking so long on merging this. Thanks for taking care of this. 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 370684) Time Spent: 2h 50m (was: 2h 40m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Assignee: elharo >Priority: Major > Fix For: Not applicable > > Time Spent: 2h 50m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=370683&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-370683 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Jan/20 09:46 Start Date: 13/Jan/20 09:46 Worklog Time Spent: 10m Work Description: iemejia commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 370683) Time Spent: 2h 40m (was: 2.5h) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Assignee: elharo >Priority: Major > Time Spent: 2h 40m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=370682&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-370682 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Jan/20 09:46 Start Date: 13/Jan/20 09:46 Worklog Time Spent: 10m Work Description: iemejia commented on issue #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#issuecomment-573580737 Done, merged manually. Thanks for the reminder @aaltay and sorry @elharo for taking so long on merging this. I suppose next step is to move to the wiki, is it? In any case thanks for taking care of this. 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 370682) Time Spent: 2.5h (was: 2h 20m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Assignee: elharo >Priority: Major > Time Spent: 2.5h > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=369953&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-369953 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 10/Jan/20 17:59 Start Date: 10/Jan/20 17:59 Worklog Time Spent: 10m Work Description: aaltay commented on issue #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#issuecomment-573141407 @iemejia @kennknowles could you please review this PR? 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 369953) Time Spent: 2h 20m (was: 2h 10m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Assignee: elharo >Priority: Major > Time Spent: 2h 20m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=364738&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-364738 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 30/Dec/19 20:01 Start Date: 30/Dec/19 20:01 Worklog Time Spent: 10m Work Description: suztomo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r362082634 ## File path: website/src/contribute/index.md ## @@ -89,6 +89,13 @@ sudo apt-get install \ You also need to [install Go](https://golang.org/doc/install]). +Once Go is installed, install goavro: + +``` +$ export GOPATH=`pwd`/sdks/go/examples/.gogradle/project_gopath +$ go get github.com/linkedin/goavro Review comment: Thank you for picking up my comment. 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 364738) Time Spent: 2h 10m (was: 2h) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Assignee: elharo >Priority: Major > Time Spent: 2h 10m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359473&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359473 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 16:04 Start Date: 13/Dec/19 16:04 Worklog Time Spent: 10m Work Description: elharo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357715534 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 Review comment: done 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359473) Time Spent: 2h (was: 1h 50m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 2h > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359436&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359436 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 15:01 Start Date: 13/Dec/19 15:01 Worklog Time Spent: 10m Work Description: suztomo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357685550 ## File path: README.md ## @@ -106,7 +94,8 @@ To get involved in Apache Beam: * [Subscribe](mailto:dev-subscr...@beam.apache.org) or [mail](mailto:d...@beam.apache.org) the [d...@beam.apache.org](http://mail-archives.apache.org/mod_mbox/beam-dev/) list. * Report issues on [JIRA](https://issues.apache.org/jira/browse/BEAM). -We also have a [contributor's guide](https://beam.apache.org/contribute/contribution-guide/). +Instructions for building and testing Beam itself +are in the [contributor's guide](CONTRIBUTING.md). Review comment: Kenn responded to the email thread to have CONTRIBUTING.md link to https://beam.apache.org/contribute/contribution-guide/ 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359436) Time Spent: 1h 40m (was: 1.5h) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 1h 40m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359437&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359437 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 15:01 Start Date: 13/Dec/19 15:01 Worklog Time Spent: 10m Work Description: suztomo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357684967 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 +* pip +* setuptools +* Go 1.12 or later +* virtualenv +* tox +* Docker + +To install these in a Debian-based distribution: + +``` +sudo apt-get install \ +openjdk-8-jdk \ +python-setuptools \ +python-pip \ +virtualenv \ +tox \ +docker-ce Review comment: Thanks. 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359437) Time Spent: 1h 50m (was: 1h 40m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 1h 50m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359435&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359435 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 15:01 Start Date: 13/Dec/19 15:01 Worklog Time Spent: 10m Work Description: suztomo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357684888 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 Review comment: Python 3.5, 3.6, and 3.7. ``` suztomo-macbookpro44:beam suztomo$ find . -name 'py33' suztomo-macbookpro44:beam suztomo$ find . -name 'py34' suztomo-macbookpro44:beam suztomo$ find . -name 'py35' ./sdks/python/container/py35 ./sdks/python/test-suites/dataflow/py35 ./sdks/python/test-suites/tox/py35 ./sdks/python/test-suites/direct/py35 ./sdks/python/test-suites/portable/py35 suztomo-macbookpro44:beam suztomo$ find . -name 'py36' ./sdks/python/container/py36 ./sdks/python/test-suites/dataflow/py36 ./sdks/python/test-suites/tox/py36 ./sdks/python/test-suites/direct/py36 ./sdks/python/test-suites/portable/py36 suztomo-macbookpro44:beam suztomo$ find . -name 'py37' ./sdks/python/container/py37 ./sdks/python/test-suites/dataflow/py37 ./sdks/python/test-suites/tox/py37 ./sdks/python/test-suites/direct/py37 ./sdks/python/test-suites/portable/py37 suztomo-macbookpro44:beam suztomo$ find . -name 'py38' suztomo-macbookpro44:beam suztomo$ 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359435) Time Spent: 1.5h (was: 1h 20m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 1.5h > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359334&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359334 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 12:21 Start Date: 13/Dec/19 12:21 Worklog Time Spent: 10m Work Description: elharo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357619080 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 +* pip +* setuptools +* Go 1.12 or later Review comment: done 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359334) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 50m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359333&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359333 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 12:21 Start Date: 13/Dec/19 12:21 Worklog Time Spent: 10m Work Description: elharo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357619051 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 Review comment: Any idea which versions are supported/required? 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359333) Time Spent: 50m (was: 40m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 50m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359336&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359336 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 12:21 Start Date: 13/Dec/19 12:21 Worklog Time Spent: 10m Work Description: elharo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357620333 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 +* pip +* setuptools +* Go 1.12 or later +* virtualenv +* tox +* Docker + +To install these in a Debian-based distribution: + +``` +sudo apt-get install \ +openjdk-8-jdk \ +python-setuptools \ +python-pip \ +virtualenv \ +tox \ +docker-ce Review comment: Go can't be installed by apt-get. Added pointer to instructions. 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359336) Time Spent: 1h 10m (was: 1h) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 1h 10m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359335&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359335 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 12:21 Start Date: 13/Dec/19 12:21 Worklog Time Spent: 10m Work Description: elharo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357620553 ## File path: README.md ## @@ -106,7 +94,8 @@ To get involved in Apache Beam: * [Subscribe](mailto:dev-subscr...@beam.apache.org) or [mail](mailto:d...@beam.apache.org) the [d...@beam.apache.org](http://mail-archives.apache.org/mod_mbox/beam-dev/) list. * Report issues on [JIRA](https://issues.apache.org/jira/browse/BEAM). -We also have a [contributor's guide](https://beam.apache.org/contribute/contribution-guide/). +Instructions for building and testing Beam itself +are in the [contributor's guide](CONTRIBUTING.md). Review comment: One or the other of these is going away. I'm not sure which yet. 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359335) Time Spent: 1h (was: 50m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 1h > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359337&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359337 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 12:21 Start Date: 13/Dec/19 12:21 Worklog Time Spent: 10m Work Description: elharo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357619293 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 +* pip +* setuptools +* Go 1.12 or later +* virtualenv +* tox +* Docker + +To install these in a Debian-based distribution: Review comment: I think it should work with any reasonably recent debian. I'm going to assume that until told otherwise. 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359337) Time Spent: 1h 20m (was: 1h 10m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 1h 20m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359099&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359099 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 02:51 Start Date: 13/Dec/19 02:51 Worklog Time Spent: 10m Work Description: suztomo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357464284 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 +* pip +* setuptools +* Go 1.12 or later +* virtualenv +* tox +* Docker + +To install these in a Debian-based distribution: + +``` +sudo apt-get install \ +openjdk-8-jdk \ +python-setuptools \ +python-pip \ +virtualenv \ +tox \ +docker-ce Review comment: Where is Go 1.12? 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359099) Time Spent: 40m (was: 0.5h) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 40m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359098&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359098 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 02:51 Start Date: 13/Dec/19 02:51 Worklog Time Spent: 10m Work Description: suztomo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357464125 ## File path: README.md ## @@ -106,7 +94,8 @@ To get involved in Apache Beam: * [Subscribe](mailto:dev-subscr...@beam.apache.org) or [mail](mailto:d...@beam.apache.org) the [d...@beam.apache.org](http://mail-archives.apache.org/mod_mbox/beam-dev/) list. * Report issues on [JIRA](https://issues.apache.org/jira/browse/BEAM). -We also have a [contributor's guide](https://beam.apache.org/contribute/contribution-guide/). +Instructions for building and testing Beam itself +are in the [contributor's guide](CONTRIBUTING.md). Review comment: This line is going to name CONTRIBUTING.md as “contributor’s guide”, which conflicts with the page in the wiki. How about just naming “CONTRIBUTING.md”? 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359098) Time Spent: 0.5h (was: 20m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 0.5h > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359100&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359100 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 02:51 Start Date: 13/Dec/19 02:51 Worklog Time Spent: 10m Work Description: suztomo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357465833 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 +* pip +* setuptools +* Go 1.12 or later +* virtualenv +* tox +* Docker + +To install these in a Debian-based distribution: Review comment: It would be great if you can specify debian release version you used, such as Debian 9 Stretch. The availability of package differ based on the version. 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359100) Time Spent: 40m (was: 0.5h) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 40m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359096&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359096 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 02:51 Start Date: 13/Dec/19 02:51 Worklog Time Spent: 10m Work Description: suztomo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357463126 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 +* pip +* setuptools +* Go 1.12 or later Review comment: Would you group the tools by programming languages (Java, Python, Go)? 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359096) Time Spent: 20m (was: 10m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 20m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=359097&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-359097 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 13/Dec/19 02:51 Start Date: 13/Dec/19 02:51 Worklog Time Spent: 10m Work Description: suztomo commented on pull request #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#discussion_r357463203 ## File path: CONTRIBUTING.md ## @@ -27,3 +27,29 @@ for details, such as: * Development setup and testing your changes * Submitting a pull request and finding a reviewer +To build and install the whole project from the source distribution, +you need additional tools installed in your system including: + +* JDK 8 or later +* Python 3 Review comment: Would you clarify which Python 3? (3.4, 3.7, etc.?) 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 359097) Time Spent: 0.5h (was: 20m) > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 0.5h > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Work logged] (BEAM-8956) Unify Contributor Docs
[ https://issues.apache.org/jira/browse/BEAM-8956?focusedWorklogId=358634&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-358634 ] ASF GitHub Bot logged work on BEAM-8956: Author: ASF GitHub Bot Created on: 12/Dec/19 12:11 Start Date: 12/Dec/19 12:11 Worklog Time Spent: 10m Work Description: elharo commented on issue #10366: [BEAM-8956] Begin unifying contributor instructions into a single location URL: https://github.com/apache/beam/pull/10366#issuecomment-564981483 R: @iemejia 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: us...@infra.apache.org Issue Time Tracking --- Worklog Id: (was: 358634) Remaining Estimate: 0h Time Spent: 10m > Unify Contributor Docs > -- > > Key: BEAM-8956 > URL: https://issues.apache.org/jira/browse/BEAM-8956 > Project: Beam > Issue Type: Bug > Components: website >Affects Versions: 2.18.0 >Reporter: elharo >Priority: Major > Time Spent: 10m > Remaining Estimate: 0h > > Right now we have overlapping and sometimes contradictory docs on how to > setup and build BEAM in four different places I've found: > > README.md > CONTRIBUTING.md > [https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ] > [https://beam.apache.org/contribute/] > > We should probably pick one as the source of truth and rewrite the > other three to simply point to it. I propose putting all checkout, > build, test, commit, and push instructions in CONTRIBUTING.md in the > repo. -- This message was sent by Atlassian Jira (v8.3.4#803005)
