1301590 - Add more setup documentation

Status: RESOLVED FIXED

(MozReview Graveyard :: Documentation, defect)

Description

[Manish Goregaokar [:manishearth]]

Found that some things were left unsaid in the linux documentation. Added.

The apt-get is for a fresh ubuntu VM, so should work for everyone.

Comment 1

[Manish Goregaokar [:manishearth]]

Attachment: Bug 1301590 - Add more documentation for linux setup;

Review commit: https://reviewboard.mozilla.org/r/77794/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/77794/

Comment 2

[Mark Côté [:mcote]]

Comment on attachment 8789658 [details]
Bug 1301590 - Add more documentation for linux setup;

https://reviewboard.mozilla.org/r/77794/#review76246

Thanks for the patch!  I reassigned the review to mars because he has actually done a lot of work getting a Vagrant MozReview-development box all set up, so he's probably the most knowledgeable about the packages required and so forth.

Comment 3

[Māris Fogels [:mars] (please needinfo)]

Comment on attachment 8789658 [details]
Bug 1301590 - Add more documentation for linux setup;

https://reviewboard.mozilla.org/r/77794/#review76954

::: docs/hacking-mozreview.rst:51
(Diff revision 1)
>  You can also install the very latest release `directly from Docker <http://docs.docker.com/linux/step_one/>`_.
>  
>  On Linux, it is necessary to configure Docker to listen on a tcp socket
>  rather than the default configuration, which uses an unix domain socket,
>  in order to get test results which match the expected results. This can be
> -done by editing your configuration file to start docker with the following
> +done by editing your configuration file (usually in ``/etc/default/docker``)

This step might be confusing because it doesn't mention which version of Ubuntu it applies to.  On 14.04 you configure docker using upstart and /etc/default/docker.  On 16.04 the default is systemd, configured via the instructions at https://docs.docker.com/engine/admin/systemd/#custom-docker-daemon-options

::: docs/hacking-mozreview.rst:58
(Diff revision 1)
>  
>    -H tcp://127.0.0.1:4243
>  
> +You will also need to set the ``DOCKER_HOST`` variable::
> +
> +  $ export DOCKER_HOST=127.0.0.1:4243

The docker [docs](https://docs.docker.com/engine/installation/linux/ubuntulinux/#enable-ufw-forwarding) say that the defaults docker API ports are 2375 for HTTP and 2376 for HTTPS.  Our docs should match theirs.

::: docs/hacking-mozreview.rst:62
(Diff revision 1)
> +
> +  $ export DOCKER_HOST=127.0.0.1:4243
> +
> +You may need to install the following dependencies on Ubuntu::
> +
> +  $ sudo apt-get install python-dev npm libxml2-dev libxslt1-dev libffi-dev liblzma-dev libsasl2-dev python-dev libldap2-dev libssl-dev

The required ubuntu 14.04 packages for building mozreview are also listed at http://mozilla-version-control-tools.readthedocs.io/en/latest/devguide/environment.html#requirements.  It might be better to turn this list into a link to the other document.  If we maintain two lists of build requirements then the lists may drift apart, causing much confusion for new developers.

Does this list of packages only work on 14.04?  I'm particularly curious about the Python package version being installed here.  Mozreview runs on Python 2.7.9+.

If this stanza does only work on 14.04 then it should be clearly called out.  That way people on 16.04 will know that this package list won't work.

Comment 4

[Manish Goregaokar [:manishearth]]

The 16.04 requirements are different, so I listed them as such.

I'm also piggybacking a different doc fix mcote asked me to make into this bug. Hope that's okay.

Comment 5

[Manish Goregaokar [:manishearth]]

Attachment: Bug 1301590 - Update docs for trychooser;

Review commit: https://reviewboard.mozilla.org/r/80032/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/80032/

Comment 6

[Manish Goregaokar [:manishearth]]

Comment on attachment 8789658 [details]
Bug 1301590 - Add more documentation for linux setup;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/77794/diff/1-2/

Comment 7

[Māris Fogels [:mars] (please needinfo)]

Comment on attachment 8789658 [details]
Bug 1301590 - Add more documentation for linux setup;

https://reviewboard.mozilla.org/r/77794/#review78808

LGTM

::: docs/devguide/environment.rst:53
(Diff revision 2)
>       libxml2-dev libxslt1-dev \
>       mercurial \
>       python-dev python-virtualenv \
>       zlib1g-dev
>  
> +On Ubuntu 16.04, the following packages are needed:

You may want to add the "mercurial" bullet from line 37 above, since it isn't installed by default on 16.04 either.

Comment 8

[Manish Goregaokar [:manishearth]]

Comment on attachment 8789658 [details]
Bug 1301590 - Add more documentation for linux setup;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/77794/diff/2-3/

Comment 9

[Manish Goregaokar [:manishearth]]

Comment on attachment 8793225 [details]
Bug 1301590 - Update docs for trychooser;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/80032/diff/1-2/

Comment 10

[Mark Côté [:mcote]]

Comment on attachment 8793225 [details]
Bug 1301590 - Update docs for trychooser;

https://reviewboard.mozilla.org/r/80032/#review78814

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/hgcustom/version-control-tools/rev/68bc8b2b5e9d
Add more documentation for linux setup; r=mars
https://hg.mozilla.org/hgcustom/version-control-tools/rev/7f3624f9ee8e
Update docs for trychooser; r=mcote