[Rt-commit] [rtir] 05/05: Editing pass to improve clarity of our documentation

[Shawn Moore]

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 7b3f9a0ab5f4d4ceea795344dd9703794180214b
Author: Shawn M Moore <shawn at bestpractical.com>
Date:   Thu May 12 15:15:47 2016 -0400

    Editing pass to improve clarity of our documentation
---
 docs/AdministrationTutorial.pod | 18 +++++++++---------
 docs/Constituencies.pod         |  2 +-
 docs/Tutorial.pod               |  4 ++--
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/docs/AdministrationTutorial.pod b/docs/AdministrationTutorial.pod
index 557370d..53e698e 100644
--- a/docs/AdministrationTutorial.pod
+++ b/docs/AdministrationTutorial.pod
@@ -30,8 +30,8 @@ uncheck Enabled and click Save Changes.
 
 =head2 Status
 
-The various states an incident, IR, investigation, or block can be in, such as
-'open', 'stalled', 'abandoned', etc.
+The various states an incident, incident report, investigation, or block can be
+in, such as 'open', 'stalled', 'abandoned', etc.
 
 This field contains custom statuses for tickets, and values are different in
 different queues. The status values are set via the C<%Lifecycles> option in
@@ -45,9 +45,9 @@ of L</Scrips> below.
 
 =head2 Custom Fields
 
-When RTIR is installed several custom fields are created and applied
+When RTIR is installed, several custom fields are created and applied
 to queues in RTIR. Some of these custom fields are important for
-RTIR functionality and can not be renamed, disabled or un-applied,
+RTIR functionality and must not be renamed, disabled or un-applied,
 but other fields can be.
 
 =over 4
@@ -56,9 +56,9 @@ but other fields can be.
 
 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
-if you want to use this functionality.
+Heavy automation is tied to this field. This is described in the
+L<Constituencies> doc. Don't rename this field if you want to use this
+functionality.
 
 =item Description
 
@@ -116,9 +116,9 @@ Customer for an IR or Investigation.
 
 =head2 Managing "RT at a glance" and "RTIR at a glance" pages
 
-In the config you can set the @RTIR_HomepageComponents option to control
+In the config you can set the C<@RTIR_HomepageComponents> option to control
 allowed portlets people can add to thier workspace. RT has its own
-option $HomepageComponents so you can list different sets for RT and
+option C<$HomepageComponents> so you can list different sets for RT and
 RTIR. See L<Tutorial> for more information.
 
 =head2 Notifications
diff --git a/docs/Constituencies.pod b/docs/Constituencies.pod
index 3cb2650..d1cfaaa 100644
--- a/docs/Constituencies.pod
+++ b/docs/Constituencies.pod
@@ -3,7 +3,7 @@
 In some cases, your incident response team may provide
 services to multiple different "customers" or constituent
 groups. For example, you my provide incident support for both
-educational and governemental institutions.
+educational and government institutions.
 You may have different contact mechanisms for members
 of these groups including different email addresses for reporting
 incidents. For a variety of reasons, it makes sense to identify and
diff --git a/docs/Tutorial.pod b/docs/Tutorial.pod
index d068ba3..907496e 100644
--- a/docs/Tutorial.pod
+++ b/docs/Tutorial.pod
@@ -98,12 +98,12 @@ direction of the merge: "merge ticket #1 into #2" is not the same
 as "merge ticket #2 into #1".
 
 When you merge ticket #1 into #2 some properties of ticket #1
-are joined with respective properties of ticket #2: TimeEstimated,
+are joined with the respective properties of ticket #2: TimeEstimated,
 TimeWorked, TimeLeft, Requestors, Cc and AdminCc and Links.
 Duplicated links or watchers will be condensed; if there
 were links between tickets #1 and #2 then RT will drop them.
 Other fields from ticket #1 are ignored, such as status, queue or
-custom fields of single value type.
+single-value custom fields.
 
 By default RTIR shows only active tickets as candidates for the
 merge, so you typically will not merge a ticket into one that's

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.