[Rt-commit] r8917 - in rtir/branches/2.3-EXPERIMENTAL: docs

[sartak at bestpractical.com]

Author: sartak
Date: Tue Sep  4 17:11:37 2007
New Revision: 8917

Modified:
   rtir/branches/2.3-EXPERIMENTAL/   (props changed)
   rtir/branches/2.3-EXPERIMENTAL/docs/README.DOCUMENTATION
   rtir/branches/2.3-EXPERIMENTAL/docs/Tutorial.pod

Log:
 r40564 at onn:  sartak | 2007-09-04 17:11:30 -0400
 Add some linking docs, minor IP docfixes


Modified: rtir/branches/2.3-EXPERIMENTAL/docs/README.DOCUMENTATION
==============================================================================
--- rtir/branches/2.3-EXPERIMENTAL/docs/README.DOCUMENTATION	(original)
+++ rtir/branches/2.3-EXPERIMENTAL/docs/README.DOCUMENTATION	Tue Sep  4 17:11:37 2007
@@ -59,12 +59,20 @@
 
 =head2 Link Incident with new IR
 
+=item * RTIR/docs/Tutorial.pod (Section 'Linking')
+
 =head2 Link Incident with existing IR
 
+=item * RTIR/docs/Tutorial.pod (Section 'Linking')
+
 =head2 Link Incident with new Block
 
+=item * RTIR/docs/Tutorial.pod (Section 'Linking')
+
 =head2 Link Incident with existing Block
 
+=item * RTIR/docs/Tutorial.pod (Section 'Linking')
+
 =head2 Resolve Incident
 
 =head2 Resolve Incident & linked IR's and Investigations

Modified: rtir/branches/2.3-EXPERIMENTAL/docs/Tutorial.pod
==============================================================================
--- rtir/branches/2.3-EXPERIMENTAL/docs/Tutorial.pod	(original)
+++ rtir/branches/2.3-EXPERIMENTAL/docs/Tutorial.pod	Tue Sep  4 17:11:37 2007
@@ -215,6 +215,17 @@
 blocking. You may exclude individual recipients by removing the check next
 to their name.
 
+=head3 Linking
+
+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.
+
+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.
+
 =head2 Custom fields
 
 =head3 IP
@@ -227,16 +238,16 @@
 * IP range - interval separated with C<->, for example C<192.168.20.0-192.168.20.255>,
 both ends of the interval are included range;
 
-* CIDR block - IP range in the CIDR format, for example 172.16/24, as you
+* CIDR block - IP range in the CIDR format, for example C<172.16/24>, as you
 can see short form is also supported, RTIR converts ranges in this format
 to IP-IP form.
 
-You can set value of the custom field on create or later through edit page
-of a ticket. You can enter several values at once, one per line, as well
-you could mix different formats. Create or update action fail if you enter
-incorrect values with an error message, you should fix the problem and resubmit
-the form. On creation, IPs and CIDR blocks are also parsed from the body of the
-message and added to the ticket.
+You can set value of the custom field on create or later through edit page of a
+ticket. You can enter several values at once, one per line or comma-separated,
+as well you could mix different formats. Create or update action fail if you
+enter incorrect values with an error message, you should fix the problem and
+resubmit the form. On creation, IPs and CIDR blocks are also parsed from the
+body of the message and added to the ticket.
 
 =head4 Searching by IP