[request-tracker-maintainers] [RFR2] templates://rtfm/{templates}

Christian Perrier bubulle at debian.org
Fri Oct 26 04:57:17 UTC 2007


Quoting Niko Tyni (ntyni at iki.fi):

> here's the change I just committed to split the database modifying
> template into two separate ones. There's also a minor change to the
> short description, included for the sake of completeness. The patch is
> against the current unstable version (2.2.1-1), hope that's OK.


OK, that deserves another review, then.

As you may see, the attached patch combines my early review, includes
comments...and takes care of the new/modified two templates and the
modification in the control file.

Rationale for these new changes:

--- rtfm.old/debian/templates	2007-10-26 06:44:55.775875248 +0200
+++ rtfm/debian/templates	2007-10-26 06:54:35.756505890 +0200
@@ -1,41 +1,44 @@
 Template: rt3.6-rtfm/modify-database-permission
 Type: select
-_Choices: allow, prompt, deny
+__Choices: allow, prompt, deny
 Default: allow
-_Description: Permission to modify the database:
- RTFM needs some database modifications to be functional.  If you want, the
- installation procedure can make these modifications automatically or
- prompt you when they are needed. Alternatively, you can run the necessary
- commands manually. See README.Debian.
+_Description: Permission to modify the Request Tracker database:
+ RTFM needs some modifications in the Request Tracker to be functional. These
+ modifications can be made automatically or
+ you may be prompted when they are needed. Alternatively, you can run the necessary
+ commands manually.
+ .
+ Please check the README.Debian file for more details.
 
A new change I propose: explicitely mention that what will be changed
is the *Request Tracker* database.


 Template: rt3.6-rtfm/setup-database-prompt
 Type: boolean
 Default: true
-_Description: Set up the database for RTFM?
- New tables must be created in the RT database for RTFM to be functional.
+_Description: Set up the Request Tracker database?
+ New tables must be created in the Request Tracker database for RTFM
+ to be functional.

Here also, in these new templates, re-mention that "the database" is
the RT one and, as we have room for it, avoid the "RT" acronym, just
in case.
 
-Template: rt3.6-rtfm/upgrade-database-prompt
+Template: rt3.6-rtfm/modify-database-prompt
 Type: boolean
 Default: true
-_Description: Upgrade the database?
- The RT database schema and contents must be upgraded for this version
- of RTFM.
+#flag:translate!:3
+_Description: Upgrade the Request Tracker database?
+ The Request Tracker database schema and contents must be upgraded for
+ this version of RTFM.

Ditto.
 
--- rtfm.old/debian/control	2007-10-26 06:44:55.775875248 +0200
+++ rtfm/debian/control	2007-10-26 06:45:45.273423117 +0200
@@ -12,16 +12,16 @@
 Depends: request-tracker3.6, libhtml-tree-perl, libtime-modules-perl, 
  libyaml-perl, libtree-simple-perl, ${misc:Depends}, ${perl:Depends}, 
  debconf | debconf-2.0, ucf (>= 0.28)
-Description: RT FAQ Manager for Request Tracker 3.6
- RTFM is an enterprise-grade knowledge management tool that enables an
- organization to easily capture and share its employees' knowledge and wisdom.
+Description: FAQ Manager for Request Tracker 3.6

Avoid the repetition of "RT"

-------------- next part --------------
--- rtfm.old/debian/templates	2007-10-26 06:44:55.775875248 +0200
+++ rtfm/debian/templates	2007-10-26 06:55:44.253112537 +0200
@@ -1,41 +1,44 @@
 Template: rt3.6-rtfm/modify-database-permission
 Type: select
-_Choices: allow, prompt, deny
+__Choices: allow, prompt, deny
 Default: allow
