1195031 - Olympia install documentation is misleading

Status: RESOLVED FIXED

(addons.mozilla.org Graveyard :: Code Quality, defect)

Description

[Eve Le Cellier]

User Agent: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:39.0) Gecko/20100101 Firefox/39.0
Build ID: 20150629114848

Steps to reproduce:

Tried to follow http://olympia.readthedocs.org/en/latest/ to install a developer environment for AMO on Ubuntu with virtualenv.


Actual results:

Executing the "make full_init" command line as instructed, I had multiple errors. I had to solve them one after another and re-run "make full_init" each time before obtaining a working environment.



Expected results:

The following instructions should have been present before the "make full_init" command:

* the apt-get install command line should include nodejs and nodejs-legacy (nodejs-legacy is mandatory to get the symlink from node to nodejs).
* documentation should include the "pip install --upgrade pip" command line instead of just mentioning that it must be up to date.
* elasticsearch must be up and running, the documentation could give instructions for that.
* mysql must be up and running and either have a root account with no password, or a database named olympia with a olympia user with full privileges on it.

Comment 1

[Eve Le Cellier]

I submitted a pull request to fix this bug: https://github.com/mozilla/olympia/pull/660

Comment 2

[[github robot]]

Commits pushed to master at https://github.com/mozilla/olympia

https://github.com/mozilla/olympia/commit/95c7bf33c9f4d85ad97a3b990a6c49d829749c4a
Improve install documentation (bug 1195031)

https://github.com/mozilla/olympia/commit/2f0672f485bbc7910c46e4efb3457e748fe7210c
Merge pull request #660 from Evelf/install-docs-improvement

Improve install documentation (bug 1195031)