Re: [RFR] templates://jffnms/{templates,control}
David Prévot wrote:
>> Template: jffnms/install-error
>> Type: select
>> -Choices: abort, retry, retry (skip questions)
>> +__Choices: abort, retry, retry (skip questions)
>
> Make the choices translatable, separately.
>
>> Default: abort
>> -Description: Error installing database for jffnms:
>> +#flag:translate!:3
>
> No need to translate the “${error}”.
>
>> +_Description: Error installing database for jffnms:
>
> Make this screen translatable.
>
>> An error seems to have occurred while installing the database.
>> If it's of any help, this was the error encountered:
>
>
> Other members of the list may have other remarks and improvements to
> propose, thus this formal call for review.
Yes, unsurprisingly I can see lots of fairly trivial things that could
be fixed in this template:
> Template: jffnms/erroruid
> Type: error
> _Description: jffnms user already exists
> The preinstall script for JFFNMS tried to create a JFFNMS user but there
> was already a user of that name so it has aborted installation. Please
> read /usr/share/doc/jffnms/README.Debian for more information.
>
> Template: jffnms/errorgid
> Type: error
> _Description: jffnms group already exists
> The preinstall script for JFFNMS tried to create a JFFNMS group but there
> was already a group of that name so it has aborted installation. Please
> read /usr/share/doc/jffnms/README.Debian for more information.
Both of these are a bit wordy, and the fact it was a "preinstall
script" is an unimportant implementation detail. Boil it down to:
The installation has been aborted because there is already a user [group]
with the name "jffnms". See /usr/share/doc/jffnms/README.Debian.
(I'm also following d-l-e house style by making sentences consistently
singlespaced.)
> Template: jffnms/compresslogs
> Type: string
> Default: 2
> _Description: Days until log files are compressed:
> Enter how many days do you want to keep of uncompressed JFFNMS log files.
> The recommended and default value is 2 days. Setting this value to lower
> than 2 may cause problems. It also doesn't make sense to make this number
> bigger than the number of days until log files deleted.
>
> Template: jffnms/deletelogs
> Type: string
> Default: 7
> _Description: Days until log files are deleted:
> Enter how many days of log files, compressed or not, do you want to keep.
> The default is 7 days of logs. It doesn't make any sense to set this lower
> than the number of days of uncompressed files, as the cron job will compress
> the files and then delete them in the same run.
Slightly ungrammatical; we also discourage references to the defaults,
since they can be changed by pre-seeding. Use (for the first):
Please choose how many days of uncompressed JFFNMS log files should be kept.
The recommended value is two days. Reducing this value may cause problems,
and it doesn't make sense for it to be higher than the number of days before
log files are deleted.
> Template: jffnms/install-error
> Type: select
> __Choices: abort, retry, retry (skip questions)
> Default: abort
> #flag:translate!:3
> _Description: Error installing database for jffnms:
> An error seems to have occurred while installing the database.
> If it's of any help, this was the error encountered:
> .
> ${error}
> .
> At this point, you have the option to retry or abort the operation.
> If you choose "retry", you will be prompted with all the configuration
> questions once more and another attempt will be made at performing the
> operation. "retry (skip questions)" will immediately attempt the operation
> again, skipping all questions. If you choose "abort", the operation will
> fail and you will need to downgrade, reinstall, reconfigure this package,
> or otherwise manually intervene to continue using it.
Oddly enough the only problems with this one were in the headers,
unless you count the double space after "questions."
In the control file:
> Package: jffnms
[...]
> Description: web-based Network Management System (NMS) for IP networks
Surely the NMS isn't web-based? It's only the control interface
that's web-based. Otherwise it would be an NMS for HTTP networks!
(As it is, the repeated references to "IP networks" seem a bit
pointless - how likely is it that readers are going to expect it to be
an NMS for DECnet networks?)
I would suggest adding one fairly important extra fact (which implies
the "web-based" part):
Description: PHP Network Management System
It would also be possible to give a full expansion of the name (the
Just For Fun Network Management System), but I'll save that for
http://wiki.debian.org/WhyTheName!
> JFFNMS is a Network Management System designed to maintain an IP SNMP, Syslog
> and/or Tacacs+ Network. It can be used to monitor any standards compliant
> SNMP device, Server, TCP port or Custom Poller, also it has some Cisco
> oriented features.
What's an IP SNMP? Oh, it means it can maintain an IP network that
runs SNMP, syslog, and/or TACACS+? That seems a stretch - surely it
just *helps* to maintain them by providing a monitoring system?
Fixing the strangely random spacing and capitalisation:
JFFNMS is a Network Management System designed to help maintain a network
running SNMP, syslog, and/or TACACS+. It can monitor any standards-compliant
SNMP device, server, TCP port, or custom poller, and also has some
Cisco-oriented features.
> .
> Features Summary
> * Written in PHP (works in PHP5)
It had better work in PHP5, given that that's what's in Debian!
> * PHP/cron scripts for polling, analizing and consolidating data
That's "analyzing", I hope.
> * Database Backend MySQL or PostgreSQL
"MySQL or PostgreSQL database back-end".
> * Configurable Event Types and Severity Levels
> * Modular and Extensible
> * Advanced Event Filter
Just needs fixed capitalisation throughout (and if I'm changing every
line I might as well impose d-l-e house style punctuation).
> * Interface & Host/Network Autodiscovery
That's "interface, host, and network autodiscovery".
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru jffnms-0.9.3.pristine/debian/control jffnms-0.9.3/debian/control
--- jffnms-0.9.3.pristine/debian/control 2012-06-11 07:22:09.000000000 +0100
+++ jffnms-0.9.3/debian/control 2012-08-29 20:02:30.576411634 +0100
@@ -16,17 +16,17 @@
Recommends: ntp, nmap, fping
Suggests: tac-plus, snmpd, syslog-ng, tftpd, smsclient
Pre-Depends: debconf | debconf-2.0
-Description: web-based Network Management System (NMS) for IP networks
- JFFNMS is a Network Management System designed to maintain an IP SNMP, Syslog
- and/or Tacacs+ Network. It can be used to monitor any standards compliant
- SNMP device, Server, TCP port or Custom Poller, also it has some Cisco
- oriented features.
+Description: PHP Network Management System
+ JFFNMS is a Network Management System designed to help maintain a network
+ running SNMP, syslog, and/or TACACS+. It can monitor any standards-compliant
+ SNMP device, server, TCP port or custom poller, and also has some
+ Cisco-oriented features.
.
- Features Summary
- * Written in PHP (works in PHP5)
- * PHP/cron scripts for polling, analizing and consolidating data
- * Database Backend MySQL or PostgreSQL
- * Configurable Event Types and Severity Levels
- * Modular and Extensible
- * Advanced Event Filter
- * Interface & Host/Network Autodiscovery
+ Its features include:
+ * written in PHP;
+ * PHP/cron scripts for polling, analyzing, and consolidating data;
+ * MySQL or PostgreSQL database back-end;
+ * configurable event types and severity levels;
+ * modular and extensible;
+ * advanced event filter;
+ * interface, host, and network autodiscovery.
diff -ru jffnms-0.9.3.pristine/debian/templates jffnms-0.9.3/debian/templates
--- jffnms-0.9.3.pristine/debian/templates 2012-03-04 03:31:45.000000000 +0000
+++ jffnms-0.9.3/debian/templates 2012-08-29 19:11:49.988733295 +0100
@@ -1,40 +1,39 @@
Template: jffnms/erroruid
Type: error
_Description: jffnms user already exists
- The preinstall script for JFFNMS tried to create a JFFNMS user but there
- was already a user of that name so it has aborted installation. Please
- read /usr/share/doc/jffnms/README.Debian for more information.
+ The installation has been aborted because there is already a user
+ with the name "jffnms". See /usr/share/doc/jffnms/README.Debian.
Template: jffnms/errorgid
Type: error
_Description: jffnms group already exists
- The preinstall script for JFFNMS tried to create a JFFNMS group but there
- was already a group of that name so it has aborted installation. Please
- read /usr/share/doc/jffnms/README.Debian for more information.
+ The installation has been aborted because there is already a user group
+ with the name "jffnms". See /usr/share/doc/jffnms/README.Debian.
Template: jffnms/compresslogs
Type: string
Default: 2
_Description: Days until log files are compressed:
- Enter how many days do you want to keep of uncompressed JFFNMS log files.
- The recommended and default value is 2 days. Setting this value to lower
- than 2 may cause problems. It also doesn't make sense to make this number
- bigger than the number of days until log files deleted.
+ Please choose how many days of uncompressed JFFNMS log files should be kept.
+ The recommended value is two days. Reducing this value may cause problems,
+ and it doesn't make sense for it to be higher than the number of days before
+ log files are deleted.
Template: jffnms/deletelogs
Type: string
Default: 7
_Description: Days until log files are deleted:
- Enter how many days of log files, compressed or not, do you want to keep.
- The default is 7 days of logs. It doesn't make any sense to set this lower
+ Please choose how many days of log files (compressed or not) should be kept.
+ The recommended value is seven days. It doesn't make sense to set this lower
than the number of days of uncompressed files, as the cron job will compress
the files and then delete them in the same run.
Template: jffnms/install-error
Type: select
-Choices: abort, retry, retry (skip questions)
+__Choices: abort, retry, retry (skip questions)
Default: abort
-Description: Error installing database for jffnms:
+#flag:translate!:3
+_Description: Error installing database for jffnms:
An error seems to have occurred while installing the database.
If it's of any help, this was the error encountered:
.
@@ -44,7 +43,6 @@
If you choose "retry", you will be prompted with all the configuration
questions once more and another attempt will be made at performing the
operation. "retry (skip questions)" will immediately attempt the operation
- again, skipping all questions. If you choose "abort", the operation will
+ again, skipping all questions. If you choose "abort", the operation will
fail and you will need to downgrade, reinstall, reconfigure this package,
or otherwise manually intervene to continue using it.
-
Template: jffnms/erroruid
Type: error
_Description: jffnms user already exists
The installation has been aborted because there is already a user
with the name "jffnms". See /usr/share/doc/jffnms/README.Debian.
Template: jffnms/errorgid
Type: error
_Description: jffnms group already exists
The installation has been aborted because there is already a user group
with the name "jffnms". See /usr/share/doc/jffnms/README.Debian.
Template: jffnms/compresslogs
Type: string
Default: 2
_Description: Days until log files are compressed:
Please choose how many days of uncompressed JFFNMS log files should be kept.
The recommended value is two days. Reducing this value may cause problems,
and it doesn't make sense for it to be higher than the number of days before
log files are deleted.
Template: jffnms/deletelogs
Type: string
Default: 7
_Description: Days until log files are deleted:
Please choose how many days of log files (compressed or not) should be kept.
The recommended value is seven days. It doesn't make sense to set this lower
than the number of days of uncompressed files, as the cron job will compress
the files and then delete them in the same run.
Template: jffnms/install-error
Type: select
__Choices: abort, retry, retry (skip questions)
Default: abort
#flag:translate!:3
_Description: Error installing database for jffnms:
An error seems to have occurred while installing the database.
If it's of any help, this was the error encountered:
.
${error}
.
At this point, you have the option to retry or abort the operation.
If you choose "retry", you will be prompted with all the configuration
questions once more and another attempt will be made at performing the
operation. "retry (skip questions)" will immediately attempt the operation
again, skipping all questions. If you choose "abort", the operation will
fail and you will need to downgrade, reinstall, reconfigure this package,
or otherwise manually intervene to continue using it.
Source: jffnms
Section: web
Priority: optional
Maintainer: Craig Small <csmall@debian.org>
Build-Depends: debhelper (>= 9.0.0), po-debconf
Standards-Version: 3.9.3
Homepage: http://jffnms.sf.net/
Package: jffnms
Architecture: all
Depends: adduser, cron, rrdtool,
apache2 | httpd , dbconfig-common,
libapache2-mod-php5 | php5-cgi | php5-fpm,
php5-cli, php5-mysql | php5-pgsql, php5-snmp, php5-gd,
virtual-mysql-client | mysql-client | postgresql-client, ${misc:Depends}
Recommends: ntp, nmap, fping
Suggests: tac-plus, snmpd, syslog-ng, tftpd, smsclient
Pre-Depends: debconf | debconf-2.0
Description: PHP Network Management System
JFFNMS is a Network Management System designed to help maintain a network
running SNMP, syslog, and/or TACACS+. It can monitor any standards-compliant
SNMP device, server, TCP port or custom poller, and also has some
Cisco-oriented features.
.
Its features include:
* written in PHP;
* PHP/cron scripts for polling, analyzing, and consolidating data;
* MySQL or PostgreSQL database back-end;
* configurable event types and severity levels;
* modular and extensible;
* advanced event filter;
* interface, host, and network autodiscovery.
Reply to: