[Openstack-devel] Bug#708661: [RFR] templates://sftpcloudfs/{templates}

[Justin B Rye]

Christian PERRIER wrote:
>  Template: sftpcloudfs/auth-url
>  Type: string
>  Default: https://auth.api.rackspacecloud.com/v1.0
> +_Description: Authentication server URL:
> + In order to authenticate its users, SFTPCloudFS needs to connect to an
> + authentication server (such as RackSpace Cloud Files or OpenStack).
> + Please enter the URL of that server.
>   .
> + URL examples:
> +  * Rackspace in USA: https://auth.api.rackspacecloud.com/v1.0
> +  * Rackspace in UK:  https://lon.auth.api.rackspacecloud.com/v1.0
> +  * Swift: URLs such as https://example.com/v1.0

Good idea.  Maybe for even neater colon-symmetry:

    URL examples:
     * Rackspace in the US: https://auth.api.rackspacecloud.com/v1.0
     * Rackspace in the UK: https://lon.auth.api.rackspacecloud.com/v1.0
     * Swift: some URL like https://example.com/v1.0 (or an IP address)

(also cramming in some extra info at the end).

Meanwhile in the package description:
 
> Package: sftpcloudfs
[...]
> Description: SFTP interface to Rackspace Cloud Files and OpenStack Object Storage

That's just on the edge of being too long.  Could we afford to make it:

  Description: SFTP interface to Rackspace/OpenStack storage services

and leave the full names for the long description?

>  SFTP (Secure File Transfer Protocol) interface to Rackspace Cloud Files and
>  OpenStack Object Storage, providing a service that acts as a proxy between a
>  SFTP client and a remote files/storage service.

Make that a sentence by prefixing "this package provides an..."; but
then avoid repetition by turning "providing a service that acts..."
into just "acting...".

Hard-to-spot article error: "between AN esseffteepee client..."

"A remote files/storage service" seems wrong (especially once it's
repeated for the third time), mainly because it's slightly unnatural
to talk about "a files service" (plural), but also because I can't see
what the reference to files adds to this: what would a storage service
store if not files?  When I Google the expression I find sftpcloudfs
and nothing else; so I'll change it throughout to just "a remote
storage service".

>  .
>  The username/password pair used to open the SFTP session is validated using the
>  authentication service of the files/storage service to get an authentication
>  token.
>  .
>  The communication between the client and the SFTP daemon is encrypted all the
>  time, and the SFTP service supports HTTPS communication with the remote
>  files/storage service.

I don't follow this (so I won't try to rephrase it).  It seems obvious
that client/server connections are encrypted (this isn't plain old
insecure-FTP!), so is this maybe emphasising that one side of
sftpcloudfs uses SSH and the other uses SSL/TLS?
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
-------------- next part --------------
diff -ru sftpcloudfs-0.7.pristine/debian/control sftpcloudfs-0.7/debian/control
--- sftpcloudfs-0.7.pristine/debian/control	2013-05-15 08:03:12.000000000 +0100
+++ sftpcloudfs-0.7/debian/control	2013-06-03 00:49:02.506683402 +0100
@@ -25,15 +25,15 @@
  python-daemon,
  python-cloudfiles,
  python-memcache
-Description: SFTP interface to Rackspace Cloud Files and OpenStack Object Storage
- SFTP (Secure File Transfer Protocol) interface to Rackspace Cloud Files and
- OpenStack Object Storage, providing a service that acts as a proxy between a
- SFTP client and a remote files/storage service.
+Description: SFTP interface to Rackspace/OpenStack storage services
+ This package provides an SFTP (Secure File Transfer Protocol) interface to
+ Rackspace Cloud Files and OpenStack Object Storage, acting as a proxy between
+ an SFTP client and a remote storage service.
  .
  The username/password pair used to open the SFTP session is validated using the
- authentication service of the files/storage service to get an authentication
+ authentication service of the storage service to get an authentication
  token.
  .
  The communication between the client and the SFTP daemon is encrypted all the
  time, and the SFTP service supports HTTPS communication with the remote
