DOCS Documentation rework for better user guide.

This commit is contained in:
Cam Findlay 2016-01-05 15:47:56 +13:00
parent 9ce121ec88
commit 361d5ac0f8
7 changed files with 42 additions and 63 deletions

View File

@ -1,74 +1,20 @@
# Content Review module # Content Review module developer documentation
[![Build Status](http://img.shields.io/travis/silverstripe/silverstripe-contentreview.svg?style=flat-square)](https://travis-ci.org/silverstripe/silverstripe-contentreview)
[![Code Quality](http://img.shields.io/scrutinizer/g/silverstripe/silverstripe-contentreview.svg?style=flat-square)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-contentreview)
[![Version](http://img.shields.io/packagist/v/silverstripe/contentreview.svg?style=flat-square)](https://packagist.org/packages/silverstripe/contentreview)
[![License](http://img.shields.io/packagist/l/silverstripe/contentreview.svg?style=flat-square)](license.md)
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.
## 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.
## Requirements
* SilverStripe Framework and CMS
## Composer installation
```sh
$ composer require silverstripe/contentreview
```
## 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.
## Configuration ## Configuration
### Global settings
The module is set up in the `Settings` section of the CMS, see the [User guide](userguide/index.md).
### Reminder emails
In order for the contentreview module to send emails, you need to *either*: In order for the contentreview module to send emails, you need to *either*:
* Setup the DailyTask script to run daily via cron. See framework/tasks/ScheduledTask.php for more information on setup. * Setup the DailyTask script to run daily via cron. See framework/tasks/ScheduledTask.php for more information on setup.
* Install the queuedjobs module, and follow the configuration steps to create a cron job for that module. Once installed, you can just run dev/build to have a job created, which will run at 9am every day by default. * Install the queuedjobs module, and follow the configuration steps to create a cron job for that module. Once installed, you can just run dev/build to have a job created, which will run at 9am every day by default.
Global settings can be configured via the global settings admin in the CMS under the "Content Review" tab. ## Using
This includes global groups, users, as well as a template editor that supports a limited number of variables. See [User guide](userguide/index.md)
![settings](images/content-review-siteconfig-settings.png)
## Usage
To set up content review schedules you need to log in as a user with the 'Set content owners and review dates' permission. This can either
be an administrator who has all permissions, or by giving a group the specific permission.
![](images/content-review-permission.png)
To set a content review schedule for a page go to `Settings > Content Review`.
![](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.
![](images/content-review-settings-ro.png)
## Testing ## Testing

View File

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 40 KiB

View File

Before

Width:  |  Height:  |  Size: 207 KiB

After

Width:  |  Height:  |  Size: 207 KiB

View File

Before

Width:  |  Height:  |  Size: 198 KiB

After

Width:  |  Height:  |  Size: 198 KiB

View File

Before

Width:  |  Height:  |  Size: 158 KiB

After

Width:  |  Height:  |  Size: 158 KiB

View File

@ -0,0 +1,25 @@
title: Content review
summary: Mark pages in the CMS with a date and an owner for future reviews.
## Content review
## Setting up
Global settings can be configured via the global settings admin in the CMS under the "Content Review" tab.
This includes global groups, users, as well as a template editor that supports a limited number of variables.
![settings](_images/content-review-siteconfig-settings.png)
## Schedules
To set up content review schedules you need to log in as a user with the 'Set content owners and review dates' permission. This can either
be an administrator who has all permissions, or by giving a group the specific permission.
![](_images/content-review-permission.png)
To set a content review schedule for a page go to `Settings > Content Review`.
![](_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.
![](_images/content-review-settings-ro.png)

View File

@ -41,6 +41,14 @@ $ composer require silverstripe/contentreview
You'll also need to run `dev/build`. 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 ## Documentation
See the [docs/en](docs/en/index.md) folder. See the [docs/en](docs/en/index.md) folder.