634041 - basic INSTALL/README

Status: RESOLVED FIXED

(Socorro :: General, task, P5)

Description

[Robert Helmer [:rhelmer]]

We should have a basic README and INSTALL file; github makes README especially prominent.

I started working on this before we had a Makefile, the install instructions could be a lot simpler now:
https://github.com/rhelmer/socorro/tree/docs

I think the existing README is probably fine (just links to more info mostly), but the INSTALL should have dependencies and simple install instructions for supported OSes.

This is primarily intended for users (maybe us!) who want to install into an existing environment (without puppet).

Do we want some or all of these instructions on a wiki instead (in which case we'd just link to that from the README instead of having INSTALL)? Since they can change release-to-release, I kind of like having them live with the source but I could go either way.

Comment 1

[Robert Helmer [:rhelmer]]

(In reply to comment #0)
> https://github.com/rhelmer/socorro/tree/docs

Better branch in URL field.

Comment 2

[Robert Helmer [:rhelmer]]

Landed an initial version of this in SVN revision 2926, the INSTALL is basically a dump of my notes setting up a dev VM.

Still needs whole-stack testing, and to finish setting up Hadoop. I think once we have a working stack (can submit crashes and see reports+rawdump in webUI) using these instructions, the bug will be done.

A few thoughts:

* INSTALL could perhaps just be a script for building a VM? 
** puppet does this for us in stage/prod at Mozilla so it's more for devs and
   external users
* github supports RST (and other formats), so we could have nicer formatting if we want

Comment 3

[Robert Helmer [:rhelmer]]

Tested on Fedora 14:
Committed revision 2928.

Not "staging equivalent" yet, but enough for me to use for dev for now. Will revisit this once my bug queue is whittled down a bit.