silverstripe-contentreview/docs/en/index.md

36 lines
971 B
Markdown
Raw 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 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.
## Using
See [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
```
or to test this module when used on a website:
2015-09-15 07:46:13 +02:00
2015-10-29 19:22:35 +01:00
```sh
$ php vendor/bin/behat contentreview/tests
```
## Migration
2015-10-29 19:22:35 +01:00
If you are upgrading from an older version, you may need to run the `ContentReviewOwnerMigrationTask`