1040304 - Document a Quickstart Page

Status: RESOLVED WONTFIX

(Socorro :: General, task)

Description

[Trevor Bramwell :bramwelt]

A quickstart guide should be the first link after the project introduction that provides users the shortest path to launching or testing the application.

The guide should be written assuming a non-Vagrant environment. Vagrant can be mentioned at the start, though the guide should still walk through setting up Socorro on other platforms.

This should merge the Ubuntu, RHEL, and OSX docs such that each section has an explanation of how to perform a step in all three platforms (if there is a discrepancy).

Comment 1

[Lonnen :lonnen]

consider putting this in the project readme

Comment 2

[Robert Helmer [:rhelmer]]

(In reply to Trevor Bramwell :bramwelt from comment #0)
> A quickstart guide should be the first link after the project introduction
> that provides users the shortest path to launching or testing the
> application.

Are you thinking for a dev-style install, e.g. "honcho start"?

I think the bare minimum right now is (for example for OSX):

http://socorro.readthedocs.org/en/latest/installation/mac.html
http://socorro.readthedocs.org/en/latest/installation/postgres.html
http://socorro.readthedocs.org/en/latest/installation/install-src-dev.html

The first should really just be scripted, the second we maybe could (Postgres config and setting up roles in a cross-platform way is tricky, we do it now for vagrant only). The last one absolutely should be scripted.

If we did it right, the above could be as simple as:

make bootstrap
honcho start

Then testing the system e.g. http://socorro.readthedocs.org/en/latest/installation/systemtest.html

Adding new products and releases is also begging to be scripted:
http://socorro.readthedocs.org/en/latest/installation/add-product-release.html

Comment 3

[Robert Helmer [:rhelmer]]

One thing this doesn't cover is getting debug symbols for your app loaded - we link out to these rather ungainly docs from the "deps" page right now:

https://code.google.com/p/google-breakpad/wiki/GettingStartedWithBreakpad
https://code.google.com/p/google-breakpad/wiki/LinuxStarterGuide#Producing_symbols_for_your_application

Comment 4

[Robert Helmer [:rhelmer]]

(In reply to Robert Helmer [:rhelmer] from comment #2)
> If we did it right, the above could be as simple as:
> 
> make bootstrap
> honcho start


The implication here is that "make bootstrap" would have a few new tricks:

* ensure that all deps are running and reachable
** offer to install in platform-specific way if not e.g. "sudo brew ..."
* set up postgres roles, connections and fakedata DB

These could really be separate scripts behind the scenes, and they'd bail quickly if the preconditions were already met (deps running, DB exists and accessible)

Comment 5

[Will Kahn-Greene [:willkg] ET needinfo? me]

We're not longer pushing Socorro as a product for other people. So "Quickstart" is now something focused solely on new contributors and developers to Socorro.

We're also redoing our dev environment so that it's more "works out of the box" than it was previously which reduces the number of steps to get up and running.

I wrote a Getting Started section that suffices for now and we can iterate on that going forward.

Marking this as WONTFIX.