Merge branch '6' into 7.0

# Conflicts:
#	docs/en/configuration.md

Author: emteknetnz

.doclintrc

@@ -0,0 +1 @@
+docs/en/

composer.json

@@ -29,6 +29,7 @@
     "require-dev": {
         "phpunit/phpunit": "^11.3",
         "squizlabs/php_codesniffer": "^3",
+        "silverstripe/documentation-lint": "^1",
         "silverstripe/standards": "^1",
         "phpstan/extension-installer": "^1.3"
     },
@@ -39,6 +40,11 @@
             "images"
         ]
     },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    },
     "suggest": {
         "symbiote/silverstripe-queuedjobs": "Allow automated workflow transitions with queued system jobs"
     },

docs/en/01_adding-workflows.md

@@ -0,0 +1,31 @@
+---
+title: Adding Workflows to Other Content Objects
+summary: Applying workflows to custom models and their corresponding ModelAdmins
+icon: project-diagram
+---
+
+# Adding workflows to other content objects
+
+In order to apply workflow to other classes (e.g. `MyObject`), you need
+to apply it to both the model class and the controller
+which is used for editing it. Here's an example for `MyObject`
+which is managed through a `MyObjectAdmin` controller,
+extending from [`ModelAdmin`](api:SilverStripe\Admin\ModelAdmin).
+
+```yml
+App\Models\MyObject:
+  extensions:
+    - 'Symbiote\AdvancedWorkflow\Extensions\WorkflowApplicable'
+App\ModelAdmins\MyObjectAdmin:
+  extensions:
+    - 'Symbiote\AdvancedWorkflow\Extensions\AdvancedWorkflowExtension'
+```
+
+We strongly recommend also setting the [`NotifyUsersWorkflowAction`](api:Symbiote\AdvancedWorkflow\Actions\NotifyUsersWorkflowAction) configuration parameter [`NotifyUsersWorkflowAction.whitelist_template_variables`](api:Symbiote\AdvancedWorkflow\Actions\NotifyUsersWorkflowAction->whitelist_template_variables) to true on new projects. This configuration will achieve this:
+
+```yml
+Symbiote\AdvancedWorkflow\Actions\NotifyUsersWorkflowAction:
+  whitelist_template_variables: true
+```
+
+See the [Security](./04_security.md) section for more details.

docs/en/02_embaro_expiry.md