-_Description: Permission to modify the database:
- RTFM needs some database modifications to be functional.  If you want, the
- installation procedure can make these modifications automatically or
- prompt you when they are needed. Alternatively, you can run the necessary
- commands manually. See README.Debian.
+_Description: Permission to modify the Request Tracker database:
+ RTFM needs some modifications in the Request Tracker to be functional. These
+ modifications can be made automatically or
+ you may be prompted when they are needed. Alternatively, you can run the necessary
+ commands manually.
+ .
+ Please check the README.Debian file for more details.
 
 Template: rt3.6-rtfm/setup-database-prompt
 Type: boolean
 Default: true
-_Description: Set up the database for RTFM?
- New tables must be created in the RT database for RTFM to be functional.
+_Description: Set up the Request Tracker database?
+ New tables must be created in the Request Tracker database for RTFM
+ to be functional.
 
-Template: rt3.6-rtfm/upgrade-database-prompt
+Template: rt3.6-rtfm/modify-database-prompt
 Type: boolean
 Default: true
-_Description: Upgrade the database?
- The RT database schema and contents must be upgraded for this version
- of RTFM.
+#flag:translate!:3
+_Description: Upgrade the Request Tracker database?
+ The Request Tracker database schema and contents must be upgraded for
+ this version of RTFM.
 
 Template: rt3.6-rtfm/modify-database-error
 Type: select
-_Choices: abort, retry, ignore
+__Choices: abort, retry, ignore
 Default: abort
-_Description: Error modifying the database. Solution:
- An error seems to have occurred while modifying the database. If it's of
- any help, this was the error encountered:
+#flag:translate!:3
+_Description: Action after database modification error:
+ An error occurred while modifying the database:
  .
  ${error}
  .
  The full output should be available in the RT log, most probably syslog.
  .
- You can either retry, abort the installation or ignore the error. If you
- want to retry, another attempt will be made at performing the operation.
- If you abort, the operation will fail and you will need to downgrade,
- reinstall, reconfigure the package, or otherwise manually intervene to
- continue using it.  If you choose to ignore the error, the operation will
- continue.
+ You can retry the modification, abort the installation or ignore the
+ error. If you abort the installation, the operation will fail and
+ you will need to manually intervene (for instance by purging and
+ reinstalling). If you choose to ignore the error, the upgrade process
+ will continue.
--- rtfm.old/debian/control	2007-10-26 06:44:55.775875248 +0200
+++ rtfm/debian/control	2007-10-26 06:45:45.273423117 +0200
@@ -12,16 +12,16 @@
 Depends: request-tracker3.6, libhtml-tree-perl, libtime-modules-perl, 
  libyaml-perl, libtree-simple-perl, ${misc:Depends}, ${perl:Depends}, 
  debconf | debconf-2.0, ucf (>= 0.28)
-Description: RT FAQ Manager for Request Tracker 3.6
- RTFM is an enterprise-grade knowledge management tool that enables an
- organization to easily capture and share its employees' knowledge and wisdom.
+Description: FAQ Manager for Request Tracker 3.6
+ RTFM is an add-on to Request Tracker (RT), the extensible ticketing
+ system. It provides a knowledge management tool to help an
+ organization collect and share the knowledge and wisdom of its
+ members.
  .
- Just as you use RT (Request Tracker, the open-source ticketing system) to log
- tickets and resolve issues, RTFM lets you open, categorize and search for
- "articles." Like RT, RTFM lets your users contribute additional information
- to existing articles and makes sure that each article's full history is
- preserved for future inspection. RTFM makes it easy to quickly search the
- knowledge base and find critical information.
- .
- RTFM is implemented as an add-on to RT. This package integrates with
- RT 3.6, available in the request-tracker3.6 package.
+ Just as you use RT to log tickets and resolve issues, RTFM lets you
+ create, categorize and search for 'articles'. Like RT, RTFM lets
+ users contribute additional information to existing articles, but
+ guarantees that each article's full history is preserved for future
+ inspection. RTFM simplifies browsing in the knowledge base and
+ finding critical information.
+
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : http://lists.alioth.debian.org/pipermail/pkg-request-tracker-maintainers/attachments/20071026/d2d5c392/attachment-0002.pgp 


More information about the pkg-request-tracker-maintainers mailing list