You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Guy Sartorelli 7eb81fd449
Merge pull request #172 from creative-commoners/pulls/4/review-behat-tests
2 weeks ago
.github/workflows MNT Fix github action for deploying userdocs 1 month ago
.tx FIX Set correct Transifex resource name for javascript 5 years ago
_config API Add React modal popup for reviewing content in SiteTree 5 years ago
client Merge branch '4.4' into 4.5 2 months ago
docs/en DOC Correct title for userhelp 1 month ago
lang Update translations 5 years ago
src Merge pull request #155 from creative-commoners/pulls/4.3/all-sections 2 weeks ago
templates/SilverStripe/ContentReview Update translations and update classes to use __CLASS__ in translations 5 years ago
tests ENH Replace ADMIN permissions with less permissions in Behat test 2 weeks ago
.editorconfig API Move JS and CSS to webpack, update DOM binding for SS4 CMS 5 years ago
.eslintrc Prevent eslint rules from cascading. 4 years ago
.gitattributes ENHANCEMENT Optimise imports, upgrade array syntax 5 years ago
.gitignore API Move JS and CSS to webpack, update DOM binding for SS4 CMS 5 years ago
.nvmrc MNT Use GitHub Actions CI 3 months ago
.sass-lint.yml MNT Use node 10 2 months ago
.upgrade.yml API Implement namespaces and update core API use - CLDR date formats in progress 5 years ago
README.md MNT Standardise modules 2 months ago
behat.yml MNT Update behat tests 11 months ago
code-of-conduct.md Added standard code of conduct 7 years ago
codecov.yml Update Travis configuration, add PSR-4 autoloader, update composer requirements for SS4 5 years ago
composer.json Merge branch '4.4' into 4.5 2 months ago
contributing.md Added community files 7 years ago
license.md Update Travis configuration, add PSR-4 autoloader, update composer requirements for SS4 5 years ago
package.json MNT Use node 10 2 months ago
phpcs.xml.dist MNT Travis shared config, use sminnee/phpunit 2 years ago
phpunit.xml.dist MNT Standardise modules 2 months ago
webpack.config.js FIX Use ModuleLoader for requirements, and use path resolver for thirdparty dir 5 years ago
yarn.lock Bump async from 2.5.0 to 2.6.4 5 months ago

README.md

Content Review module

CI Silverstripe supported module

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

Note: For Silverstripe 3.x, please use the 3.x release line.

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.