Please find, for review, the debconf templates and packages descriptions for the hoteldruid source package.
This review will last from Tuesday, July 31, 2012 to Friday, August 10, 2012.
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, a summary will be sent to the review bug report,
and a mail will be sent to this list with "[BTS]" as a subject tag.
Rationale:
--- hoteldruid.old/debian/templates 2012-07-29 08:12:09.265653313 -0600
+++ hoteldruid/debian/templates 2012-07-31 09:07:54.271664546 -0600
@@ -1,48 +1,45 @@
Template: hoteldruid/configure-apache
Type: boolean
Default: true
-_Description: Configure automatically the Apache web server?
- HotelDruid runs on any web server supporting PHP, but only the
- Apache web server can be configured automatically.
- .
- With automatic configuration you should be able to access
- HotelDruid with any web browser at http://localhost/hoteldruid
- from this computer.
+_Description: Automatically configure the Apache web server for HotelDruid?
It is important that users understand that this will not *entirely*
configure Apache...particularly if the package is installed among many others.
+ HotelDruid runs on any web server supporting PHP, but automatic
+ configuration can only be performed for Apache.
Better English? (Justin, do you confirm? I may very well have turned
it into Frenglish)
.
- Please select if Apache should now be configured automatically
- for HotelDruid.
+ Once configured, HotelDruid can be accessed locally at
+ http://localhost/hoteldruid.
+ .
+ Please choose whether you wish the automatic configuration to be
+ performed now.
The first paragraph above is tricky as, indeed, HD can be access also
at http://<hostname>/hoteldruid if access restriction, which is asked
later on is not enabled.
The last paragraph just confirms users what happens if they answer
positively to the question.
Template: hoteldruid/restrict-localhost
Type: boolean
Default: true
-_Description: Deny access from other computers?
- Apache web server can be configured to allow connections only
- from this computer (localhost).
- .
- This is always a good idea if you are not going to use HotelDruid
- over the network. Otherwise, once HotelDruid is installed, to
- protect your data it is strongly recommended to enable the
- HotelDruid administrator password from the "users management"
- page, this will make a login required.
+_Description: Restrict HotelDruid access to this computer?
Again, this is meant to make sure users understand this is abou
tHotelDruid only.
+ The Apache web server can be configured to allow HotelDruid connections
+ only from this computer (localhost).
I wonder if "localhost" should be kept. That's after all something
that's pointless to users..:-)
Apart from that, adding an article which I think is needed.
+ .
+ It is recommended to activate this setting if HotelDruid is
+ going to be used from this computer.
Drop the "good idea" thing for a more "professional-style" "recommended"...:-)
.
- Please select if access should be restricted only to connections
- originating from this computer.
+ Additionnal access control can be enabled by setting the
+ HotelDruid administrator password from the "users management"
+ page. User logins will then become mandatory.
That last paragraph keeps your mention of extra security brought by
access control, but in another way.
Template: hoteldruid/restart-webserver
Type: boolean
Default: true
-_Description: Should the web server be restarted now?
- In order to activate the new configuration, the reconfigured web
- server has to be restarted.
+_Description: Restart the web server after HotelDruid configuration?
+ In order to activate the new configuration for HotelDruid,
+ the web server has to be restarted.
Once again, make itclear that the restart is needed because of HotelDruid.
Template: hoteldruid/purgedata
Type: boolean
Default: false
-_Description: Purge also application data now?
- By default, HotelDruid stores all its data in some files in
- /var/lib/hoteldruid.
- .
- Accepting this option will remove all this data and leave you with a
- tidier system once the HotelDruid package has been removed, but
- may cause information loss if you have operational data in those
- files.
+_Description: Purge HotelDuid data when purging the package?
+ HotelDruid data are stored in /var/lib/hoteldruid.
+ .
+ If you choose this option, these data files will be removed when
+ the package is purged.
+ .
+ You should deny this option if you have operational information which
+ you wish to keep after HotelDruid is removed.
Some general revamping.
The synopsis uses a sentence style which we used in several other
packages.
And other paragraph also do the same, while still keeping the
recommendation of not purging if users want to keep the data.
--- hoteldruid.old/debian/control 2012-07-29 08:12:09.265653313 -0600
+++ hoteldruid/debian/control 2012-07-31 09:13:04.747521806 -0600
@@ -11,15 +11,20 @@
Depends: ${misc:Depends}, ucf, apache2 | httpd, libapache2-mod-php5 | php5-cgi | php5,
php5-sqlite (>= 5.3.3)
Suggests: iceweasel | www-browser, php5-mysql | php5-pgsql
-Description: Web-based property management system for your hotel or B&B
+Description: web-based property management system for hotels or B&B
Synopsis should never start uppercase.
Unpersonnalize. I may very well install HD to manage someone else's
hotel..:-)
I hesitated about "B&B" but I think it's quite a widely well-known
abbreviation. It will however bring more hassle to
translators..:-). The alternative would be "hosting facility" but, as
we're in the computer world, I'm afraid people would think HD is meant
to manage data centers..:-)
HotelDruid is designed to manage hotel rooms, bed and breakfast apartments
- or any other kind of daily rental, from your browser.
+ or any other kind of daily rental, from a web browser.
Unpersonnalize.
.
- Reservations can be assigned to rooms automatically with user defined
- rules. You can create website pages to display and check availability.
- Includes point of sale and statistics reports. Multi-user with groups and
- privileges system. Supports printing, saving and emailing of documents and
- invoices.
+ Main features:
+ * automatic reservation assignment to rooms with user-defined
+ rules;
+ * web site pages creation and maintenance, including room
+ availability;
+ * point of sale;
+ * statistics reports
+ * multi-user capabilities, including groups and privileges
+ management;
+ * printing, saving and emailing of documents and invoices.
The original paragraph was made of sentences that were not sentences
(no verb). Turning this into an enumeration.
.
- Written in PHP, by default uses SQLite as its database, with possibility
- to migrate to MySQL or PostgreSQL.
+ It uses an SQLite database by default but can be configured for use
+ with MySQL or PostgreSQL.
The Developer's Reference recommends against giving implementation
details in package descriptions. Indeed, who cares that it's written
in PHP, Ruby, shell or whatever? :-)(indeed, PHP-haters will say that
one should care about being written in PHP, but that's another
story..:-))
Anyway, for once, I took a lot of time reviewing this. Probably
because I find it VERY interesting to see that we do not only
provide a gazillionth development language or obscure library....but
something that is really useful to end users..:-)
I nearly regret that I don't run a B&B myself as I would even have
managed it using free software, thanks to you..:-)
I think that I'll post a small note on Planet Debian about this new package.
While at it: is HD internationalized and therefore translatable? If it
is, and particularly if it uses gettext for translation(PO files), I
think that the whole Debian i18n crowd would be delighted to complete
its translation and probably bring more languages into it.
--
Template: hoteldruid/configure-apache Type: boolean Default: true _Description: Automatically configure the Apache web server for HotelDruid? HotelDruid runs on any web server supporting PHP, but automatic configuration can only be performed for Apache. . Once configured, HotelDruid can be accessed locally at http://localhost/hoteldruid. . Please choose whether you wish the automatic configuration to be performed now. Template: hoteldruid/restrict-localhost Type: boolean Default: true _Description: Restrict HotelDruid access to this computer? The Apache web server can be configured to allow HotelDruid connections only from this computer (localhost). . It is recommended to activate this setting if HotelDruid is going to be used from this computer. . Additionnal access control can be enabled by setting the HotelDruid administrator password from the "users management" page. User logins will then become mandatory. Template: hoteldruid/restart-webserver Type: boolean Default: true _Description: Restart the web server after HotelDruid configuration? In order to activate the new configuration for HotelDruid, the web server has to be restarted. Template: hoteldruid/purgedata Type: boolean Default: false _Description: Purge HotelDuid data when purging the package? HotelDruid data are stored in /var/lib/hoteldruid. . If you choose this option, these data files will be removed when the package is purged. . You should deny this option if you have operational information which you wish to keep after HotelDruid is removed.
--- hoteldruid.old/debian/templates 2012-07-29 08:12:09.265653313 -0600
+++ hoteldruid/debian/templates 2012-07-31 09:07:54.271664546 -0600
@@ -1,48 +1,45 @@
Template: hoteldruid/configure-apache
Type: boolean
Default: true
-_Description: Configure automatically the Apache web server?
- HotelDruid runs on any web server supporting PHP, but only the
- Apache web server can be configured automatically.
- .
- With automatic configuration you should be able to access
- HotelDruid with any web browser at http://localhost/hoteldruid
- from this computer.
+_Description: Automatically configure the Apache web server for HotelDruid?
+ HotelDruid runs on any web server supporting PHP, but automatic
+ configuration can only be performed for Apache.
.
- Please select if Apache should now be configured automatically
- for HotelDruid.
+ Once configured, HotelDruid can be accessed locally at
+ http://localhost/hoteldruid.
+ .
+ Please choose whether you wish the automatic configuration to be
+ performed now.
Template: hoteldruid/restrict-localhost
Type: boolean
Default: true
-_Description: Deny access from other computers?
- Apache web server can be configured to allow connections only
- from this computer (localhost).
- .
- This is always a good idea if you are not going to use HotelDruid
- over the network. Otherwise, once HotelDruid is installed, to
- protect your data it is strongly recommended to enable the
- HotelDruid administrator password from the "users management"
- page, this will make a login required.
+_Description: Restrict HotelDruid access to this computer?
+ The Apache web server can be configured to allow HotelDruid connections
+ only from this computer (localhost).
+ .
+ It is recommended to activate this setting if HotelDruid is
+ going to be used from this computer.
.
- Please select if access should be restricted only to connections
- originating from this computer.
+ Additionnal access control can be enabled by setting the
+ HotelDruid administrator password from the "users management"
+ page. User logins will then become mandatory.
Template: hoteldruid/restart-webserver
Type: boolean
Default: true
-_Description: Should the web server be restarted now?
- In order to activate the new configuration, the reconfigured web
- server has to be restarted.
+_Description: Restart the web server after HotelDruid configuration?
+ In order to activate the new configuration for HotelDruid,
+ the web server has to be restarted.
Template: hoteldruid/purgedata
Type: boolean
Default: false
-_Description: Purge also application data now?
- By default, HotelDruid stores all its data in some files in
- /var/lib/hoteldruid.
- .
- Accepting this option will remove all this data and leave you with a
- tidier system once the HotelDruid package has been removed, but
- may cause information loss if you have operational data in those
- files.
+_Description: Purge HotelDuid data when purging the package?
+ HotelDruid data are stored in /var/lib/hoteldruid.
+ .
+ If you choose this option, these data files will be removed when
+ the package is purged.
+ .
+ You should deny this option if you have operational information which
+ you wish to keep after HotelDruid is removed.
--- hoteldruid.old/debian/control 2012-07-29 08:12:09.265653313 -0600
+++ hoteldruid/debian/control 2012-07-31 09:13:04.747521806 -0600
@@ -11,15 +11,20 @@
Depends: ${misc:Depends}, ucf, apache2 | httpd, libapache2-mod-php5 | php5-cgi | php5,
php5-sqlite (>= 5.3.3)
Suggests: iceweasel | www-browser, php5-mysql | php5-pgsql
-Description: Web-based property management system for your hotel or B&B
+Description: web-based property management system for hotels or B&B
HotelDruid is designed to manage hotel rooms, bed and breakfast apartments
- or any other kind of daily rental, from your browser.
+ or any other kind of daily rental, from a web browser.
.
- Reservations can be assigned to rooms automatically with user defined
- rules. You can create website pages to display and check availability.
- Includes point of sale and statistics reports. Multi-user with groups and
- privileges system. Supports printing, saving and emailing of documents and
- invoices.
+ Main features:
+ * automatic reservation assignment to rooms with user-defined
+ rules;
+ * web site pages creation and maintenance, including room
+ availability;
+ * point of sale;
+ * statistics reports
+ * multi-user capabilities, including groups and privileges
+ management;
+ * printing, saving and emailing of documents and invoices.
.
- Written in PHP, by default uses SQLite as its database, with possibility
- to migrate to MySQL or PostgreSQL.
+ It uses an SQLite database by default but can be configured for use
+ with MySQL or PostgreSQL.
Source: hoteldruid
Section: web
Priority: optional
Maintainer: Marco Maria Francesco De Santis <marco@digitaldruid.net>
Build-Depends: debhelper (>= 8.0.0), po-debconf
Standards-Version: 3.9.3
Homepage: http://www.hoteldruid.com/
Package: hoteldruid
Architecture: all
Depends: ${misc:Depends}, ucf, apache2 | httpd, libapache2-mod-php5 | php5-cgi | php5,
php5-sqlite (>= 5.3.3)
Suggests: iceweasel | www-browser, php5-mysql | php5-pgsql
Description: web-based property management system for hotels or B&B
HotelDruid is designed to manage hotel rooms, bed and breakfast apartments
or any other kind of daily rental, from a web browser.
.
Main features:
* automatic reservation assignment to rooms with user-defined
rules;
* web site pages creation and maintenance, including room
availability;
* point of sale;
* statistics reports
* multi-user capabilities, including groups and privileges
management;
* printing, saving and emailing of documents and invoices.
.
It uses an SQLite database by default but can be configured for use
with MySQL or PostgreSQL.
Attachment:
signature.asc
Description: Digital signature