[Rt-commit] r11207 - rtfm/branches/2.3-EXPERIMENTAL

falcone at bestpractical.com falcone at bestpractical.com
Wed Mar 26 13:28:01 EDT 2008


Author: falcone
Date: Wed Mar 26 13:28:00 2008
New Revision: 11207

Added:
   rtfm/branches/2.3-EXPERIMENTAL/UPGRADING
Modified:
   rtfm/branches/2.3-EXPERIMENTAL/   (props changed)
   rtfm/branches/2.3-EXPERIMENTAL/README

Log:
 r30551 at ketch:  falcone | 2008-03-26 13:25:53 -0400
 * break out upgrade directions into UPGRADING
 * update documentation of Topics and Classes


Modified: rtfm/branches/2.3-EXPERIMENTAL/README
==============================================================================
--- rtfm/branches/2.3-EXPERIMENTAL/README	(original)
+++ rtfm/branches/2.3-EXPERIMENTAL/README	Wed Mar 26 13:28:00 2008
@@ -29,49 +29,43 @@
 
 6) stop and start your web server
 
+----------------------------------------------
 
-Upgrade instructions (From any  2.0.x release):
------------------------------------------------------
-
-1) perl Makefile.PL
-
-2) perl -I/path/to/your/rt/lib sbin/migrate-2.0-to-2.1
-
-3) Type "make install"
-
-4) Type "ls etc/upgrade"; For each item in that directory whose name
-   is greater than your previously installed RTFM version, run:
-
-            /opt/rt3/sbin/rt-setup-database --action schema \
-                --datadir etc/upgrade/<version>
-            /opt/rt3/sbin/rt-setup-database --action acl \
-                --datadir etc/upgrade/<version>
-            /opt/rt3/sbin/rt-setup-database --action insert \
-                 --datadir etc/upgrade/<version>
-
-5) stop and start your web server
+Upgrade instructions can be found in UPGRADING
 
+----------------------------------------------
 
+After Installation:
+-------------------
 
 Staff users should be now have a new "RTFM" menu item RT's top level menu.
 As an administrator, you should go create some "Classes" of articles in RTFM.
-Classes are equivalent to RT's queues. Unlike RTFM 1.0, RTFM 2.0 doesn't have a
-single "body" section for each article. Everything is a custom field (except
-for name, summary and some other basic metadata). So, you need to go create
-some custom fields.
+Classes are equivalent to RT's queues. 
+
+Unlike RTFM 1.0, RTFM 2 doesn't have a single "body" section for each
+article. Everything is a custom field (except for name, summary and some
+other basic metadata). So, you need to go create some custom fields.
 
 Once you've created your custom fields, go into your classes and click
 on "Custom Fields" and add the Custom Fields you want to each class.
 
 Grant some ACLs to your users and start creating articles.
 
-You can also bind articles to topics. Topics are created by administrators
-on classes using the 'Topics' submenu of the RTFM class configuration.
-The configuration screen for the class has a tab for 'topics'. Typing the
-name (and optionally description) of the topic, and then clicking the button
-at the appropriate location. This should allow you to build a tree of topics.
-This tree of topics should show up when creating or modifying articles
-in the class. These can be arbitrarily nested categories.
+Each Article will belong to a particular Class, but Articles can also be
+grouped using Topics.  Topics are created by administrators on Classes
+using the 'Topics' submenu of the RTFM Class configuration.  The
+configuration screen for the Class has a tab for 'Topics'. Type the name
+(and optionally description) of the Topic, and then click the button at
+the appropriate location in the Topic hierarchy. This should allow you
+to build a tree of Topics. This tree of Topics should show up when
+creating or modifying articles in the class. These can be arbitrarily
+nested.
+
+Topics can also be created globally.  These are managed from 
+RTFM's Configuration tab, under the Global heading along with
+global User and Group rights.  These Global Topics will be available
+for all Articles, regardless of their Class.  Articles can belong to
+both global and class-specific Topics.
 
 Articles topics can be set from the 'Modify' screen for the article --
 simply select as many topics as you desire from the list at the bottom
@@ -80,15 +74,33 @@
 Of course, RTFM integrates with RT.  You can extract the body of a
 ticket into an article. Within RT, you should now see an "Extract to
 article" button in the upper right hand corner of RT's UI when working
-with tickets. When you click that button, RTFM will ask you which
-Class to create your new article in.  Once you click on a class name,
-the Ticket's transactions will be displayed, along with a set of
-select boxes. For each transaction, you can pick which Freeform, Text,
-or WikiText field that transaction should be extracted to. From there
-on in, it's just regular article creation.  And the integration
-doesn't stop there! When replying to or commenting on tickets, there's
-a new UI widget that lets you search for and include RTFM articles in
-your reply. (They're editable, of course).
+with tickets. When you click that button, RTFM will ask you which Class
+to create your new article in.  Once you click on a class name, the
+Ticket's transactions will be displayed, along with a set of select
+boxes. For each transaction, you can pick which Freeform, Text, or
+WikiText field that transaction should be extracted to. From there on
+in, it's just regular article creation.  And the integration doesn't
+stop there!  When replying to or commenting on tickets, there is a UI
+widget that lets you search for and include RTFM articles in your reply.
+(They're editable, of course).  
+
+New in 2.4, you can use Topics to organize a set of Queue specific
+Articles.  Simply create a global Topic called 'Queues' and then create
+Topics under Queues named after each of your Queues.  Within each Queue
+named Topic, create some Topics and then assign Articles to those
+sub-topics.  This creates a hierarchy like this:
+
+Queues
+\-> General
+    \-> Topic 1
+    \-> Topic 2
+
+If you are replying to a Ticket in the General Queue you will be 
+offered a choice of Topic 1 and Topic 2 along with the searching.
+After choosing Topic 1 or Topic 2, you will be given a list
+of relevant articles to choose.
+
+
 
 You probably want to discuss RTFM on rt-users at lists.bestpractical.com.
 (Send mail to rt-users-request at lists.fsck.com to subscribe)

Added: rtfm/branches/2.3-EXPERIMENTAL/UPGRADING
==============================================================================
--- (empty file)
+++ rtfm/branches/2.3-EXPERIMENTAL/UPGRADING	Wed Mar 26 13:28:00 2008
@@ -0,0 +1,34 @@
+Upgrade instructions (From any 2.2.x release)
+-----------------------------------------------------
+
+There were no database changes from 2.2 to 2.4
+you should be able to follow the normal
+installation instructions which will overwrite
+existing RTFM code with the 2.4 version.
+
+It is recommended that you make a backup of your
+/opt/rt3 directory in case there are problems
+
+After installing 2.4, stop and start your web
+server, clearing your mason cache if necesary.
+
+Upgrade instructions (From any  2.0.x release):
+-----------------------------------------------------
+
+1) perl Makefile.PL
+
+2) perl -I/path/to/your/rt/lib sbin/migrate-2.0-to-2.1
+
+3) Type "make install"
+
+4) Type "ls etc/upgrade"; For each item in that directory whose name
+   is greater than your previously installed RTFM version, run:
+
+            /opt/rt3/sbin/rt-setup-database --action schema \
+                --datadir etc/upgrade/<version>
+            /opt/rt3/sbin/rt-setup-database --action acl \
+                --datadir etc/upgrade/<version>
+            /opt/rt3/sbin/rt-setup-database --action insert \
+                 --datadir etc/upgrade/<version>
+
+5) stop and start your web server


More information about the Rt-commit mailing list