Go to file
2016-08-24 10:57:49 +12:00
_config Make contentreview an inline form 2015-11-13 14:51:09 +13:00
.tx Add tx config 2015-11-04 10:26:51 +13:00
code progress toward calculating what changes to the emailing will be needed 2016-08-23 15:37:27 +12:00
css styling for review info on the quick review panel 2016-08-23 15:35:06 +12:00
docs/en DOCS Documentation rework for better user guide. 2016-01-05 15:47:56 +13:00
images Make contentreview an inline form 2015-11-13 14:51:09 +13:00
javascript BUG Show inherited date even when inheriting settings 2015-11-18 11:58:57 +13:00
lang additional config items 2016-08-24 10:57:49 +12:00
templates API CMS Editable notification templates 2015-11-18 13:25:54 +13:00
tests BUG Prevent non-real draft changes forcing record to appear as changed when saved 2016-05-17 17:57:48 +12:00
.editorconfig Added standard editor config 2015-11-19 13:24:15 +13:00
.gitattributes Added standard git attributes 2015-11-19 19:10:29 +13:00
.gitignore update gitignore 2016-01-19 05:47:36 +13:00
.scrutinizer.yml Added standard Scrutinizer config 2015-11-18 14:36:12 +13:00
.travis.yml Added standard Travis config 2015-11-19 14:18:10 +13:00
changelog.md Add changelog for 3.0.2 2016-05-18 18:41:35 +12:00
code-of-conduct.md Added standard code of conduct 2015-11-21 20:11:36 +13:00
composer.json Changelog for 3.0.0 release 2015-11-19 16:47:47 +13:00
contributing.md Added community files 2015-11-02 09:50:12 +13:00
license.md Updated license year 2016-01-01 06:32:22 +13:00
readme.md Added Helpful Robot badge 2016-05-21 17:33:21 +12:00

Content Review module

Build Status Code Quality Version License helpfulrobot

This module helps keep your website content accurate and up-to-date, which keeps your users happy.

It does so by sending reviewers reminder emails to go in and check the content. For a reviewer this often includes checking links, grammar, factual information and look and feel.

There are two types of roles with this module.

  • Website owner; (typically assigned to the Administrator group) ensures that a website is accurate and up-to-date, by delegating responsibility to content reviewers.
  • Content reviewer; responsible for keeping a website or part of a website accurate and up-to-date.

Requirements

  • SilverStripe ^3.1

Features

  • Content reviewer will receive an email notification when a page is due for review.
  • Content reviewer can mark a page as 'reviewed', and provide review notes.
  • Website owner can assign content reviewers to a page and set when the content should be reviewed.
  • Website owner can see a report of pages and their reviewed status.
  • Content reviewers can be assigned to a page, a page and all sub-pages, or globally.
  • The content review schedule can be automatic, e.g. every month, and/or a specific date.

Wishlist features

  • Overdue review reminder emails.
  • Customisable reminder emails.

Composer installation

$ composer require silverstripe/contentreview

You'll also need to run 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://<your-host>/dev/build or by running the dev/build via a CLI.

Documentation

See the docs/en folder.

Versioning

This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.

All methods, with public visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep protected methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.

Reporting Issues

Please create an issue for any bugs you've found, or features you're missing.