Merge branch '5.0/scheduled-process-docs' into 5.0.8-releng

Author: sunnavy

README.md

@@ -261,14 +261,20 @@ RT is commercially-supported software. To purchase hosting, support, training, c
     for the [`sbin/rt-clean-shorteners`](https://docs.bestpractical.com/rt/latest/sbin/rt-clean-shorteners.html)
     tool for options. You can schedule this to run regularly if desired.
 
+    RT provides an interface for running scheduled jobs to automate
+    some tasks, like resolving tickets after some period of time.
+    To enable this, schedule [`bin/rt-run-scheduled-processes`](https://docs.bestpractical.com/rt/latest/rt-run-scheduled-processes.html)
+    to run every 15 minutes.
+
     If your task scheduler is cron, you can configure it by
     adding the following lines as `/etc/cron.d/rt`:
 
     ```
-        0 0 * * * root /opt/rt5/sbin/rt-clean-sessions
-        0 0 * * * root /opt/rt5/sbin/rt-email-digest -m daily
-        0 0 * * 0 root /opt/rt5/sbin/rt-email-digest -m weekly
-        0 * * * * root /opt/rt5/sbin/rt-email-dashboards
+        0    0 * * * root /opt/rt5/sbin/rt-clean-sessions
+        0    0 * * * root /opt/rt5/sbin/rt-email-digest -m daily
+        0    0 * * 0 root /opt/rt5/sbin/rt-email-digest -m weekly
+        0    * * * * root /opt/rt5/sbin/rt-email-dashboards
+        */15 * * * * root /opt/rt5/bin/rt-run-scheduled-processes
     ```
 
     Other optional features like full text search indexes, external

docs/UPGRADING-5.0

@@ -696,4 +696,20 @@ If you previously set a custom C<@SearchResultsPerPage> and you want to keep the
 
 =back
 
+=head1 UPGRADING FROM 5.0.7 AND EARLIER
+
+=over 4
+
+=item Enabling Scheduled Processes in the Web UI
+
+RT 5.0.8 adds a new page for administrators to schedule automated processes
+in the web UI. This allows SuperUsers to add and modify C<rt-crontool> jobs
+that previously had to be managed on the server directly in C<cron>.
+
+To enable this, schedule the new utility C<bin/rt-run-scheduled-processes> in
+cron to run every 15 minutes. This job will then run any jobs scheduled in the
+web UI.
+
+=back
+
 =cut

docs/automating_rt.pod

@@ -270,17 +270,18 @@ isn't used.
 
 =head1 RT 5 Scheduled Processes
 
-The Scheduled Processes admin page was added in RT 5.0.8. It allows you to
-schedule an rt-crontool process directly in RT instead of scheduling it in cron.
+The Scheduled Processes admin page is available starting in RT 5.0.8. It allows
+you to schedule an rt-crontool process in the RT web UI instead of scheduling
+it in cron.
 
 Go to Admin > Tools > Scheduled Processes to view the list of Scheduled
 Processes.
 
 =for html <img alt="List Scheduled Processes" src="images/scheduled-processes.png">
 
-=for :text [Create a Custom Role F<docs/images/scheduled-processes.png>]
+=for :text [List Scheduled Processes F<docs/images/scheduled-processes.png>]
 
-=for :man [Create a Custom Role F<docs/images/scheduled-processes.png>]
+=for :man [List Scheduled Processes F<docs/images/scheduled-processes.png>]
 
 Click the Create tab to create a new scheduled process. Click an existing
 scheduled process to modify it.
@@ -291,25 +292,22 @@ section:
 
 =for html <img alt="Create a Scheduled Process" src="images/scheduled-process-create.png">
 
-=for :text [Create a Custom Role F<docs/images/scheduled-process-create.png>]
+=for :text [Create a Scheduled Process F<docs/images/scheduled-process-create.png>]
 
-=for :man [Create a Custom Role F<docs/images/scheduled-process-create.png>]
+=for :man [Create a Scheduled Process F<docs/images/scheduled-process-create.png>]
 
 and then schedule the process to run in the Schedule section:
 
 =for html <img alt="Schedule the Process" src="images/scheduled-process-schedule.png">
 
-=for :text [Create a Custom Role F<docs/images/scheduled-process-schedule.png>]
+=for :text [Schedule the Process F<docs/images/scheduled-process-schedule.png>]
 
-=for :man [Create a Custom Role F<docs/images/scheduled-process-schedule.png>]
+=for :man [Schedule the Process F<docs/images/scheduled-process-schedule.png>]
 
 You must schedule L<rt-run-scheduled-processes> in cron to run these scheduled
-processes. You'll need to have cron run this script every 15 minutes. Here's an
-example crontab entry to do this.
+processes. The web UI allows you to schedule jobs in 15 minute increments, so
+you'll need to have cron run this script every 15 minutes, for example:
 
     */15 * * * * /opt/rt5/bin/rt-run-scheduled-processes
 
-This will run the script every 15 minutes, every hour. This may need some
-further tweaking to be run as the correct user.
-
 =cut