silverstripe-contentreview/docs/en/index.md

37 lines
989 B
Markdown
Raw Permalink Normal View History

# Content Review module developer documentation
2009-11-02 05:02:57 +01:00
## Configuration
2009-11-02 05:02:57 +01:00
### Global settings
The module is set up in the `Settings` section of the CMS, see the [User guide](userguide/index.md).
### Reminder emails
2009-11-02 05:02:57 +01:00
In order for the contentreview module to send emails, you need to *either*:
* 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 the [user guide](userguide/index.md).
2015-09-15 07:46:13 +02:00
## Testing
2015-10-29 19:22:35 +01:00
cd to the site root, and run:
```sh
$ php vendor/bin/behat @contentreview
2015-10-29 19:22:35 +01:00
```
or to run the unit test suite:
2015-09-15 07:46:13 +02:00
2015-10-29 19:22:35 +01:00
```sh
$ php vendor/bin/phpunit contentreview/tests
2015-10-29 19:22:35 +01:00
```
## Migration
2015-10-29 19:22:35 +01:00
If you are upgrading from an older version, you may need to run the `ContentReviewOwnerMigrationTask`