- files/storage service.
+ storage service.
diff -ru sftpcloudfs-0.7.pristine/debian/templates sftpcloudfs-0.7/debian/templates
--- sftpcloudfs-0.7.pristine/debian/templates	2013-05-15 08:03:12.000000000 +0100
+++ sftpcloudfs-0.7/debian/templates	2013-06-03 00:51:03.707164978 +0100
@@ -1,14 +1,12 @@
 Template: sftpcloudfs/auth-url
 Type: string
 Default: https://auth.api.rackspacecloud.com/v1.0
-_Description: Content of the auth-url directive:
- In order to authenticate it's users, SFTPCloudFS needs to connect to an
- authentication server (eg RackSpace Cloud Files, OpenStack). Enter the
- URL of that server.
+_Description: Authentication server URL:
+ In order to authenticate its users, SFTPCloudFS needs to connect to an
+ authentication server (such as RackSpace Cloud Files or OpenStack).
+ Please enter the URL of that server.
  .
- For Rackspace in US, choose https://auth.api.rackspacecloud.com/v1.0
- .
- For Rackspace in UK, choose https://lon.auth.api.rackspacecloud.com/v1.0
- .
- If you use Swift, something like this will do: https://example.com/v1.0
- (or use the IP address directly).
+ URL examples:
+  * Rackspace in the US: https://auth.api.rackspacecloud.com/v1.0
+  * Rackspace in the UK: https://lon.auth.api.rackspacecloud.com/v1.0
+  * Swift: some URL like https://example.com/v1.0 (or an IP address)
-------------- next part --------------
Template: sftpcloudfs/auth-url
Type: string
Default: https://auth.api.rackspacecloud.com/v1.0
_Description: Authentication server URL:
 In order to authenticate its users, SFTPCloudFS needs to connect to an
 authentication server (such as RackSpace Cloud Files or OpenStack).
 Please enter the URL of that server.
 .
 URL examples:
  * Rackspace in the US: https://auth.api.rackspacecloud.com/v1.0
  * Rackspace in the UK: https://lon.auth.api.rackspacecloud.com/v1.0
  * Swift: some URL like https://example.com/v1.0 (or an IP address)
-------------- next part --------------
Source: sftpcloudfs
Section: net
Priority: extra
Maintainer: PKG OpenStack <openstack-devel at lists.alioth.debian.org>
Uploaders: Loic Dachary (OuoU) <loic at debian.org>,
           Julien Danjou <acid at debian.org>,
           Thomas Goirand <zigo at debian.org>,
           Ghe Rivero <ghe.rivero at stackops.com>,
           Mehdi Abaakouk <sileht at sileht.net>
Build-Depends: debhelper (>= 9), python-setuptools, python-all (>= 2.6.6-3~), openstack-pkg-tools, po-debconf
Standards-Version: 3.9.4
Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/sftpcloudfs.git
Vcs-Git: git://anonscm.debian.org/openstack/sftpcloudfs.git
Homepage: https://github.com/Memset/sftpcloudfs

Package: sftpcloudfs
Architecture: all
Pre-Depends: dpkg (>= 1.15.6~)
Depends: ${python:Depends}, ${misc:Depends},
 adduser,
 debconf,
 python-ftp-cloudfs (>= 0.19),
 openssh-client,
 python-paramiko,
 python-daemon,
 python-cloudfiles,
 python-memcache
Description: SFTP interface to Rackspace/OpenStack storage services
 This package provides an SFTP (Secure File Transfer Protocol) interface to
 Rackspace Cloud Files and OpenStack Object Storage, acting as a proxy between
 an SFTP client and a remote storage service.
 .
 The username/password pair used to open the SFTP session is validated using the
 authentication service of the storage service to get an authentication
 token.
 .
 The communication between the client and the SFTP daemon is encrypted all the
 time, and the SFTP service supports HTTPS communication with the remote
 storage service.