[Rt-commit] r9120 - in rtir/branches/2.3-EXPERIMENTAL: .

sartak at bestpractical.com sartak at bestpractical.com
Fri Sep 21 17:38:29 EDT 2007


Author: sartak
Date: Fri Sep 21 17:38:29 2007
New Revision: 9120

Modified:
   rtir/branches/2.3-EXPERIMENTAL/   (props changed)
   rtir/branches/2.3-EXPERIMENTAL/lib/RT/IR/AdministrationTutorial.pod
   rtir/branches/2.3-EXPERIMENTAL/lib/RT/IR/Tutorial.pod

Log:
 r42997 at onn:  sartak | 2007-09-21 17:38:23 -0400
 Various cleanups. There are no more "I think this is what happens.." or "XXX: write this" type statements in the doc


Modified: rtir/branches/2.3-EXPERIMENTAL/lib/RT/IR/AdministrationTutorial.pod
==============================================================================
--- rtir/branches/2.3-EXPERIMENTAL/lib/RT/IR/AdministrationTutorial.pod	(original)
+++ rtir/branches/2.3-EXPERIMENTAL/lib/RT/IR/AdministrationTutorial.pod	Fri Sep 21 17:38:29 2007
@@ -2,7 +2,9 @@
 
 =head2 Blocks Queue
 
-Discussed a little in Tutorial
+You may disable the Blocks by putting the following into your RTIR config:
+
+    Set($RTIR_DisableBlocksQueue, 1);
 
 =head2 Custom Fields
 
@@ -27,11 +29,11 @@
 
 =item _RTIR_SLA
 
-The SLA with the reporter of an IR
+The SLA of an IR
 
 =item _RTIR_Function
 
-Who is handling the Incident. I think..
+Who is handling the Incident
 
 =item _RTIR_Classification
 
@@ -49,6 +51,8 @@
 
 IP addresses related to the incident, IR, investigation, or block
 
+L<Tutorial/'IP'>
+
 =item _RTIR_Netmask
 
 Network mask for a Block
@@ -69,7 +73,49 @@
 
 =head2 Scrips
 
-RTIR specific scripts
+=over 4
+
+=item DetectUserResponse
+
+=item DetectStaffResponse
+
+=item SetStartsDate
+
+=item SetStarts
+
+=item SetStartsDateOnQueueChange
+
+=item SetStarted
+
+=item SetDue
+
+=item SetDueOnQueueChange
+
+=item UnsetDue
+
+=item SetDueReopen
+
+=item SetHowReported
+
+=item SetRTIRState
+
+=item ResolveAllChildren
+
+=item FixOwnership
+
+=item ReopenIncident
+
+=item SetDefaultIncidentResolution
+
+=item NotifyOnClose
+
+=item SetIPFromContent
+
+=item SetConstituency
+
+=item SetConstituencyGroup
+
+=back
 
 =head2 Templates
 

Modified: rtir/branches/2.3-EXPERIMENTAL/lib/RT/IR/Tutorial.pod
==============================================================================
--- rtir/branches/2.3-EXPERIMENTAL/lib/RT/IR/Tutorial.pod	(original)
+++ rtir/branches/2.3-EXPERIMENTAL/lib/RT/IR/Tutorial.pod	Fri Sep 21 17:38:29 2007
@@ -115,18 +115,18 @@
 
 =head3 Splitting tickets
 
-Split operation allows user to create new ticket from the existing one.
+The Split operation allows user to create a new ticket from an existing one.
 When a user selects the 'Split' tab he will see a new ticket creation form 
 with information pre-filled from the original ticket, for example Subject, 
 Owner, Correspondents(Requestors), Ccs, AdminCs, as well as the original ticket's
 history, formatted as text in the message box. The user can change any and all
-values before creating a new ticket.
+values before splitting off the new ticket.
 
 "Split" tickets can only be created in the same queue as the ticket they're
 split from.
 
 Note that the split action is implemented over "create" function and if
-your RTIR configured to notify requestors (correspondents) then mail(s)
+your RTIR is configured to notify requestors (correspondents) then mail(s)
 would be send after split. However you can use "Don't send any emails to
 correspondents" checkbox from the split page to avoid notifications.
 
@@ -161,9 +161,9 @@
 'bulk reject' page, while the latter one returns you to the RTIR home page
 where you could continue your work.
 
