diff --git a/docs/en/index.md b/docs/en/index.md index 88062fb..383c077 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -1,4 +1,4 @@ -# Content Review module developer documentation +# Content Review module developer documentation ## Configuration @@ -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 diff --git a/docs/en/userguide/_images/content-review-permission.png b/docs/en/userguide/_images/content-review-permission.png index 4addf4a..43fe2ef 100644 Binary files a/docs/en/userguide/_images/content-review-permission.png and b/docs/en/userguide/_images/content-review-permission.png differ diff --git a/docs/en/userguide/_images/content-review-settings-ro.png b/docs/en/userguide/_images/content-review-settings-ro.png index 95e9ec4..3e877e8 100644 Binary files a/docs/en/userguide/_images/content-review-settings-ro.png and b/docs/en/userguide/_images/content-review-settings-ro.png differ diff --git a/docs/en/userguide/_images/content-review-settings.png b/docs/en/userguide/_images/content-review-settings.png index 4e23051..1649f0c 100644 Binary files a/docs/en/userguide/_images/content-review-settings.png and b/docs/en/userguide/_images/content-review-settings.png differ diff --git a/docs/en/userguide/_images/content-review-siteconfig-settings.png b/docs/en/userguide/_images/content-review-siteconfig-settings.png index 5b2776e..d2113db 100644 Binary files a/docs/en/userguide/_images/content-review-siteconfig-settings.png and b/docs/en/userguide/_images/content-review-siteconfig-settings.png differ diff --git a/docs/en/userguide/index.md b/docs/en/userguide/index.md index c2e58b4..94626b2 100644 --- a/docs/en/userguide/index.md +++ b/docs/en/userguide/index.md @@ -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) \ No newline at end of file +![Read only view of page content review settings](_images/content-review-settings-ro.png) diff --git a/readme.md b/readme.md index dafc75b..252b4a5 100644 --- a/readme.md +++ b/readme.md @@ -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:///dev/build` or -by running the dev/build via a CLI. +Run dev/build either via the web server by opening the URL `http:///dev/build?flush` or +by running the dev/build via a CLI: `sake dev/build flush=1` ## Documentation