Please find, for review, the debconf templates and packages descriptions for the syscp source package.
This review will last from Thursday, October 08, 2009 to Sunday, October 18, 2009.
Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.
Your review should be sent as an answer to this mail.
When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.
When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.
Finally, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.
Rationale:
--- syscp.old/debian/templates 2009-10-08 14:56:57.620805428 +0200
+++ syscp/debian/templates 2009-10-08 18:36:01.613441007 +0200
@@ -10,16 +10,15 @@
Default: admin
_Description: Username for the first admin user:
You need to setup an admin user to be able to login to SysCP after
- installation. You may set a user name now.
+ installation.
The last sentence is useless. It is quite obvious that this template
is about setting a user..:)
.
- If you leave this field empty, the default username ('admin') will be used.
+ If you leave this field empty, the default username ("admin") will be used.
Standardize on double quotes (a standard we push on all packages).
Template: syscp/admin-password
Type: password
Default:
_Description: Password for the first admin user:
- To secure your new admin user's login you should now set a password for the
- new user.
+ Please choose a password for the new admin user.
.
If you leave this field empty, the password will be randomly generated.
.
This is not "my" user (the user installing the package is not
necessarily the owner of the service...).
Also, it is quite obvious that passwords are meant to secure
accounts..so let's be simple.
@@ -29,24 +28,27 @@
Type: string
Default: /var/lib/syscp/customers
_Description: Directory for customer data:
- SysCP will be configured to save customer data in one location for your
- convenience. Subdirectories will be created for web services ('webs'), mail
- accounts ('mail'), temporary files ('tmp'), and log files ('log').
- .
- The Debian default for this data is '/var/lib/syscp/customers' and will be
- used if the field is left blank. Upstream, however, usually uses
- '/var/customers'. So, if you already have customer data somewhere, e.g. from a
+ SysCP will be configured to save customer data in one location.
+ Subdirectories will be created for web services ("webs"), mail
+ accounts ("mail"), temporary files ("tmp"), and log files ("log").
"for your ceonvenience" seems pretty useless here.
Standard quotes
+ .
+ If you leave this empty, the default "/var/lib/syscp/customers"
+ directory will be sued. Upstream developers, however, use
+ "/var/customers". So, if you already have customer data somewhere, such
+ as data originating from a
former installation, or if you want an entirely different directory to hold
- your customer's data, please enter it now.
+ the customers' data, you can enter the directory path here.
Avoid "the Debian default" to avoid branding that makes the work of
derived distros harder. Also, the value being the default is quite
obvious as the field is (at least the first time one installs the
package) filled with it.
"Upstream" is a shortcut for "upstream developers" but better use the
complete formula for those who are not aware of our jargon.
Again, avoir personnalization ("you have", "your customers") for a
more neutral sentence.
Template: syscp/no-config
Type: note
_Description: Daemons not configured
Please note that, in order to keep your current installation safe, SysCP did
- not reconfigure your mail or ftp server. You need to configure them to use the
+ not reconfigure the mail or FTP servers. They should be configured
+ to use the
MySQL table provided by SysCP.
.
- SysCP furthermore needs cron jobs to run which are also not installed
- automatically as those would reload your web server unexpectedly.
+ SysCP also needs cron jobs. They are not installed
+ automatically because they restart the web server which you probably want
+ to keep controlled.
.
- Find some example configurations at /usr/share/doc/syscp/examples.
+ Some example configurations may be found in /usr/share/doc/syscp/examples.
Frankly speaking, that note is debconf abuse..:-)
Such information should go in README.Debian and such notes should not
interrupt package installations. See debconf-devel(7) for a full
rationale about why Debconf Notes Are Evil.
--- syscp.old/debian/control 2009-10-08 14:56:57.620805428 +0200
+++ syscp/debian/control 2009-10-08 18:37:47.217441232 +0200
@@ -17,12 +17,12 @@
proftpd-mod-mysql, mysql-client
Suggests: bind9, maildrop, courier-authlib-mysql
Conflicts: syscp (< 1.4.2.1-1)
-Description: System Control Panel for LAMP Servers
+Description: system control panel for LAMP Servers
It is generally recommended to use full lowercase for packages
descriptions.
Here, there could be a small debate as the software name comes from
that "system control panel" description.
SysCP is an easy-to-use system control panel for web and mail servers. It
provides an administration interface to setup customers, assign domains to
them and configure those to have web space and mail accounts under regulation
- of quotas. At the same time customers can login and manage their mail
- accounts, subdomains etc. on their own.
+ of quotas. With SysCP, ISP customers can login and manage their mail
+ accounts, subdomains and other services on their own.
"at the same time of what?"
So, reformulate to something else.
.
- SysCP supports apache2, lighttpd, proftpd, postfix, courier, dovecot, MySQL
- and other common daemons an internet service provider would need.
+ SysCP supports Apache 2, lighttpd, ProFTPd, Postfix, Courier, Dovecot, MySQL
+ and other common daemons an Internet service provider would need.
I'd suggest using the right case use for each software. I changed some
of them, though I am no 100% sure all are the right case.
s/internet/Internet
--
Template: syscp/reconfigure-webserver
Type: multiselect
Choices: apache2, lighttpd
_Description: Web server to reconfigure automatically:
Please choose the web server that should be automatically configured
to run SysCP.
Template: syscp/admin-username
Type: string
Default: admin
_Description: Username for the first admin user:
You need to setup an admin user to be able to login to SysCP after
installation.
.
If you leave this field empty, the default username ("admin") will be used.
Template: syscp/admin-password
Type: password
Default:
_Description: Password for the first admin user:
Please choose a password for the new admin user.
.
If you leave this field empty, the password will be randomly generated.
.
The user name and password will be stored in /etc/syscp/debian.php.
Template: syscp/customer-dir
Type: string
Default: /var/lib/syscp/customers
_Description: Directory for customer data:
SysCP will be configured to save customer data in one location.
Subdirectories will be created for web services ("webs"), mail
accounts ("mail"), temporary files ("tmp"), and log files ("log").
.
If you leave this empty, the default "/var/lib/syscp/customers"
directory will be sued. Upstream developers, however, use
"/var/customers". So, if you already have customer data somewhere, such
as data originating from a
former installation, or if you want an entirely different directory to hold
the customers' data, you can enter the directory path here.
Template: syscp/no-config
Type: note
_Description: Daemons not configured
Please note that, in order to keep your current installation safe, SysCP did
not reconfigure the mail or FTP servers. They should be configured
to use the
MySQL table provided by SysCP.
.
SysCP also needs cron jobs. They are not installed
automatically because they restart the web server which you probably want
to keep controlled.
.
Some example configurations may be found in /usr/share/doc/syscp/examples.
--- syscp.old/debian/templates 2009-10-08 14:56:57.620805428 +0200
+++ syscp/debian/templates 2009-10-08 18:36:01.613441007 +0200
@@ -10,16 +10,15 @@
Default: admin
_Description: Username for the first admin user:
You need to setup an admin user to be able to login to SysCP after
- installation. You may set a user name now.
+ installation.
.
- If you leave this field empty, the default username ('admin') will be used.
+ If you leave this field empty, the default username ("admin") will be used.
Template: syscp/admin-password
Type: password
Default:
_Description: Password for the first admin user:
- To secure your new admin user's login you should now set a password for the
- new user.
+ Please choose a password for the new admin user.
.
If you leave this field empty, the password will be randomly generated.
.
@@ -29,24 +28,27 @@
Type: string
Default: /var/lib/syscp/customers
_Description: Directory for customer data:
- SysCP will be configured to save customer data in one location for your
- convenience. Subdirectories will be created for web services ('webs'), mail
- accounts ('mail'), temporary files ('tmp'), and log files ('log').
- .
- The Debian default for this data is '/var/lib/syscp/customers' and will be
- used if the field is left blank. Upstream, however, usually uses
- '/var/customers'. So, if you already have customer data somewhere, e.g. from a
+ SysCP will be configured to save customer data in one location.
+ Subdirectories will be created for web services ("webs"), mail
+ accounts ("mail"), temporary files ("tmp"), and log files ("log").
+ .
+ If you leave this empty, the default "/var/lib/syscp/customers"
+ directory will be sued. Upstream developers, however, use
+ "/var/customers". So, if you already have customer data somewhere, such
+ as data originating from a
former installation, or if you want an entirely different directory to hold
- your customer's data, please enter it now.
+ the customers' data, you can enter the directory path here.
Template: syscp/no-config
Type: note
_Description: Daemons not configured
Please note that, in order to keep your current installation safe, SysCP did
- not reconfigure your mail or ftp server. You need to configure them to use the
+ not reconfigure the mail or FTP servers. They should be configured
+ to use the
MySQL table provided by SysCP.
.
- SysCP furthermore needs cron jobs to run which are also not installed
- automatically as those would reload your web server unexpectedly.
+ SysCP also needs cron jobs. They are not installed
+ automatically because they restart the web server which you probably want
+ to keep controlled.
.
- Find some example configurations at /usr/share/doc/syscp/examples.
+ Some example configurations may be found in /usr/share/doc/syscp/examples.
--- syscp.old/debian/control 2009-10-08 14:56:57.620805428 +0200
+++ syscp/debian/control 2009-10-08 18:37:47.217441232 +0200
@@ -17,12 +17,12 @@
proftpd-mod-mysql, mysql-client
Suggests: bind9, maildrop, courier-authlib-mysql
Conflicts: syscp (< 1.4.2.1-1)
-Description: System Control Panel for LAMP Servers
+Description: system control panel for LAMP Servers
SysCP is an easy-to-use system control panel for web and mail servers. It
provides an administration interface to setup customers, assign domains to
them and configure those to have web space and mail accounts under regulation
- of quotas. At the same time customers can login and manage their mail
- accounts, subdomains etc. on their own.
+ of quotas. With SysCP, ISP customers can login and manage their mail
+ accounts, subdomains and other services on their own.
.
- SysCP supports apache2, lighttpd, proftpd, postfix, courier, dovecot, MySQL
- and other common daemons an internet service provider would need.
+ SysCP supports Apache 2, lighttpd, ProFTPd, Postfix, Courier, Dovecot, MySQL
+ and other common daemons an Internet service provider would need.
Source: syscp
Section: admin
Priority: extra
Maintainer: Jan Hauke Rahm <jhr@debian.org>
Build-Depends: debhelper (>= 7.0.50), quilt (>= 0.46-7)
Build-Depends-Indep: po-debconf
Standards-Version: 3.8.3
Homepage: http://www.syscp.org
Package: syscp
Architecture: all
Depends: apache2 | lighttpd, php5-cli, php5-mysql, mysql-server, webalizer,
dbconfig-common, libphp-phpmailer, php-fpdf, ${misc:Depends}
Recommends: postfix, postfix-mysql, libsasl2-2, libsasl2-modules,
libsasl2-modules-sql, courier-pop | dovecot-pop3d, courier-imap |
dovecot-imapd, php5-gd, php5-suhosin, php5-imap, proftpd-basic,
proftpd-mod-mysql, mysql-client
Suggests: bind9, maildrop, courier-authlib-mysql
Conflicts: syscp (< 1.4.2.1-1)
Description: system control panel for LAMP Servers
SysCP is an easy-to-use system control panel for web and mail servers. It
provides an administration interface to setup customers, assign domains to
them and configure those to have web space and mail accounts under regulation
of quotas. With SysCP, ISP customers can login and manage their mail
accounts, subdomains and other services on their own.
.
SysCP supports Apache 2, lighttpd, ProFTPd, Postfix, Courier, Dovecot, MySQL
and other common daemons an Internet service provider would need.
Attachment:
signature.asc
Description: Digital signature