diff --git a/Classes/Domain/Task/Review/ReviewTask.php b/Classes/Domain/Task/Review/ReviewTask.php index 55dd46a..30472d4 100644 --- a/Classes/Domain/Task/Review/ReviewTask.php +++ b/Classes/Domain/Task/Review/ReviewTask.php @@ -59,8 +59,8 @@ final class ReviewTask implements TaskInterface * @param \DateTimeImmutable $scheduledTime * @param ActionStatusType $actionStatus * @param Agent $agent - * @param NodeInterface|null $object - * @param UriInterface $target + * @param TraversableNodeInterface|null $object + * @param UriInterface|null $target */ public function __construct( TaskIdentifier $identifier, diff --git a/Documentation/00_Index.md b/Documentation/00_Index.md new file mode 100644 index 0000000..6e64026 --- /dev/null +++ b/Documentation/00_Index.md @@ -0,0 +1 @@ +1. [Configuration](./Documentation/01_Configuration.md) diff --git a/Documentation/01_Configuration.md b/Documentation/01_Configuration.md new file mode 100644 index 0000000..145d758 --- /dev/null +++ b/Documentation/01_Configuration.md @@ -0,0 +1,32 @@ +
+ Index +
+ +--- + +# 1. Configuration + +Bitzer review tasks can be set up completely via configuration. There are two mixin NodeTypes provided +that can be used by any custom node type that should have review capabilities: +```yaml +'Acme.Site:Document.NewsArticle': + superTypes: + 'Sitegeist.Bitzer.Review:Mixin.Reviewable': true + 'Sitegeist.Bitzer.Review:Mixin.Setting.Review': true +``` +The `Reviewable` mixin flags the node type as reviewable, while the `Setting.Review` mixin provides the necessary properties: + +![Screenshot of Inspector Editor](inspector.png) + +Whenever a node of a node type configured as above is published, a review task will be automatically created +using the selected agent and interval. After the interval has passed, it will appear in Bitzer's +task overview module for the agent and can be activated there. Activation will set the task to state `active` +and redirect the user to the node in the Neos backend view. Once the node is reviewed, +the task can either be manually completed or will be automatically completed when the node is published again, +triggering the creation of a new review task for the future. + +--- + +
+ Index +
diff --git a/Documentation/inspector.png b/Documentation/inspector.png new file mode 100644 index 0000000..40a8e3b Binary files /dev/null and b/Documentation/inspector.png differ diff --git a/README.md b/README.md new file mode 100644 index 0000000..41fe2d3 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Sitegeist.Bitzer.Review + +> The review task plugin for the Bitzer content lifecycle task manager for Neos CMS + +## Features + +This package provides review tasks for Bitzer. They can be configured to be +automatically created and completed on node publication as well as manually handled +via Bitzer's management module and command controller. + +## Installation + +``` +composer require sitegeist/bitzer-review +``` + +## Documentation + +1. [Configuration](./Documentation/01_Configuration.md)