[DRE-maint] Bug#779898: [RFR] templates://diaspora-installer/{templates}

Justin B Rye justin.byam.rye at gmail.com
Sat Mar 14 09:05:31 UTC 2015


Christian PERRIER wrote:
> --- diaspora-installer.old/debian/templates	2015-03-06 07:50:19.213783515 +0100
> +++ diaspora-installer/debian/templates	2015-03-10 07:15:48.603862559 +0100
> @@ -1,12 +1,15 @@
>  Template: diaspora-installer/url
>  Type: string
>  Default: localhost
> -_Description: hostname for your diaspora instance:
> - Set the hostname of the machine you're running Diaspora on, as seen
> - from the internet. This should be the domain name you want to use to
> - access the pod. So if you plan to use a reverse proxy, it should be
> - the hostname the proxy listens on. DO NOT CHANGE THIS AFTER INITIAL SETUP!
> - If you do change the hostname, you will have to start again as the hostname
> - will be hardcoded into the database.
> +_Description: Host name for this instance of Diaspora:
> + Please choose the host name which should be used to access this
> + instance of Diaspora.
>   .
> - Examples: example.com, pod.example.com etc
> + This should be the fully qualified name needed by users in order
> + to access the pod.
> + .
> + If a reverse proxy is used, this should then be
> + the hostname used by the proxy server.
> + .
> + This host name should not be modified after the initial setup because
> + it is hardcoded in the database.
> 
> Many small changes:
> - avoid "your" diaspora instance. Even in the case of Diaspora, this
> is likely to be the case.....this is something we usually avoid in
> debconf templates

In the slightly abbreviated grammar of the Description line we might
even say "Diaspora instance host name:", but there's no need here.
 
> - use the "Please <foo>" construction which is also something we
> usually recommend in debconf templates

I think we should keep a mention of the Internet and domain names, to
avoid the impression that it's talking about local users, given that
"localhost" is the default and that it's important that the reader
should notice and change that immediately (in fact, why *is* it
localhost and not `hostname --fqdn`?).  Maybe:

    This should be the fully qualified name as seen from the Internet, with
    the domain name that will be used to access the pod.
 
> - then split in several paragraphs for readability

The problem is that this makes it slightly less obvious what "this"
refers to in the next paragraph.  (Also, overuse of "used".)

    If a reverse proxy is used, give the hostname that the proxy server
    responds to.

In the last line, I'm not sure about "hardcoded".  Wikipedia prefers
"hard coded"; fortunately in this case dictionaries seem to like the
compromise candidate "hard-coded".

Then in the package descriptions:

>  Diaspora (currently styled diaspora* and formerly styled DIASPORA*) is a free
>  personal web server that implements a distributed social networking service.
>  Installations of the software form nodes (termed "pods") which make up the
>  distributed Diaspora social network.
>  .
>  Diaspora is intended to address privacy concerns related to centralized
>  social networks by allowing users set up their own server (or "pod") to
                                    ^to
An innovative "allow" glitch.

>  host content; pods can then interact to share status updates, photographs,
>  and other social data. It allows its users to host their data with a
>  traditional web host, a cloud-based host, an ISP, or a friend. The framework,
>  which is being built on Ruby on Rails, is free software and can be
>  experimented with by external developers.

I suppose given that this is only an installer it really is worth
mentioning that this doesn't mean the software is full of proprietary
plug-ins and binary blobs.  (So why in fact does Diaspora need an
installer rather than being directly packaged for Debian?)
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
-------------- next part --------------
diff -ru diaspora-installer-0.2.pristine/debian/control diaspora-installer-0.2/debian/control
--- diaspora-installer-0.2.pristine/debian/control	2015-01-06 17:31:16.000000000 +0000
+++ diaspora-installer-0.2/debian/control	2015-03-14 08:52:53.240779905 +0000
@@ -44,16 +44,16 @@
  distributed Diaspora social network.
  .
  Diaspora is intended to address privacy concerns related to centralized
- social networks by allowing users set up their own server (or "pod") to
+ social networks by allowing users to set up their own server (or "pod") to
  host content; pods can then interact to share status updates, photographs,
  and other social data. It allows its users to host their data with a
  traditional web host, a cloud-based host, an ISP, or a friend. The framework,
  which is being built on Ruby on Rails, is free software and can be
  experimented with by external developers.
  .
- Learn more about diaspora at http://diasporafoundation.org
+ Learn more about Diaspora at http://diasporafoundation.org
  .
- This package helps install diaspora using rubygems.
+ This package helps to install Diaspora using rubygems.
 
 Package: diaspora-common
 Architecture: all
@@ -86,13 +86,13 @@
  distributed Diaspora social network.
  .
  Diaspora is intended to address privacy concerns related to centralized
- social networks by allowing users set up their own server (or "pod") to
+ social networks by allowing users to set up their own server (or "pod") to
  host content; pods can then interact to share status updates, photographs,
  and other social data. It allows its users to host their data with a
  traditional web host, a cloud-based host, an ISP, or a friend. The framework,
  which is being built on Ruby on Rails, is free software and can be
  experimented with by external developers.
  .
