From 365e1d76e7397c817a5ba2886c1328d339fd9855 Mon Sep 17 00:00:00 2001 From: kerchner Date: Thu, 29 Oct 2015 10:17:57 -0400 Subject: [PATCH] Release notes for m5_004, and associated edits to other docs pages/files. Closes #374. --- AUTHORS.txt | 4 ++- docs/conf.py | 7 +++--- docs/index.rst | 10 -------- docs/m5_004_release_notes.rst | 46 +++++++++++++++++++++++++++++++++++ docs/release_notes.rst | 1 + 5 files changed, 54 insertions(+), 14 deletions(-) create mode 100644 docs/m5_004_release_notes.rst diff --git a/AUTHORS.txt b/AUTHORS.txt index b4ec1c5..756f1a2 100644 --- a/AUTHORS.txt +++ b/AUTHORS.txt @@ -5,8 +5,10 @@ The programmer team (past and present) at GW Libraries includes: - Daniel Chudnov - Daniel Kerchner - Laura Wrubel -- Ankushi Sharma - Christian Aldridge +- Justin Littman +- Rajat Vij +- Ankushi Sharma The following people have contributed code to this repository and agreed to assign the copyright on their contributions to The George Washington diff --git a/docs/conf.py b/docs/conf.py index 259534e..6ee2f41 100644 --- a/docs/conf.py +++ b/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'), ] diff --git a/docs/index.rst b/docs/index.rst index 46522eb..2347078 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,13 +32,3 @@ Contents: Frequently Asked Questions Troubleshooting Release Notes - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs/m5_004_release_notes.rst b/docs/m5_004_release_notes.rst new file mode 100644 index 0000000..12d5112 --- /dev/null +++ b/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 `_). +* 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 `_ as well as the `code changes from m5_003 to m5_004 `_. + +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 diff --git a/docs/release_notes.rst b/docs/release_notes.rst index f4f6596..17d65e3 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -11,6 +11,7 @@ Final Releases: .. toctree:: :maxdepth: 2 + m5_004 release notes m5_003 release notes m5_002 release notes m5_001 release notes