[Rt-commit] rt branch, 4.4/user-shred-docs, created. rt-4.4.3-154-g1545980e87

[Jim Brandt]

The branch, 4.4/user-shred-docs has been created
        at  1545980e87aaadee6578d0dad5a815f81ab7dc55 (commit)

- Log -----------------------------------------------------------------
commit 52065c240b6e42135e85dadc7e0f51cfe2a06c88
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Mon Dec 31 15:47:00 2018 -0500

    Add and display a Synopsis for the user shredder plugin
    
    Provide more context on using the user shredder plugin by
    adding a Synopsis section and displaying it in the web UI.

diff --git a/lib/RT/Shredder/POD.pm b/lib/RT/Shredder/POD.pm
index 3a67aef968..32c8e65a78 100644
--- a/lib/RT/Shredder/POD.pm
+++ b/lib/RT/Shredder/POD.pm
@@ -57,7 +57,7 @@ sub plugin_html
 {
     my ($file, $out_fh) = @_;
     my $parser = RT::Shredder::POD::HTML->new;
-    $parser->select('ARGUMENTS', 'USAGE');
+    $parser->select('SYNOPSIS', 'ARGUMENTS', 'USAGE');
     $parser->parse_from_file( $file, $out_fh );
     return;
 }
diff --git a/lib/RT/Shredder/Plugin/Users.pm b/lib/RT/Shredder/Plugin/Users.pm
index 43bf624ba7..2872947e61 100644
--- a/lib/RT/Shredder/Plugin/Users.pm
+++ b/lib/RT/Shredder/Plugin/Users.pm
@@ -56,6 +56,37 @@ use base qw(RT::Shredder::Plugin::Base::Search);
 
 RT::Shredder::Plugin::Users - search plugin for wiping users.
 
+=head1 SYNOPSIS
+
+This shredder plugin removes user records from the RT system. Since users
+can be connected to many other objects in RT, these connections must be
+resolved in some way before removing a user record. RT will not
+automatically shred linked objects (i.e., tickets, transactions,
+attachments, etc.) when attempting to shred a user.
+
+RT provides the following options for handling linked objects.
+
+=head2 Replace User
+
+This option locates all records currently referenced by the user you with
+to shred and replaces the reference with a reference to the user record you
+provide. This can be another real user or a placeholder user. Once these
+references are updated, the original user can be shredded.
+
+You can use this option with the replace_relations argument.
+
+=head2 Delete Objects First
+
+If you wish to completely remove all records associated with a user, you
+can perform searches and remove objects using other shredder plugins first.
+For example, if the user is a requestor on one or more tickets, first use the
+Tickets shredder plugin and search for "RequestorEmail = user1 at example.com".
+Once all associated objects are removed, you may then use the users plugin
+to shred the user record.
+
+If you receive an error when trying to shred a user, it's possible it is still
+reference by other objects in RT.
+
 =head1 ARGUMENTS
 
 =head2 status - string

commit 1545980e87aaadee6578d0dad5a815f81ab7dc55
Author: Jim Brandt <jbrandt at bestpractical.com>
Date:   Mon Dec 31 15:49:07 2018 -0500

    Adjust spacing for shredder style

diff --git a/share/static/css/base/shredder.css b/share/static/css/base/shredder.css
index dc57f2441e..3af89e4ede 100644
--- a/share/static/css/base/shredder.css
+++ b/share/static/css/base/shredder.css
@@ -6,10 +6,12 @@
 .rt-general-header2 {
   font-style: italic;
   font-size: 1.1em;
+  padding-left: 3em;
 }
 
 .rt-general-paragraph {
-  padding-left: 2em;
+  padding-left: 6em;
+  padding-right: 6em;
 }
 
 .shredder-form {

-----------------------------------------------------------------------