Merge pull request #66 from creative-commoners/pulls/4.0/update-docs

DOCS Update readme and userguide for SS4, new screenshots, updated use examples
This commit is contained in:
Daniel Hensby 2017-09-13 12:27:19 +01:00 committed by GitHub
commit b8114f54bb
7 changed files with 16 additions and 18 deletions

View File

@ -10,24 +10,25 @@ The module is set up in the `Settings` section of the CMS, see the [User guide](
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.
* 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.
* Setup the `ContentReviewEmails` script to run daily via a system cron job.
* Install the [queuedjobs](https://github.com/symbiote/silverstripe-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.
## Using
See [User guide](userguide/index.md)
See the [user guide](userguide/index.md).
## Testing
cd to the site root, and run:
```sh
$ php vendor/bin/behat
$ php vendor/bin/behat @contentreview
```
or to test this module when used on a website:
or to run the unit test suite:
```sh
$ php vendor/bin/behat contentreview/tests
$ php vendor/bin/phpunit contentreview/tests
```
## Migration

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 207 KiB

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 198 KiB

After

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 158 KiB

After

Width:  |  Height:  |  Size: 129 KiB

View File

@ -4,22 +4,24 @@ 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)
![SiteConfig 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)
![Content review permissions](_images/content-review-permission.png)
To set a content review schedule for a page go to `Settings > Content Review`.
![](_images/content-review-settings.png)
![Page content review settings](_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)
![Read only view of page content review settings](_images/content-review-settings-ro.png)

View File

@ -42,13 +42,8 @@ $ 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.
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