@@ -0,0 +1,26 @@
+---
+title: Embargo and Expiry
+summary: Configure embargo and expiry functionality for content changes
+icon: calendar-alt
+---
+
+# Embargo and expiry
+
+This add-on functionality allows you to embargo some content changes to only appear as published at some future date. To enable it,
+add the [`WorkflowEmbargoExpiryExtension`](api:Symbiote\AdvancedWorkflow\Extensions\WorkflowEmbargoExpiryExtension).
+
+```yml
+SilverStripe\CMS\Model\SiteTree:
+  extensions:
+    - 'Symbiote\AdvancedWorkflow\Extensions\WorkflowEmbargoExpiryExtension'
+```
+
+Make sure the [Queued Jobs](https://docs.silverstripe.org/en/optional_features/queuedjobs/) module is installed and configured correctly.
+You should have a cronjob similar to the following in place, running as the webserver user.
+
+```bash
+*/1 * * * * cd  && sudo -u www php /var/www/vendor/bin/sake dev/tasks/ProcessJobQueueTask
+```
+
+It also allows for an optional subsequent expiry date. Note: Changes to these dates also constitute modifications to the content and as such
+are subject to the same workflow approval processes, where a particular workflow instance is in effect. The embargo export functionality can also be used independently of any workflow.

docs/en/03_reminder-emails.md

@@ -0,0 +1,21 @@
+---
+title: Sending Reminder Emails
+summary: Configuring automated email reminders for pending workflows
+icon: envelope
+---
+
+# Sending reminder emails
+
+The workflow engine can send out email reminders if a workflow has been open for longer
+than a couple of days (configurable in each "Workflow Definition" through the CMS).
+
+Periodically run the Workflow Reminder Task by adding a task like this one to the crontab:
+
+```bash
+# Check every minute if someone needs to be reminded about pending workflows
+*/1 * * * * cd /var/www && vendor/bin/sake dev/tasks/WorkflowReminderTask
+```
+
+This is an example only. The key is to run the task as the same user as the web server.
+
+You can run the task manually for testing by visiting the `/dev/tasks/WorkflowReminderTask` URL of your site.

docs/en/security.md docs/en/04_security.mddocs/en/security.md renamed to docs/en/04_security.md

@@ -1,12 +1,18 @@
-## Security
+---
+title: Security
+summary: Ehance security by restricting accessible parameters in email templates.
+icon: user-shield
+---
 
-### `whitelist_template_variables`
+# Security
 
-The `NotifyUsersWorkflowAction` workflow action has a configuration parameter, `whitelist_template_variables`.
+## `whitelist_template_variables`
+
+The [`NotifyUsersWorkflowAction`](api:Symbiote\AdvancedWorkflow\Actions\NotifyUsersWorkflowAction) workflow action has a configuration parameter, `whitelist_template_variables`.
 Currently this variable defaults to false in order to retain backwards compatibility. In a future major release it will
 be changed to default to true.
 
 Setting this configuration variable to true will limit template variables available in the email template sent as part
 of the notify users action to a known-safe whitelist. When it is false, the template may reference any accessible parameter.
 As this template is editable in the CMS, whitelisting these parameters ensures CMS admins can not bypass data access
-restrictions.
+restrictions.

docs/en/configuration.md

@@ -1,15 +1,21 @@
-# Advanced Workflow documentation
+---
+title: Advanced Workflow
+summary: Create and apply approval workflows to content, with features like embargo/expiry and notifications
+icon: project-diagram
+---
 
-## Developer documentation
- - [Configuration](configuration.md)
- - [Security](security.md)
- 
-## User guide
- - [What is a workflow?](userguide/about-workflows.md)
- - [Using workflows](userguide/using-workflows.md)
- - [Setting up workflows](userguide/setting-up-workflows.md)
- - [Workflow users and permissions](userguide/workflow-permissions.md)
- - [Advanced workflow setup](userguide/workflow-advanced-setup.md)
- - [Exporting and importing workflows](userguide/workflow-export-import.md)
+# Advanced workflow
 
+The Advanced Workflow module allows you to create and apply approval workflows to content objects. This includes features such as setting embargo and expiry dates, and sending email notifications and reminders.
 
+## Installation
+
+```bash
+composer require symbiote/silverstripe-advancedworkflow
+```
+
+## GitHub repository
+
+<https://github.com/symbiote/silverstripe-advancedworkflow>
+
+[CHILDREN]

docs/en/index.md

@@ -1,11 +1,12 @@
 ---
 title: What is a Workflow?
 ---
-# What is a Workflow?
+# What is a workflow?
+
 Workflows enforce content changes to go through approval processes before being published.
 For example, you might have a team of staff who author content, but they are not allowed to publish that content publicly
 until a manager or communications adviser has given approval. This works by limiting access to certain parts of the workflow
-process to certain users or groups of users set up in the SilverStripe CMS Security admin.
+process to certain users or groups of users set up in the Silverstripe CMS Security admin.
 
 The CMS can have an unlimited number of workflows created and running within it, but only one workflow can be
 attached to a content-object (e.g a "Page") at any one time. Each workflow comprises a number of definable "Actions"
@@ -26,7 +27,8 @@ If sitemap inheritance is not what you desire then you can stop inheritance on a
 
 If you need pagetypes to be automatically assigned a specific workflow, we'd recommend adding an extension to the WorkflowDefinition to define the page type(s) it's meant to be used for, and then an onBeforeWrite on the page type, to find and assign that WorkflowDefinition.
 
-## Workflow Terminology
+## Workflow terminology
+
 - **Workflow Definition**: Description of all the "actions" and "transitions" that make up a single workflow process to publish a page. Definitions are applied to pages within the CMS and are managed through the "Workflows" section of the CMS.
 - **Workflow Instance**: When a user wants to publish a page, instead of selecting the 'publish' button, they instead start a workflow, or more specifically, an instance of the "Workflow Definition" applied to that page. This "Instance" contains all the relevant data (e.g. user choices, comments, etc) for the running workflow on that page's content.
 - **Workflow Action**: A workflow can have many actions. Actions describe a single process occurring at each workflow step. Each piece of workflow logic is encapsulated in an action, such as assigning users, publishing a page, or sending notifications.

docs/en/userguide/about-workflows.md

@@ -7,12 +7,13 @@ summary: Setting up and using a publishing workflow with the Advanced Workflow m
 
 ## Before we begin
 
-Make sure that your SilverStripe CMS installation has the [Advanced Workflow](https://addons.silverstripe.org/add-ons/symbiote/silverstripe-advancedworkflow/) module installed.
+Make sure that your Silverstripe CMS installation has the [Advanced Workflow](https://addons.silverstripe.org/add-ons/symbiote/silverstripe-advancedworkflow/) module installed.
 
-## Advanced Workflow features
- - [What is a workflow?](about-workflows.md)
- - [Using workflows](using-workflows.md)
- - [Setting up workflows](setting-up-workflows.md)
- - [Workflow users and permissions](workflow-permissions.md)
- - [Advanced workflow setup](workflow-advanced-setup.md)
- - [Exporting and importing workflows](workflow-export-import.md)
+## Advanced workflow features
+
+- [What is a workflow?](about-workflows.md)
+- [Using workflows](using-workflows.md)
+- [Setting up workflows](setting-up-workflows.md)
+- [Workflow users and permissions](workflow-permissions.md)
+- [Advanced workflow setup](workflow-advanced-setup.md)
+- [Exporting and importing workflows](workflow-export-import.md)