[jira] [Commented] (BEAM-8798) Contributing docs omit many steps

["Tomo Suzuki (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/BEAM-8798?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16979374#comment-16979374 ] 

Tomo Suzuki commented on BEAM-8798:
-----------------------------------

[https://beam.apache.org/contribute/] says
{quote}Prerequisites
 To contribute code, you need

a GitHub account
 a Linux, macOS, or Microsoft Windows development environment with Java JDK 8 installed
 Docker installed for some tasks including building worker containers and testing website changes locally
 Go 1.10 or later installed for Go SDK development
 Python, virtualenv, and tox installed for Python SDK development
{quote}
 

This lacks

-Docker needed for clickhouse testing (sdks/java/io/clickhouse)

-version info for Python and its libraries. 

 

> Contributing docs omit many steps
> ---------------------------------
>
>                 Key: BEAM-8798
>                 URL: https://issues.apache.org/jira/browse/BEAM-8798
>             Project: Beam
>          Issue Type: Bug
>          Components: website
>    Affects Versions: 2.16.0
>            Reporter: Elliotte Rusty Harold
>            Priority: Major
>
> So far I've noticed the following packages and tools that are not available by default on a Debian system, need to be installed to build and test beam, and are not yet mentioned in all our docs:
> * tox
> * Go
> * Python (which versions?)
> * Docker
> There might be more. The docs such as README.md should be updated to include these. This covers README.md, CONTRIBUTING.md, https://cwiki.apache.org/confluence/display/BEAM/Contributor+FAQ, and https://beam.apache.org/contribute/
> That we have four such docs is itself an issue. We should probably consolidate these. 



--
This message was sent by Atlassian Jira
(v8.3.4#803005)