Release notes for m5_004, and associated edits to other docs pages/fi…

…les. Closes #374.

AUTHORS.txt

@@ -5,8 +5,10 @@ The programmer team (past and present) at GW Libraries includes:
 - Daniel Chudnov <dchud@gwu.edu>
 - Daniel Kerchner <kerchner@gwu.edu>
 - Laura Wrubel <lwrubel@gwu.edu>
-- Ankushi Sharma <anksharm@email.gwu.edu>
 - Christian Aldridge <zut@gwu.edu>
+- Justin Littman <justinlittman@gwu.edu>
+- Rajat Vij <rajatvij@gwu.edu>
+- Ankushi Sharma <anksharm@gwu.edu>
 
 The following people have contributed code to this repository and agreed
 to assign the copyright on their contributions to The George Washington

docs/conf.py

@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = 'm5_003'
+version = 'm5_004'
 # The full version, including alpha/beta/rc tags.
-release = 'm5_003'
+release = 'm5_004'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -228,7 +228,8 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
   ('index', 'SocialFeedManager', u'Social Feed Manager Documentation',
-   u'George Washington University Libraries', 'SocialFeedManager', 'One line description of project.',
+   u'George Washington University Libraries', 'SocialFeedManager',
+   'A Python/Django application to build collections of Twitter data',
    'Miscellaneous'),
 ]
 

docs/index.rst

@@ -32,13 +32,3 @@ Contents:
    Frequently Asked Questions <faq>
    Troubleshooting <troubleshooting>
    Release Notes <release_notes>
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-

docs/m5_004_release_notes.rst

@@ -0,0 +1,46 @@
+
+m5_004 release notes
+====================
+
+**m5_004** is release which provides:
+
+* Docker support (see https://github.com/gwu-libraries/social-feed-manager/blob/m5_004/docker/README.md)
+* Extract files now in XLSX format (was XLS).  The XLSX format removes the limitation
+  of 65,536 rows.  SFM m5_004 substituted the openpyxl library for xlwt.
+* SFM now uses tweepy v3.4.0.  This seems to eliminate the problem observed in m5_003,
+  which used tweepy 3.2.0, where filterstream jobs stopped writing and/or slowed down
+  the server.
+* Several documentation improvements, mostly around installation and around supervisor/filterstreams setup.
+* UI cleanup:  Improved consistency of date-time format rendering.
+* Enhanced validation logic around checking People values when adding or updating filterstreams:
+  If one or more People account names wasn't found when checking against Twitter, the TwitterFilter
+  does save, but presents a warning listing the invalid accounts.
+* Now allows deletion of filterstreams even if Supervisor isn't running.
+* Now allows creation/update of filterstreams even if Supervisor isn't running (however, these won't automatically reflect updates when Supervisor is restarted (See `#376 <https://github.com/gwu-libraries/social-feed-manager/issues/376>`_).
+* Updated Apache2 configuration file to note recommended changes for deployment on Ubuntu 14 / Apache2 v2.4+
+* Enhanced fetch_urls to more gracefully handle (skip) truncated URLs that may appear in retweets with an ellipsis, and to pull URLs from 'media' if possible.
+* And several other minor enhancements.
+
+See the `complete list of changes for milestone m5_004 in github <m5_004_>`_ as well as the `code changes from m5_003 to m5_004 <m5_003_to_m5_004_diff_>`_.
+
+Upgrade Notes:
+
+* The requirements.txt file has changed, so Python library dependencies must
+  be updated within your virtualenv.  To update dependencies:
+
+::
+
+  % source ENV/bin/activate
+  % pip install -r requirements.txt
+
+
+Contributors:
+
+* Dan Chudnov, Dan Kerchner, Laura Wrubel, Justin Littman, Ankushi Sharma, and Rajat Vij at The George Washington University Libraries
+* Ed Summers at Maryland Institute for the Humanities (MITH)
+* Martin Klein at UCLA Research Library
+
+
+.. _m5_004: https://github.com/gwu-libraries/social-feed-manager/issues?q=is%3Aissue+is%3Aclosed+milestone%3Am5_004 
+.. _twitter_track: https://dev.twitter.com/streaming/overview/request-parameters#track 
+.. _m5_003_to_m5_004_diff: https://github.com/gwu-libraries/social-feed-manager/compare/m5_003...m5_004

docs/release_notes.rst

@@ -11,6 +11,7 @@ Final Releases:
 .. toctree::
    :maxdepth: 2
 
+   m5_004 release notes <m5_004_release_notes>
    m5_003 release notes <m5_003_release_notes>
    m5_002 release notes <m5_002_release_notes>
    m5_001 release notes <m5_001_release_notes>