- Learn more about diaspora at http://diasporafoundation.org
+ Learn more about Diaspora at http://diasporafoundation.org
  .
- This package provides files common between diaspora and diaspora-installer.
+ This package provides common for the diaspora and diaspora-installer packages.
diff -ru diaspora-installer-0.2.pristine/debian/templates diaspora-installer-0.2/debian/templates
--- diaspora-installer-0.2.pristine/debian/templates	2014-12-02 19:06:06.000000000 +0000
+++ diaspora-installer-0.2/debian/templates	2015-03-14 08:51:48.662688141 +0000
@@ -1,12 +1,15 @@
 Template: diaspora-installer/url
 Type: string
 Default: localhost
-_Description: hostname for your diaspora instance:
- Set the hostname of the machine you're running Diaspora on, as seen
- from the internet. This should be the domain name you want to use to
- access the pod. So if you plan to use a reverse proxy, it should be
- the hostname the proxy listens on. DO NOT CHANGE THIS AFTER INITIAL SETUP!
- If you do change the hostname, you will have to start again as the hostname
- will be hardcoded into the database.
+_Description: Host name for this instance of Diaspora:
+ Please choose the host name which should be used to access this
+ instance of Diaspora.
  .
- Examples: example.com, pod.example.com etc
+ 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.
-------------- next part --------------
Template: diaspora-installer/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.
-------------- next part --------------
Source: diaspora-installer
Section: ruby
Priority: optional
Maintainer: Debian Ruby Extras Maintainers <pkg-ruby-extras-maintainers at lists.alioth.debian.org>
Uploaders: Pirate Praveen <praveen at debian.org>
Build-Depends: debhelper (>= 9), gem2deb (>= 0.7.5~), po-debconf
Standards-Version: 3.9.6
Vcs-Git: git://anonscm.debian.org/pkg-ruby-extras/diaspora-installer.git
Vcs-Browser: http://anonscm.debian.org/gitweb/?p=pkg-ruby-extras/diaspora-installer.git;a=summary
Homepage: http://wiki.debian.org/Diaspora
XS-Ruby-Versions: all

Package: diaspora-installer
Architecture: all
XB-Ruby-Versions: ${ruby:Versions}
Pre-Depends: postgresql-client, dbconfig-common, adduser
Depends: ${shlibs:Depends}, ${misc:Depends}, ruby | ruby-interpreter,
 diaspora-common,
 nodejs,
 curl,
 postgresql,
 redis-server,
 sudo,
 ruby-rspec,
 bundler,
 ruby-dev,
 libpq-dev,
 build-essential,
 libssl-dev,
 libcurl4-openssl-dev,
 libxml2-dev,
 libxslt-dev,
 imagemagick,
 ghostscript,
 libmagickwand-dev,
 net-tools,
 nginx
Conflicts: diaspora
Replaces: diaspora
Description: distributed social networking service - installer
 Diaspora (currently styled diaspora* and formerly styled DIASPORA*) is a free
 personal web server that implements a distributed social networking service.
 Installations of the software form nodes (termed "pods") which make up the
 distributed Diaspora social network.
 .
 Diaspora is intended to address privacy concerns related to centralized
 social networks by allowing users to set up their own server (or "pod") to
 host content; pods can then interact to share status updates, photographs,
 and other social data. It allows its users to host their data with a
 traditional web host, a cloud-based host, an ISP, or a friend. The framework,
 which is being built on Ruby on Rails, is free software and can be
 experimented with by external developers.
 .
 Learn more about Diaspora at http://diasporafoundation.org
 .
 This package helps to install Diaspora using rubygems.

Package: diaspora-common
Architecture: all
XB-Ruby-Versions: ${ruby:Versions}
Pre-Depends: postgresql-client, dbconfig-common, adduser
Depends: ${shlibs:Depends}, ${misc:Depends}, ruby | ruby-interpreter,
 nodejs,
 curl,
 postgresql,
 redis-server,
 sudo,
 ruby-rspec,
 bundler,
 ruby-dev,
 libpq-dev,
 build-essential,
 libssl-dev,
 libcurl4-openssl-dev,
 libxml2-dev,
 libxslt-dev,
 imagemagick,
 ghostscript,
 libmagickwand-dev,
 net-tools,
 nginx
Description: distributed social networking service - common files
 Diaspora (currently styled diaspora* and formerly styled DIASPORA*) is a free
 personal web server that implements a distributed social networking service.
 Installations of the software form nodes (termed "pods") which make up the
 distributed Diaspora social network.
 .
 Diaspora is intended to address privacy concerns related to centralized
 social networks by allowing users to set up their own server (or "pod") to
 host content; pods can then interact to share status updates, photographs,
 and other social data. It allows its users to host their data with a
 traditional web host, a cloud-based host, an ISP, or a friend. The framework,
 which is being built on Ruby on Rails, is free software and can be
 experimented with by external developers.
 .
 Learn more about Diaspora at http://diasporafoundation.org
 .
 This package provides common for the diaspora and diaspora-installer packages.


More information about the Pkg-ruby-extras-maintainers mailing list