[Rt-commit] [rtir] 17/33: Update documentation to refer to Countermeasures not Blocks
Shawn Moore
shawn at bestpractical.com
Fri May 13 20:21:27 EDT 2016
This is an automated email from the git hooks/post-receive script.
shawn pushed a commit to branch 3.4/countermeasures
in repository rtir.
commit 835c5399cce44c94b3084ac6e0cc708cc005e663
Author: Shawn M Moore <shawn at bestpractical.com>
Date: Thu Feb 25 00:12:06 2016 +0000
Update documentation to refer to Countermeasures not Blocks
---
docs/AdministrationTutorial.pod | 61 +++++++++++++++++++++--------------------
docs/Constituencies.pod | 8 +++---
docs/DocIndex.pod | 26 +++++++++---------
docs/Tutorial.pod | 60 ++++++++++++++++++++--------------------
4 files changed, 78 insertions(+), 77 deletions(-)
diff --git a/docs/AdministrationTutorial.pod b/docs/AdministrationTutorial.pod
index 358b378..dc09b88 100644
--- a/docs/AdministrationTutorial.pod
+++ b/docs/AdministrationTutorial.pod
@@ -17,21 +17,21 @@ 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 Countermeasures Queue
-You may disable the Blocks queue by putting the following into your
+You may disable the Countermeasures queue by putting the following into your
F<RTIR_SiteConfig.pm> config:
Set($RTIR_DisableCountermeasures, 1);
You will probably also want to disable the Queue using the RT
-Administrative interface. Tools -> Configuration -> Queues -> Blocks,
+Administrative interface. Tools -> Configuration -> Queues -> Countermeasures,
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, IR, investigation, or countermeasure 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
@@ -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, IR, investigation, or countermeasure.
Additional quite heavy automation is tied to this field. This
is described in L<Constituencies> doc. Don't rename this field
@@ -87,7 +87,7 @@ or external individual.
=item IP
-IP addresses related to the incident, IR, investigation, or block.
+IP addresses related to the incident, IR, investigation, or countermeasure.
Don't rename this custom field or it will lose all associated features.
It's possible to change this CF from multiple values to single value.
@@ -98,15 +98,15 @@ See also L</SetIPFromContent> below.
=item Netmask
-Network mask for a Block.
+Network mask for a block countermeasure.
=item Port
-Port for a Block.
+Port for a network block.
=item Where Blocked
-Where the block is placed.
+Where the network block is placed.
=item Customer
@@ -181,12 +181,12 @@ Applies to the Incident Reports queue.
On ticket creation, sets the HowReported custom field to a default
value of Email if it isn't otherwise specified.
-=item On Correspond Change Status of the Block
+=item On Correspond Change Status of the Countermeasure
-On replies, changes the status of blocks according to a few rules
+On replies, changes the status of countermeasures according to a few rules
that are described in L<RT::Action::RTIR_SetBlockStatus/DESCRIPTION>.
-RT's default L<RT::Action::AutoOpen> is disabled for blocks to
+RT's default L<RT::Action::AutoOpen> is disabled for countermeasures to
avoid unwanted changes of status from 'pending activation'
to 'active'.
@@ -223,10 +223,10 @@ not copied down to Children).
Applies to the Incidents queue.
-If an incident is changed to an inactive status,
-looks for linked tickets in the 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.
+If an incident is changed to an inactive status, looks for linked tickets in
+the Incident Reports, Investigations or Countermeasures 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
@@ -235,14 +235,14 @@ Applies to the Incidents queue.
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.
+Applies to the Incident Reports, Countermeasures and Investigations queues.
When the Owner of a ticket in these 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 the Incident Reports, Countermeasures and Investigations queues.
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.
@@ -260,15 +260,16 @@ F<RTIR_Config.pm>.
=item NotifyOnClose
-Applies to the Blocks queue.
+Applies to the Countermeasures queue.
-When a block ticket is moved from an active status to an inactive
-status (closed), the requestors on the block are notified using the
-L<Templates/BlockRemoved in Blocks queue> template.
+When a countermeasure ticket is moved from an active status to an inactive
+status (closed), the requestors on the countermeasure are notified using the
+L<Templates/BlockRemoved in Countermeasure queue> template.
=item SetIPFromContent
-Applies to the Incident Reports, Blocks, Incidents and Investigations queues.
+Applies to the Incident Reports, Countermeasures, Incidents and Investigations
+queues.
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 +281,7 @@ It's OK to disable this scrip.
=item SetConstituency
-Applies to the Incident Reports, Blocks, Incidents and Investigations queues.
+Applies to the Incident Reports, Countermeasures, Incidents and Investigations queues.
Uses the Constituency algorithms discussed in F<docs/Constituencies.pod> to
set and propagate changes to the Constituency custom field. On ticket
@@ -294,7 +295,7 @@ _RTIR_Constituency_Propagation in your F<RTIR_Config.pm>
=item SetConstituencyGroup
-Applies to the Incident Reports, Blocks, Incidents and Investigations queues.
+Applies to the Incident Reports, Countermeasures, Incidents and Investigations queues.
When tickets are created, or the Constituency custom field is updated,
this scrip manages the assignment of DutyTeam groups as AdminCcs.
@@ -309,13 +310,13 @@ how to use these groups.
=over 4
-=item Autoreply in Blocks queue
+=item Autoreply in Countermeasures queue
-This template is sent when a block is created.
+This template is sent when a countermeasure is created.
-=item BlockRemoved in Blocks queue
+=item BlockRemoved in Countermeasure queue
-This template is sent when a block is removed.
+This template is sent when a countermeasure is removed.
=item Autoreply in Investigations queue
diff --git a/docs/Constituencies.pod b/docs/Constituencies.pod
index 3cb2650..8004ba2 100644
--- a/docs/Constituencies.pod
+++ b/docs/Constituencies.pod
@@ -48,7 +48,7 @@ Its correspondence email address.
=item *
Its queues--typically a set with one each of Incident Reports,
-Incidents, Investigations, and Blocks--each with the same
+Incidents, Investigations, and Countermeasures--each with the same
RTIR Constituency value defined.
=item *
@@ -70,7 +70,7 @@ creates tickets.
=item *
-Any new incidents created from incident reports, or blocks and
+Any new incidents created from incident reports, or countermeasures and
investigations created from incidents, inherit the constituency
from the launching ticket.
@@ -132,7 +132,7 @@ the constituency 'EDUNET':
=item * Queue 'Inestigations - EDUNET'
-=item * Queue 'Blocks - EDUNET'
+=item * Queue 'Countermeasures - EDUNET'
=item * Group 'DutyTeam EDUNET'
@@ -256,7 +256,7 @@ the EDUNET constituency on the Incidents queue, for example).
For example, assume you have two constituencies "EDUNET" and "GOVNET".
Your RTIR instance consists of four queues for each constituency: Incident Reports - EDUNET,
-Incidents - EDUNET, Investigations - EDUNET and Blocks - EDUNET. To grant the user Edward
+Incidents - EDUNET, Investigations - EDUNET and Countermeasures - EDUNET. To grant the user Edward
the right to work with EDUNET Incident Reports, make Edward an
AdminCc of the new queue, either directly or as a member of a group
like "DutyTeam EDUNET".
diff --git a/docs/DocIndex.pod b/docs/DocIndex.pod
index 06fb11a..c776f71 100644
--- a/docs/DocIndex.pod
+++ b/docs/DocIndex.pod
@@ -23,9 +23,9 @@ Mailgate help: rt/bin/rt-mailgate --help
See L<RT::Crypt::GnuPG> and L<AdministrationTutorial/GnuPG Encryption>
-=head3 Create new block via web-interface
+=head3 Create new countermeasure via web-interface
-L<Tutorial/Creating a Block>
+L<Tutorial/Creating a Countermeasure>
=head2 Managing Incident Responses
@@ -75,11 +75,11 @@ L<Tutorial/Linking Incidents to IRs, Investigations, etc.>
L<Tutorial/Linking Incidents to IRs, Investigations, etc.>
-=head2 Link Incident with new Block
+=head2 Link Incident with new Countermeasure
L<Tutorial/Linking Incidents to IRs, Investigations, etc.>
-=head2 Link Incident with existing Block
+=head2 Link Incident with existing Countermeasure
L<Tutorial/Linking Incidents to IRs, Investigations, etc.>
@@ -111,19 +111,19 @@ L<Tutorial/Linking Incidents to IRs, Investigations, etc.>
L<Tutorial/Correspond with Correspondent>
-=head2 Remove Blocks
+=head2 Remove Countermeasures
-L<Tutorial/Blocks>
+L<Tutorial/Countermeasures>
-=head2 Activate Blocks
+=head2 Activate Countermeasures
-L<Tutorial/Blocks>
+L<Tutorial/Countermeasures>
-=head2 Split Blocks, Split Investigation, Split Incident
+=head2 Split Countermeasures, Split Investigation, Split Incident
L<Tutorial/Merging Tickets>
-=head2 Merge Blocks, Split Investigation, Split Incident
+=head2 Merge Countermeasures, Split Investigation, Split Incident
L<Tutorial/Merging Tickets>
@@ -137,9 +137,9 @@ L<Tutorial/Merging Tickets>
=item Reopen Incident
-=item Comment Blocks via web-interface
+=item Comment Countermeasures via web-interface
-=item Steal Blocks
+=item Steal Countermeasures
=item Reply IR via web-interface
@@ -147,7 +147,7 @@ L<Tutorial/Merging Tickets>
=item Reply from correspondent on Investigation via e-mail
-=item Reply from correspondent on Blocks via e-mail
+=item Reply from correspondent on Countermeasures via e-mail
=item Comment on Investigation via web-interface
diff --git a/docs/Tutorial.pod b/docs/Tutorial.pod
index 1eddadd..1d50084 100644
--- a/docs/Tutorial.pod
+++ b/docs/Tutorial.pod
@@ -3,7 +3,7 @@
=head2 Incident Response Workflow
RTIR automatically creates four RT queues for tracking incidents: Incident
-Reports, Incidents, Investigations and Blocks.
+Reports, Incidents, Investigations and Countermeasures.
=head3 Incident Reports
@@ -27,13 +27,14 @@ asking them to look into and/or fix a problem. Once again, relevant
information from the Incident is filled in when you create the new
Investigation, so there's no need to cut-and-paste.
-=head3 Blocks
+=head3 Countermeasures
-Blocks are used to track any blocks placed on the borders of the network. You
-can create them from an existing Incident. Some sites don't require blocks, so
-they may be disabled by your Administrator. Blocks have several states: pending
-activation, active, pending removal, removed. These states can be set from
-sub-menu items on ticket display pages.
+Countermeasures are used to track any blocks placed on the borders of the
+network. You can create them from an existing Incident. Some sites don't
+require countermeasures, so they may be disabled by your Administrator.
+Countermeasures have several states: pending activation, active, pending
+removal, removed. These states can be set from sub-menu items on ticket display
+pages.
=head2 Operations with Tickets
@@ -187,7 +188,7 @@ IRs owned by others will be skipped with a warning even if you selected them.
This operation is quite similar to rejecting an IR, but when you're
abandoning an Incident you also reject IRs, resolve Investigations and
-remove Blocks linked to it.
+remove Countermeasures linked to it.
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 and only
@@ -262,10 +263,9 @@ their name.
=head4 Reply to All
-This operation lets you send a message to all of the parties who created
-IRs, those involved in the Investigation, and those involved in the
-Blocks. You may exclude individual recipients by removing the check next
-to their name.
+This operation lets you send a message to all of the parties who created IRs,
+those involved in the Investigation, and those involved in the Countermeasures.
+You may exclude individual recipients by removing the check next to their name.
=head4 Correspond with Correspondent
@@ -287,8 +287,8 @@ and link them to the IR by clicking the "[New]" button next to the
=head4 Linking Incidents to IRs, Investigations, etc.
You may link Incidents with existing Incident Reports, Investigations,
-Blocks, and 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
+Countermeasures, and 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
tickets. Clicking on C<Link> lets you link one or more tickets of that type to
the Incident.
@@ -327,12 +327,12 @@ attach files, etc.
To launch a new Investigation, create a new ticket in the Investigations queue.
You will be required to provide one or more correspondents.
-=head3 Blocks
+=head3 Countermeasures
-=head4 Creating a Block
+=head4 Creating a Countermeasure
-To create a new Block, create a new ticket in the Blocks queue. You will be
-required to link the Block to an Incident.
+To create a new Countermeasure, create a new ticket in the Countermeasures
+queue. You will be required to link the Countermeasure to an Incident.
=head2 Managing 'RT at glance' and 'RTIR at a glance' Pages
@@ -402,12 +402,12 @@ An active ticket in RTIR is a ticket with a status that indicates work will
still be done on it. RTIR uses this to determine what tickets should be shown
by default in various searches and pages in the user interface.
-The available active statuses are defined as part of the
-RTIR configuration and differ for each queue (see C<%Lifecycles> in
-F<RTIR_Config.pm> and F<RT_Config.pm> for more information). Active tickets
-in the incidents queue, for example, are those with a status of C<open>. In
-the blocks queue, tickets can be C<active> or C<pending removal>. These values
-are configurable and may be different on your system.
+The available active statuses are defined as part of the RTIR configuration and
+differ for each queue (see C<%Lifecycles> in F<RTIR_Config.pm> and
+F<RT_Config.pm> for more information). Active tickets in the incidents queue,
+for example, are those with a status of C<open>. In the Countermeasures queue,
+tickets can be C<active> or C<pending removal>. These values are configurable
+and may be different on your system.
=item inactive ticket
@@ -415,12 +415,12 @@ An inactive ticket in RTIR is a ticket with a status that indicates work on it
is complete. RTIR uses this to filter tickets out of various searches and pages
in the user interface, although the tickets can still be found with searches.
-Inactive statuses are defined as part of the
-RTIR configuration and differ for each queue (see C<%Lifecycles> in
-F<RTIR_Config.pm> and F<RT_Config.pm> for more information). Inactive tickets
-in the incidents queue, for example, can be C<resolved> or C<abandoned>. In
-the blocks queue, tickets can have a status of C<removed>. These values
-are configurable and may be different on your system.
+Inactive statuses are defined as part of the RTIR configuration and differ for
+each queue (see C<%Lifecycles> in F<RTIR_Config.pm> and F<RT_Config.pm> for
+more information). Inactive tickets in the incidents queue, for example, can be
+C<resolved> or C<abandoned>. In the Countermeasures queue, tickets can have a
+status of C<removed>. These values are configurable and may be different on
+your system.
=back
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the rt-commit
mailing list