Go to file
Raissa North f1c58fd5eb FIX Set correct Transifex resource name for javascript 2018-01-09 11:18:48 +13:00
.tx FIX Set correct Transifex resource name for javascript 2018-01-09 11:18:48 +13:00
_config API Add React modal popup for reviewing content in SiteTree 2017-09-15 16:06:37 +12:00
client API Add React modal popup for reviewing content in SiteTree 2017-09-15 16:06:37 +12:00
docs/en DOCS Update readme and userguide for SS4, new screenshots, updated use examples 2017-09-13 11:18:26 +12:00
lang NEW Add behat tests to cover content review configuration and review modal 2017-09-15 16:06:38 +12:00
src Add a hook to updateSettingsFields so that devs can show/hide when desired. 2017-11-21 09:18:31 +13:00
templates/SilverStripe/ContentReview API Add React modal popup for reviewing content in SiteTree 2017-09-15 16:06:37 +12:00
tests Merge branch '3' 2017-10-12 13:22:24 +13:00
.editorconfig API Move JS and CSS to webpack, update DOM binding for SS4 CMS 2017-09-07 16:20:29 +12:00
.eslintrc API Move JS and CSS to webpack, update DOM binding for SS4 CMS 2017-09-07 16:20:29 +12:00
.gitattributes Added standard git attributes 2015-11-19 19:10:29 +13:00
.gitignore API Move JS and CSS to webpack, update DOM binding for SS4 CMS 2017-09-07 16:20:29 +12:00
.sass-lint.yml API Move JS and CSS to webpack, update DOM binding for SS4 CMS 2017-09-07 16:20:29 +12:00
.scrutinizer.yml NEW Add behat tests to cover content review configuration and review modal 2017-09-15 16:06:38 +12:00
.travis.yml Updating travis install steps 2017-10-12 13:25:11 +01:00
.upgrade.yml API Implement namespaces and update core API use - CLDR date formats in progress 2017-09-06 17:12:31 +12:00
behat.yml FIX convert CI bootstrap references to new their new locations in vendor 2017-10-05 10:07:54 +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
codecov.yml Update Travis configuration, add PSR-4 autoloader, update composer requirements for SS4 2017-09-06 17:12:30 +12:00
composer.json FIX Update constraint for serve and remove dev tags 2017-12-22 10:02:01 +13:00
contributing.md Added community files 2015-11-02 09:50:12 +13:00
license.md Update Travis configuration, add PSR-4 autoloader, update composer requirements for SS4 2017-09-06 17:12:30 +12:00
package.json API Add React modal popup for reviewing content in SiteTree 2017-09-15 16:06:37 +12:00
phpunit.xml.dist FIX convert CI bootstrap references to new their new locations in vendor 2017-10-05 10:07:54 +13:00
readme.md DOCS Update readme and userguide for SS4, new screenshots, updated use examples 2017-09-13 11:18:26 +12:00
webpack.config.js FIX Use ModuleLoader for requirements, and use path resolver for thirdparty dir 2017-09-15 16:06:38 +12:00
yarn.lock API Add React modal popup for reviewing content in SiteTree 2017-09-15 16:06:37 +12:00

readme.md

Content Review module

Build status Code quality Code coverage Version License

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 ^4.0

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.

Run dev/build either via the web server by opening the URL http://<your-host>/dev/build?flush or by running the dev/build via a CLI: sake dev/build flush=1

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.