-Note that you can't reject IRs that are owned by somebody else (sure, you
-can reject unowned) with the bulk reject interface, these IRs would be
-skipped with a notice even if you'd selected some.
+Note that you can't reject IRs that are owned by somebody else (you can,
+however, reject unowned IRs) with the bulk reject interface. IRs owned by
+others will be skipped with a warning even if you selected them.
 
 =head3 Abandoning Incidents
 
@@ -171,10 +171,9 @@
 abandoning an Incident you also reject IRs, resolve Investigations and
 remove Blocks linked to it.
 
-Once you open abandon page with the Incidents tab you see a list of its
-children grouped by queue and common update form. You can select children
-with checkboxes, only children you've selected will be rejected, resolved
-or removed.
+Once you open the Abandon page under the Incidents tab you see a list of its
+children grouped by queue. You can select children with checkboxes, only
+children you've selected will be rejected, resolved or removed.
 
 Resolution of the Incident is set according to C<$_RTIR_Resolution_rejected_default>
 config option and by default its value is "no resolution reached", however,
@@ -206,9 +205,9 @@
 
 =head3 Locking
 
-A lock is created whenever a user performs an action on a ticket that takes
-multiple steps if a hard lock is not already in place for that ticket. The
-following actions produce an auto lock:
+An automatic lock is created whenever a user performs an action on a ticket that
+takes multiple steps (unless a hard lock is already in place for that ticket).
+The following actions produce an auto lock:
 
     - Edit
     - Split
@@ -220,17 +219,17 @@
     - Comment
     - Remove
 
-An auto lock is removed once the user is done with whatever he was doing
-on the page (e.g., when he clicks "Save Changes" on the Edit page).
-It is also removed if the Unlock link is clicked from a page that generated
-an auto lock.
-
 Locks are advisory: if a ticket is locked by one user, other users
 will be given a notification (in red) that another user has locked
 the ticket, with the locking user's name and how long he has had
 it locked for, but they will still be allowed to edit and submit
 changes on the ticket.
 
+An auto lock is removed once the user is done with whatever he was doing
+on the page (e.g., when he clicks "Save Changes" on the Edit page).
+It is also removed if the Unlock link is clicked from a page that generated
+an auto lock.
+
 For more information, see L<RT::Extension::TicketLocking>.
 
 =head3 Correspondence
@@ -269,20 +268,20 @@
 
 You may link Incidents with existing Incident Responses, Investigations,
 Blocks, and RTFM articles. On the Incident display page there are sections for
-each of these, each with a C<Link> button and the list of already-linked items.
-Clicking on C<Link> lets you link one or more items of that type to the
-Incident.
+each of these, each with a C<Link> button and the list of already-linked
+tickets. Clicking on C<Link> lets you link one or more tickets of that type to
+the Incident.
 
-Clicking on C<New> (or in the case of Investigations, C<Launch>) lets you create
-a new item and link it to the Incident automatically.
+Clicking on C<New> (or in the case of Investigations, C<Launch>) lets you
+create a new tickets and link it to the Incident automatically.
 
 =head3 Resolution
 
 =head4 Resolving an Incident
 
-Once you open resolve page under the Incidents tab you see a list of its
+Once you open the Resolve page under the Incidents tab you see a list of its
 children grouped by queue and common update form. You can select children
-with checkboxes, only children you've selected will resolved.
+with checkboxes. Only children you've selected will resolved.
 
 You can write a message that that will be added to the selected children as
 a comment or response according to value of 'Update Type' field.
@@ -297,9 +296,17 @@
 
 =head4 Quick Resolve
 
-Incidents have a "Quick Resolve" feature. Clicking Quick Resolve will change
-an Incident's status to 'resolved' immediately. You won't be asked to fill in
-a message or time worked, attach files, and so on.
+Incidents and IRs have a "Quick Resolve" feature. Clicking Quick Resolve will
+change a ticket's status to 'resolved' immediately. You won't be asked to
+fill in a message or time worked, attach files, and so on.
+
+=head3 Investigation
+
+=head4 Launching an Investigation
+
+To launch a new Investigatin, create a new ticket in the Investigation queue.
+You will be required to link the Investigation to an Incident, and provide one
+or more correspondents.
 
 =head3 Blocks
 


More information about the Rt-commit mailing list