[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [diaspora-installer] new strings review request



Pirate Praveen wrote:
> Template: diaspora-common/intro
> Type: text
> _Description: Getting started with diaspora-installer

The Developers Reference (§6.5.3.1.7) says of "Type: text" that "This
type is now considered obsolete: don't use it."  The information
should probably be somewhere else - the package description?  A
README.Debian?  If it absolutely has to be delivered via debconf, it
could be "Type: note", but that's usually worth avoiding if possible
(because for a start it's hard to refer back to it later).

>  This package lets you setup a diaspora pod in easy steps. It configures
>  postgresql as database and nginx as web server.

The verb is two words: "set up".  Diaspora, PostgreSQL, and Nginx
should probably be capitalised (the "brand name" of the software in
general, not a particular Debian package/executable).

   This package lets you set up a Diaspora pod in easy steps. It configures
   PostgreSQL as the database and Nginx as the web server.

But if this paragraph is news to anybody installing the package you
probably need a better package description.

>  .
>  You can leave PostgreSQL application password blank as we use "ident"
>  authentication method (diaspora user on the system can connect to
>  diaspora database without password).

There are some missing articles here; how about:

   You can leave the PostgreSQL application password blank, as the "ident"
   authentication method is used, allowing the diaspora user on the system
   to connect to the Diaspora database without a password.

(Or maybe diaspora should be Diaspora, or vice versa - I forget, are
the user and database *named* "diaspora"?)

Why tell a user this now rather than as part of the step where it asks
them for a password?

>  .
>  You will need an ssl certificate for running diaspora. You can generate
>  a self signed certificate using easy-rsa package.

Again, capitalisation and articles:

   Running Diaspora requires at least a self-signed SSL certificate, which
   can be generated using (for instance) the package easy-rsa.

(This seems to imply that there should be a Recommends: or at least
Suggests: from diaspora to easy-rsa, in which case this explanation
for the dependency might belong in the package description.)
 
> Template: diaspora-common/url
> Type: string
> Default: localhost
> _Description: Host name for this instance of Diaspora:
>  Please choose the host name which should be used to access this
>  instance of Diaspora.
>  .
>  This should be the fully qualified name as seen from the Internet, with
>  the domain name that will be used to access the pod.
>  .
>  If a reverse proxy is used, give the hostname that the proxy server
>  responds to.
>  .
>  This host name should not be modified after the initial setup because
>  it is hard-coded in the database.

This one I've seen before.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
Template: diaspora-common/intro
Type: note
_Description: Getting started with diaspora-installer
 This package lets you set up a Diaspora pod in easy steps. It configures
 PostgreSQL as the database and Nginx as the web server.
 .
 You can leave the PostgreSQL application password blank, as the "ident"
 authentication method is used, allowing the diaspora user on the system
 to connect to the Diaspora database without a password.
 .
 Running Diaspora requires at least a self-signed SSL certificate, which
 can be generated using (for instance) the package easy-rsa.

Template: diaspora-common/url
Type: string
Default: localhost
_Description: Host name for this instance of Diaspora:
 Please choose the host name which should be used to access this
 instance of Diaspora.
 .
 This should be the fully qualified name as seen from the Internet, with
 the domain name that will be used to access the pod.
 .
 If a reverse proxy is used, give the hostname that the proxy server
 responds to.
 .
 This host name should not be modified after the initial setup because
 it is hard-coded in the database.
--- diaspora-common.templates.pristine	2015-05-02 18:33:44.403118337 +0100
+++ diaspora-common.templates	2015-05-02 19:45:53.138891292 +0100
@@ -1,15 +1,15 @@
 Template: diaspora-common/intro
-Type: text
+Type: note
 _Description: Getting started with diaspora-installer
- This package lets you setup a diaspora pod in easy steps. It configures
- postgresql as database and nginx as web server.
+ This package lets you set up a Diaspora pod in easy steps. It configures
+ PostgreSQL as the database and Nginx as the web server.
  .
- You can leave PostgreSQL application password blank as we use "ident"
- authentication method (diaspora user on the system can connect to
- diaspora database without password).
+ You can leave the PostgreSQL application password blank, as the "ident"
+ authentication method is used, allowing the diaspora user on the system
+ to connect to the Diaspora database without a password.
  .
- You will need an ssl certificate for running diaspora. You can generate
- a self signed certificate using easy-rsa package.
+ Running Diaspora requires at least a self-signed SSL certificate, which
+ can be generated using (for instance) the package easy-rsa.
 
 Template: diaspora-common/url
 Type: string

Reply to: