From 209c0a488ed044f5886563df0dbd0546e9267137 Mon Sep 17 00:00:00 2001 From: Nick Freear Date: Tue, 6 Feb 2018 14:06:14 +0000 Subject: [PATCH] Bug #34, added `Uptime` controller; error-handling to CHANGELONG * [iet:10301360][ci skip] --- CHANGELOG.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5868394..695a95c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,29 +5,31 @@ ## [Version 3.0.0](https://github.com/IET-OU/openEssayist-slim/releases/tag/3.0.0-beta) * Date: ~6 February 2018 _(Development: 10 Jan - 6 Feb.)_ - * Tag: _3.0.0-beta_ (Describe: `v2.6-102-ga272bfe`) + * Tag: _3.0.0-beta_ (Describe: `v2.6-104-g9c0b3c5`) * Notes: [Google Docs][] * Built on: PHP 7.0 / Slim framework v 2.2.0 / MySQL -Below are the _headline_ items. More details are in [Google Docs][]. +Below are the __headline__ items. More details are in [Google Docs][]. ### PHP - * Added _OU-SAMS_-based authentication and account creation - via separate library (Bug #27) + * Added _OU-SAMS_-based authentication and account creation — via separate library (Bug #27) * Fix PHP dependencies - upgrade from `dev-master` to released versions, in `composer.json` and `composer.lock` (Bug #20) - * Configuration - rename `app/config.php` to `app/config.DIST.php`, - * Configuration - make `rd_save_path`, `analyser_url` etc. configurable (Bug #23) + * Configuration — rename `app/config.php` to `app/config.DIST.php`, + * Configuration — make `rd_save_path`, `analyser_url` etc. configurable (Bug #23) * Added [Travis-CI][] continuous integration, with PHP linting [QA] (maintainability) (Bug #20) * Moved core _EssayAnalyser_ wrapper code to separate class (maintainability) (Bug #32) * Moved a lot of `require` and `Twig` configuration from front controller (`index.php`) to separate PHP files (maintainability) (Bug #31) * Moved database connection code from `app/config.php` to separate class (Bug #31) * Broke model classes into separate files (find-ability), - * Added missing logging (debugging aid, analytics), + * Added missing logging; improved error-handling (debugging aid, analytics), + * Added _status_ / _uptime_ controller — shows status of backend analyser service (as well as front), * Eased and documented installation and setup, via [README][], Composer `scripts`. ### User-interface - * Added configurable `maxlength` character limit to the draft-essay submission form - prevent analyser errors, load (Bug #30) + * Added configurable `maxlength` character limit to the draft-essay submission form - prevent analyser errors; server-load (Bug #30) + * Made error messages to user more user-friendly - for example, prefixed them with "_Sorry. ..._". ### Database @@ -50,11 +52,12 @@ Below are the _headline_ items. More details are in [Google Docs][]. ### Miscellaneous - * Add missing Open University copyright statements - in PHP, Javascript, user-interface, `composer.json` (Bug #20) + * Add missing Open University copyright statements — in PHP, Javascript, user-interface, `composer.json` (Bug #20) * Added _Nicolas Van Labeke_ (`vanch3d`) to `composer.json` - * Remove `./composer.phar` binary from Git, - * Remove `./openessayist.sql.zip` (2.6 MB) + * Removed legacy `composer.phar` binary from Git; removed `./openessayist.sql.zip` (2.6 MB) * Moved unused Javascript from Twig templates to separate JS file(s), + * Added test data — sourced from [Project Gutenberg][pg] and [ORO][] + --- ## [Version 2.7](https://github.com/IET-OU/openEssayist-slim/releases/tag/v2.7) @@ -75,7 +78,7 @@ Below are the _headline_ items. More details are in [Google Docs][]. ## Previous versions -* v2.4, v2.3, v2.2, v2_user_testing - 15 May to 16 August 2013. +* v2.4, v2.3, v2.2, v2_user_testing — 15 May to 16 August 2013. * See: [releases][] * Original developer: [vanch3d][]. @@ -92,6 +95,8 @@ Below are the _headline_ items. More details are in [Google Docs][]. [travis-ci]: https://travis-ci.org/IET-OU/openEssayist-slim "Travis-CI continuous integration" [Google Docs]: https://docs.google.com/document/d/1n6T2zJ1FMifHGEniYyU_V2d0F8WOHWb_JPRqEWCyR2Y/# "Release notes" [vanch3d]: https://github.com/vanch3d "Original developer: Nicolas Van Labeke (vanch3d)" +[oro]: http://oro.open.ac.uk/cgi/search/simple?meta=OpenEssayist& +[pg]: https://www.gutenberg.org/ [travis]: https://travis-ci.org/IET-OU/openEssayist-slim "IET-OU / openEsasyist-slim" [travis-icon]: https://travis-ci.org/IET-OU/openEssayist-slim.svg