Go to file
Guy Sartorelli 096f587261
Merge pull request #244 from creative-commoners/pulls/4.7/composer
DEP Bump minimum version of framework
2024-07-11 10:00:13 +12:00
_config API Add React modal popup for reviewing content in SiteTree 2017-09-15 16:06:37 +12:00
.github/workflows MNT Fix github action for deploying userdocs 2022-08-23 15:24:27 +12:00
.tx ENH Update translations 2023-03-06 18:16:13 +13:00
client TLN Update translations (#223) 2024-02-07 16:03:34 +13:00
docs/en DOC Correct title for userhelp 2022-08-20 20:58:19 +12:00
lang TLN Update translations (#223) 2024-02-07 16:03:34 +13:00
src MNT Use ::create to allow Injector to replace content review emails sending task 2023-06-16 11:46:30 +12:00
templates/SilverStripe/ContentReview Update translations and update classes to use __CLASS__ in translations 2018-01-09 11:20:50 +13:00
tests FIX Notification job marked as broken 2023-04-14 12:22:23 +12:00
.editorconfig API Move JS and CSS to webpack, update DOM binding for SS4 CMS 2017-09-07 16:20:29 +12:00
.eslintrc Prevent eslint rules from cascading. 2018-10-05 12:05:28 +13:00
.gitattributes ENHANCEMENT Optimise imports, upgrade array syntax 2018-01-09 12:26:55 +13:00
.gitignore API Move JS and CSS to webpack, update DOM binding for SS4 CMS 2017-09-07 16:20:29 +12:00
.nvmrc MNT Use GitHub Actions CI 2022-07-08 12:00:12 +12:00
.sass-lint.yml MNT Use node 10 2022-07-19 17:20:05 +12: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 MNT Update behat tests 2021-11-12 18:24:50 +13: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 DEP Bump minimum version of framework 2024-07-10 11:38:53 +12: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 MNT Use node 10 2022-07-19 17:20:05 +12:00
phpcs.xml.dist MNT Travis shared config, use sminnee/phpunit 2020-12-15 13:54:35 +13:00
phpunit.xml.dist MNT Standardise modules 2022-08-01 16:21:34 +12:00
README.md MNT Standardise modules 2022-08-01 16:21:34 +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 Bump debug from 2.6.8 to 2.6.9 2023-01-12 10:00:53 +00:00

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.