diff --git a/README.md b/README.md index db99614..f7c08b6 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,75 @@ # Content Review module -## Maintainer Contact -* Tom Rix (Nickname: trix) - +This module helps with ensuring that a websites content are correct and up-to-date so that visitors +can rely on the information provided by the client. + +For a reviewer this often includes checking links, grammar, factual information and look and feel. + + +## Roles + +There are two types of roles with this module. + + * Content Owner; are responsible to periodically review a page. + * Website Responsible; ensures that pages have an scheduled content review with an Content Owner. + +## Features + + * Content owner will receive a notification when a pages review date is due with links to the page and the + CMS edit form + * Content owners can mark a page as 'reviewed' via the CMS Page edit view. + * Website Responsible can assign a content owner (members or groups) to a page (and optionally all sub-pages) + and a schedule of how often the content should be reviewed. + * Website Responsible can see a “pages due for review” report + * Website Responsible can see a “pages without content owner” report + * Website Responsible can set a default Content Owner and schedule for all pages without a review schedule. + +## Wished features: + + * Reminder emails that notifies Content Owner and Website responsible that a review is over due. + * Emails are customisable in the CMS + ## Requirements - * SilverStripe 3.0 - * Database: MySQL, Postgres, SQLite or MSSQL - * PHP 5.2 or newer (because of Zend_Date usage) -## Installation + * SilverStripe framework and CMS 3.1 + * Database: MySQL, PostgreSQL, SQLite or MSSQL + * PHP 5.3 or newer -Drop it into your installation folder, and refresh your database schema -through `http:///dev/build`. +## Manual installation + +Download or clone the source code into the SilverStripe root folder. Rename the module folder +to `contentreview`. + +Run dev/build either via the webserver by opening the url `http:///dev/build` or +by running the dev/build via a CLI. + +## Composer installation + + composer require silverstripe/contentreview dev-feature_improvements + +## Setup If you wish to have emails sent when a page comes up for review, you new to have the DailyTask cron job set up. See ScheduledTask.php ## Usage -When you open a page in the CMS, there will now be a Review tab. +To set up a content review schedule you need the permission to set it up. It can be set up by and administrator +in the Security Admin under the 'Content Permission' for a group. + +![](docs/en/images/content-review-permission.png) + +To set a schedule for a page you need to open the `Settings > Content Review` setting for that page. + +![](docs/en/images/content-review-settings.png) + +CMS users without the permission to change the content review schedule can still see the settings +and previous reviews in the same view, but cannot change anything. + +![](docs/en/images/content-review-settings-ro.png) + ## Migration -When migrating from an older version of this module to the current version, -you might need to run: /dev/tasks/ContentReviewOwnerMigrationTask + * Todo, make a migration script from latest master diff --git a/docs/.DS_Store b/docs/.DS_Store new file mode 100644 index 0000000..b3c4ac8 Binary files /dev/null and b/docs/.DS_Store differ diff --git a/docs/en/.DS_Store b/docs/en/.DS_Store new file mode 100644 index 0000000..dad1ae1 Binary files /dev/null and b/docs/en/.DS_Store differ diff --git a/docs/en/images/content-review-permission.png b/docs/en/images/content-review-permission.png new file mode 100644 index 0000000..4addf4a Binary files /dev/null and b/docs/en/images/content-review-permission.png differ diff --git a/docs/en/images/content-review-settings-ro.png b/docs/en/images/content-review-settings-ro.png new file mode 100644 index 0000000..95e9ec4 Binary files /dev/null and b/docs/en/images/content-review-settings-ro.png differ diff --git a/docs/en/images/content-review-settings.png b/docs/en/images/content-review-settings.png new file mode 100644 index 0000000..4e23051 Binary files /dev/null and b/docs/en/images/content-review-settings.png differ