Re: [RFR] Description and templates for package dotLRN
Hector Romojaro wrote:
> As suggested by Christian Perrier (#562936 [0]), I kindly ask for review
> of templates and control files from dotLRN package (attached) before
> uploading a new version.
Sure! I don't know how many reviewers we've got at this time of
year, but here's my input.
> Homepage: http://www.dotlrn.org/
>
> Package: dotlrn
> Architecture: all
> Depends: ${misc:Depends}, aolserver4-daemon (>= 4.5.1-11), aolserver4-nspostgres, aolserver4-nssha1, postgresql-client,
> adduser, tclthread (>= 1:2.6.5-3), tcllib, tcl (>= 8.4), wwwconfig-common, debconf, xotcl,
> aolserver4-xotcl, imagemagick, zip, unzip, tdom (>= 0.8.3~20080525)
Oof, this looks like a tricky one.
> Description: E-learning and digital communities software based on OpenACS
The normal non-sentence-initial spelling seems to be "e-learning",
and package descriptions aren't sentences.
"Digital communities" is a bit more buzzwordy than it is informative
(and "communities" is still there buried in the name OpenACS), and
"software" is almost always too vague for a package synopsis;
instead I'd suggest hinting that this is a web portal system.
Description: e-learning portal system based on OpenACS
> dotLRN is a complete open source LMS with a sophisticated portal,
> system that integrates tools for course and content administration and
> collaborative tools.
I could argue that it's either "dotlrn" (the sanitised packagename)
or ".LRN" (the real upstream brandname), but the hybrid version
seems to be standard in this packaging, so I won't fight it.
I'd recommend expanding "LMS" - even if everybody likely to want
this package will recognise the abbreviation, expanding it makes it
easy for everyone else to see they shouldn't bother reading on.
No need to mention "open source" (that's the default for Debian
package descriptions), and drop that comma after "portal". Also,
when you say it "integrates tools" I expect to hear what it
integrates them into. Maybe reshuffle it into:
dotLRN is a complete Learning Management System that integrates course
and content administration tools and collaborative tools into a
sophisticated portal system.
Next the templates (ignoring ones where I've got nothing to say):
> Template: dotlrn/dba_name
[...]
> Please enter the PostgreSQL administrator username, needed for
> the database creation.
> Template: dotlrn/dba_password
[...]
> Please enter the PostgreSQL administrator password, needed for
> the database creation.
For both of these I'm not 100% sure about the phrasing, but it's
clear enough.
> Template: dotlrn/dba_confirm
> Type: password
> _Description: DBA password confirmation:
> Please confirm the password in order to continue the process.
This sounds almost as if I should be typing in "yes". I'd suggest
s/Please confirm/Please repeat/.
> Template: dotlrn/create_tables
> Type: note
> _Description: Warning - dotLRN database tables not created
> The dotLRN install script will create the database, but
> the tables are to be created with a script. Please
> launch it right after the install:
> .
> http://localhost:8000/
> .
> After configure, you can change IP and port to listen on
> /etc/aolserver4/conf.d/dotlrn.sh.
If I'm following this I'd suggest rephrasing it as:
The dotLRN install process will create the database, but will not
populate it with tables. Point a browser at:
.
http://localhost:8000/
.
The address and port that dotLRN will listen on can be configured
in /etc/aolserver4/conf.d/dotlrn.sh.
> Template: dotlrn/pg_grant_access
> Type: boolean
> _Description: Do you want debconf to grant dotLRN user access on PostgreSQL?
Problems:
* What I want isn't the issue. I might be reluctantly implementing
my idiot boss's official policy...
* Keep debconf's name out of it - its operations should always be
transparent.
* Does "access on PostgreSQL" mean "access to PostgreSQL"?
I'd suggest:
_Description: Grant PostgreSQL access to the dotLRN user?
> Debconf can modify the PostgreSQL configuration to allow access
> to the dotLRN user by modifying the pg_hba.conf file.
Should the PostgreSQL configuration in pg_hba.conf allow the
dotLRN user access?
(Or is it "administrative access"?)
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru old/control new/control
--- old/control 2009-12-29 19:32:13.000000000 +0000
+++ new/control 2009-12-29 21:24:08.000000000 +0000
@@ -16,7 +16,7 @@
adduser, tclthread (>= 1:2.6.5-3), tcllib, tcl (>= 8.4), wwwconfig-common, debconf, xotcl,
aolserver4-xotcl, imagemagick, zip, unzip, tdom (>= 0.8.3~20080525)
Suggests: postgresql, daemontools, daemontools-run
-Description: E-learning and digital communities software based on OpenACS
- dotLRN is a complete open source LMS with a sophisticated portal,
- system that integrates tools for course and content administration and
- collaborative tools.
+Description: e-learning portal system based on OpenACS
+ dotLRN is a complete Learning Management System that integrates course
+ and content administration tools and collaborative tools into a
+ sophisticated portal system.
diff -ru old/templates new/templates
--- old/templates 2009-12-29 19:32:14.000000000 +0000
+++ new/templates 2009-12-29 21:20:58.000000000 +0000
@@ -20,7 +20,7 @@
Template: dotlrn/dba_confirm
Type: password
_Description: DBA password confirmation:
- Please confirm the password in order to continue the process.
+ Please repeat the password in order to continue the process.
Template: dotlrn/mismatch
Type: note
@@ -47,17 +47,16 @@
Template: dotlrn/create_tables
Type: note
_Description: Warning - dotLRN database tables not created
- The dotLRN install script will create the database, but
- the tables are to be created with a script. Please
- launch it right after the install:
+ The dotLRN install process will create the database, but will not
+ populate it with tables. Point a browser at:
.
http://localhost:8000/
.
- After configure, you can change IP and port to listen on
- /etc/aolserver4/conf.d/dotlrn.sh.
+ The address and port that dotLRN will listen on can be configured
+ in /etc/aolserver4/conf.d/dotlrn.sh.
Template: dotlrn/pg_grant_access
Type: boolean
-_Description: Do you want debconf to grant dotLRN user access on PostgreSQL?
- Debconf can modify the PostgreSQL configuration to allow access
- to the dotLRN user by modifying the pg_hba.conf file.
+_Description: Grant PostgreSQL access to the dotLRN user?
+ Should the PostgreSQL configuration in pg_hba.conf allow the
+ dotLRN user access?
Source: dotlrn
Section: web
Priority: optional
Maintainer: Hector Romojaro <hromojaro@dia.uned.es>
Uploaders: Francesco Paolo Lovergine <frankie@debian.org>
Build-Depends-Indep: po-debconf
Build-Depends: debhelper (>= 7), dpatch
Standards-Version: 3.8.3
Vcs-Browser: http://svn.debian.org/viewsvn/pkg-tcltk/dotlrn/trunk
Vcs-Svn: svn://svn.debian.org/svn/pkg-tcltk/dotlrn/trunk
Homepage: http://www.dotlrn.org/
Package: dotlrn
Architecture: all
Depends: ${misc:Depends}, aolserver4-daemon (>= 4.5.1-11), aolserver4-nspostgres, aolserver4-nssha1, postgresql-client,
adduser, tclthread (>= 1:2.6.5-3), tcllib, tcl (>= 8.4), wwwconfig-common, debconf, xotcl,
aolserver4-xotcl, imagemagick, zip, unzip, tdom (>= 0.8.3~20080525)
Suggests: postgresql, daemontools, daemontools-run
Description: e-learning portal system based on OpenACS
dotLRN is a complete Learning Management System that integrates course
and content administration tools and collaborative tools into a
sophisticated portal system.
Template: dotlrn/db_host
Type: string
Default: localhost
_Description: Database server hostname:
Please enter the hostname of the database server host.
Template: dotlrn/dba_name
Type: string
Default: postgres
_Description: Database administrator username:
Please enter the PostgreSQL administrator username, needed for
the database creation.
Template: dotlrn/dba_password
Type: password
_Description: Database administrator password:
Please enter the PostgreSQL administrator password, needed for
the database creation.
Template: dotlrn/dba_confirm
Type: password
_Description: DBA password confirmation:
Please repeat the password in order to continue the process.
Template: dotlrn/mismatch
Type: note
_Description: Password mismatch
The password and its confirmation do not match. Please
reenter the passwords.
Template: dotlrn/dbu_name
Type: string
Default: www-data
_Description: Database owner username:
Please enter the username of the dotLRN database owner.
Template: dotlrn/dbu_password
Type: password
_Description: Database owner password:
Please enter the password of the dotLRN database owner.
Template: dotlrn/dbu_confirm
Type: password
_Description: Database owner password confirmation:
Please confirm the password of the dotLRN database owner.
Template: dotlrn/create_tables
Type: note
_Description: Warning - dotLRN database tables not created
The dotLRN install process will create the database, but will not
populate it with tables. Point a browser at:
.
http://localhost:8000/
.
The address and port that dotLRN will listen on can be configured
in /etc/aolserver4/conf.d/dotlrn.sh.
Template: dotlrn/pg_grant_access
Type: boolean
_Description: Grant PostgreSQL access to the dotLRN user?
Should the PostgreSQL configuration in pg_hba.conf allow the
dotLRN user access?
Reply to: