[Rt-commit] [rtir] 04/05: Editing pass for documentation around single IR queues
Shawn Moore
shawn at bestpractical.com
Thu May 12 15:16:17 EDT 2016
This is an automated email from the git hooks/post-receive script.
shawn pushed a commit to branch 3.4/updated-docs
in repository rtir.
commit 71c4f778a619f4ded63287d825138162ccf0fdb1
Author: Shawn M Moore <shawn at bestpractical.com>
Date: Thu May 12 15:12:42 2016 -0400
Editing pass for documentation around single IR queues
e.g. instead of referring to "the Incidents queue", which is
the RTIR 3.2 way of thinking about things, refer to the less specific
"Incidents queues" or even just "Incidents".
Fixes: I#31753
---
docs/AdministrationTutorial.pod | 50 +++++++++++++++++++----------------------
docs/Tutorial.pod | 12 +++++-----
2 files changed, 29 insertions(+), 33 deletions(-)
diff --git a/docs/AdministrationTutorial.pod b/docs/AdministrationTutorial.pod
index 0858b64..557370d 100644
--- a/docs/AdministrationTutorial.pod
+++ b/docs/AdministrationTutorial.pod
@@ -17,15 +17,15 @@ To change a configuration value, copy the Set code from F<RT_Config.pm>
or F<RTIR_Config.pm> and add it to the relevant Site Config. Then set
your custom configuration values there.
-=head2 Blocks Queue
+=head2 Blocks Feature
-You may disable the Blocks queue by putting the following into your
+You may disable Blocks feature by putting the following into your
F<RTIR_SiteConfig.pm> config:
Set($RTIR_DisableBlocksQueue, 1);
-You will probably also want to disable the Queue using the RT
-Administrative interface. Tools -> Configuration -> Queues -> Blocks,
+You will probably also want to disable any Blocks queues using the RT
+Administrative interface. Tools -> Configuration -> Queues -> (select one),
uncheck Enabled and click Save Changes.
=head2 Status
@@ -54,7 +54,7 @@ but other fields can be.
=item Constituency
-The constituency of an incident, IR, investigation, or block.
+The constituency of an incident, incident report, investigation, or block.
Additional quite heavy automation is tied to this field. This
is described in L<Constituencies> doc. Don't rename this field
@@ -177,7 +177,7 @@ updating a status or replying to a requestor.
=item SetHowReported
-Applies to the Incident Reports queue.
+Applies to Incident Reports.
On ticket creation, sets the HowReported custom field to a default
value of Email if it isn't otherwise specified.
@@ -221,35 +221,31 @@ not copied down to Children).
=item ResolveAllChildren
-Applies to the Incidents queue.
+Applies to Incidents.
If an incident is changed to an inactive status,
-looks for linked tickets in the Incident Reports, Investigations or Blocks
+looks for linked tickets in Incident Reports, Investigations or Blocks
queues and resolves them. If any of these linked tickets are linked
to other ongoing incidents, a comment is added and they remain unresolved.
=item FixOwnership
-Applies to the Incidents queue.
+For Incidents: When the Owner of an incident is changed, the Owner of linked
+children tickets are changed to the same owner.
-When the Owner of an incident is changed, the Owner of linked children
-tickets are changed to the same owner.
-
-Applies to the Incident Reports, Blocks and Investigations queues.
-
-When the Owner of a ticket in these queues is changed, that change
-is also applied to the linked incident.
+For Incident Reports, Blocks and Investigations: When the Owner of a ticket in
+such queues is changed, that change is also applied to the linked Incident.
=item ReopenIncident
-Applies to the Incident Reports, Blocks and Investigations queues.
+Applies to Incident Reports, Blocks and Investigations.
-If the status of a ticket in these queues is changed from rejected or
-resolved, the linked parent incident ticket status is set to open.
+If the status of a ticket in such queues is changed from rejected or
+resolved, the linked parent Incident ticket status is set to open.
=item SetDefaultIncidentResolution
-Applies to the Incidents queue.
+Applies to Incidents.
When an incident's status is changed, if it is changed from an
inactive status to an active status, the Resolution custom field
@@ -260,7 +256,7 @@ F<RTIR_Config.pm>.
=item NotifyOnClose
-Applies to the Blocks queue.
+Applies to Blocks.
When a block ticket is moved from an active status to an inactive
status (closed), the requestors on the block are notified using the
@@ -268,7 +264,7 @@ L<Templates/BlockRemoved in Blocks queue> template.
=item SetIPFromContent
-Applies to the Incident Reports, Blocks, Incidents and Investigations queues.
+Applies to Incident Reports, Blocks, Incidents and Investigations.
Updates the ticket custom field IP to have a list of all IPs and IP ranges
found in the body of the ticket during Create and Correspond.
@@ -280,7 +276,7 @@ It's OK to disable this scrip.
=item SetConstituency
-Applies to the Incident Reports, Blocks, Incidents and Investigations queues.
+Applies to Incident Reports, Blocks, Incidents and Investigations.
Uses the Constituency algorithms discussed in F<docs/Constituencies.pod> to
set and propagate changes to the Constituency custom field. On ticket
@@ -294,7 +290,7 @@ _RTIR_Constituency_Propagation in your F<RTIR_Config.pm>
=item SetConstituencyGroup
-Applies to the Incident Reports, Blocks, Incidents and Investigations queues.
+Applies to Incident Reports, Blocks, Incidents and Investigations.
When tickets are created, or the Constituency custom field is updated,
this scrip manages the assignment of DutyTeam groups as AdminCcs.
@@ -389,10 +385,10 @@ L<RT::Extension::SLA> was prototyped on it, but vastly improved. In RTIR 3.0
we removed the SLA implementation in the core of RTIR that was in conflict
with the extension.
-RT 4.4 has cored L<RT::Extension::SLA>, please disable SLA on the Incidents
-queues. You will encounter a race condition between the core SLA and the RTIR
+RT 4.4 has cored L<RT::Extension::SLA>, please disable SLA on Incidents.
+You will encounter a race condition between the core SLA and the RTIR
scrips that synchronize due dates between an incident and its most due active
child. If you need to manage incident due dates using the core SLA, you can
-disable the RTIR scrips that manage due dates on the Incidents queues.
+disable the RTIR scrips that manage due dates on Incidents.
=cut
diff --git a/docs/Tutorial.pod b/docs/Tutorial.pod
index 1eddadd..d068ba3 100644
--- a/docs/Tutorial.pod
+++ b/docs/Tutorial.pod
@@ -53,11 +53,11 @@ If it turns out that two Incidents are actually the same
(which can occur when, for example, dynamic IP addresses are
involved), they may be merged. The merge operation effectively
makes one ticket out of two, containing the data and
-correspondence of both. Only tickets within the same queue
-should be merged, with the notable exception of merging an
-Incident Report into an Investigation when a correspondent's
-reply accidentally could not be recognized as such and thus
-got misfiled as new Incident Report.
+correspondence of both. Only tickets within the queues of the
+same type should be merged, with the notable exception of
+merging an Incident Report into an Investigation when a
+correspondent's reply accidentally could not be recognized as
+such and thus got misfiled as new Incident Report.
You can find the Merge link on the ticket display page.
The Merge page is split into two
@@ -117,7 +117,7 @@ on both tickets.
You can also access RT's standard merge from an RTIR ticket's
'Advanced' tab. This option allows you to merge any ticket into
-any other, avoiding 'the same queue' and other RTIR restrictions.
+any other, avoiding 'the same queue type' and other RTIR restrictions.
For example, you can merge an Investigation into an IR, or an IR
into a ticket in non-RTIR queues. Access checks and permissions still
apply. In the normal course of work, this operation should be avoided.
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the rt-commit
mailing list