Redo README and add current status note (mozilla-services#3750)

* Redo README and add current status note

We no longer support Socorro and we're making big changes. Seems prudent to let
users know the status and what the last good commit was.

* Fix setup.py

* Clarify this is Mozilla-centric and add wk8/sentry-breakpad

README.rst

@@ -0,0 +1,77 @@
+=======
+Socorro
+=======
+
+Socorro is a Mozilla-centric set of services for collecting, processing, and
+displaying crash reports from clients using the `Breakpad libraries
+<http://code.google.com/p/google-breakpad/>`_.
+
+
+Support
+=======
+
+This is a very Mozilla-specific product. We do not currently have the capacity
+to support external users.
+
+If you are looking to use Socorro for your product, maybe you want to consider
+alternatives:
+
+* `electron/mini-breakpad-server <https://github.com/electron/mini-breakpad-server>`_
+* `wk8/sentry_breakpad <https://github.com/wk8/sentry_breakpad>`_
+
+
+May 3rd, 2017 Update
+--------------------
+
+For the last year or so, we've been removing code and making changes that aren't
+backwards compatible. A couple of weeks ago, we (Mozilla) extracted the
+collector out of Socorro into a separate repository. Because of that, we're
+going to start removing code.
+
+If you rely on that collector, the last good commit sha is `55beaf1
+<https://github.com/mozilla/socorro/commit/55beaf1281e7b522e0526b2aa2bf74d15f6c1263>`_.
+
+You can get it with something like this::
+
+    git clone https://github.com/mozilla/socorro
+    git checkout 55beaf1
+
+
+ Or get the tarball::
+
+    wget https://github.com/mozilla/socorro/archive/55beaf1.tar.gz
+
+
+Installation
+============
+
+Documentation about installing Socorro is available on ReadTheDocs:
+`<https://socorro.readthedocs.io/en/latest>`_
+
+
+Releases
+========
+
+We use continuous development, so we release quite often. See our list of releases:
+
+https://github.com/mozilla/socorro/releases
+
+
+Communication
+=============
+
+We have a mailing list for Socorro users that you can join here:
+https://lists.mozilla.org/listinfo/tools-socorro
+
+Please help each other.
+
+Devs hang out in the Socorro/Breakpad IRC channel:
+`<irc://irc.mozilla.org/breakpad>`_
+
+
+Development
+===========
+
+Current deployment status: https://whatsdeployed.io/s-7M7
+
+Mozilla-centric Infrastructure (AWS) code: https://github.com/mozilla/socorro-infra

docs/index.rst

@@ -1,10 +1,6 @@
-.. Socorro documentation master file, created by
-   sphinx-quickstart on Wed Sep 21 14:59:08 2011.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root ``toctree`` directive.
-
 Socorro
 =======
+
 Socorro is a set of components for collecting, processing and reporting on crashes. It is used by Mozilla for tracking crashes of Firefox, B2G, Thunderbird and other projects. The production Mozilla install is public and hosted at https://crash-stats.mozilla.com/
 
 The components which make up Socorro are:
@@ -27,10 +23,45 @@ We welcome contributions!
 
 See http://wiki.mozilla.org/Breakpad for up-to-date information about development team activity and our meetings.
 
-This documentation is `available on readthedocs <https://socorro.readthedocs.io>`_. The source and current development activity is `available on Github <https://github.com/mozilla/socorro/tree/master>`_.
+This documentation is `available on readthedocs <https://socorro.readthedocs.io>`_. The source and current development activity is `available on Github <https://github.com/mozilla/socorro/>`_.
 
 The Socorro development mailing list is https://lists.mozilla.org/listinfo/tools-socorro
 
+
+Support
+=======
+
+This is a very Mozilla-specific product. We do not currently have the capacity
+to support external users. If you are looking to use Socorro for your product,
+maybe you want to consider alternatives like `electron/mini-breakpad-server
+<https://github.com/electron/mini-breakpad-server>`_.
+
+
+May 3rd, 2017 Update
+--------------------
+
+For the last year or so, we've been removing code and making changes that aren't
+backwards compatible. A couple of weeks ago, we (Mozilla) extracted the
+collector out of Socorro into a separate repository. Because of that, we're
+going to start removing code.
+
+If you rely on that collector, the last good commit sha is `55beaf1
+<https://github.com/mozilla/socorro/commit/55beaf1281e7b522e0526b2aa2bf74d15f6c1263>`_.
+
+You can get it with something like this::
+
+    git clone https://github.com/mozilla/socorro
+    git checkout 55beaf1
+
+
+ Or get the tarball::
+
+    wget https://github.com/mozilla/socorro/archive/55beaf1.tar.gz
+
+
+Contents
+========
+
 .. toctree::
    :numbered:
    :hidden:

setup.py

@@ -24,7 +24,7 @@ def read(fname):
     version='master',
     description=('Socorro is a server to accept and process Breakpad'
                  ' crash reports.'),
-    long_description=open('README.md').read(),
+    long_description=open('README.rst').read(),
     author='Mozilla',
     author_email='[email protected]',
     license='MPL',