Uploaded image for project: 'Beam'
  1. Beam
  2. BEAM-8798

Contributing docs omit many steps

Details

    • Bug
    • Status: Open
    • P3
    • Resolution: Unresolved
    • 2.16.0
    • None
    • website
    • None

    Description

      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.

      Attachments

        Activity

          People

            Unassigned Unassigned
            elharo Elliotte Rusty Harold
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated: