[Openstack-devel] Bug#659277: [RFR] templates://glance/{glance-api.templates, glance-common.templates}

[Justin B Rye]

Christian PERRIER wrote:
>  Default: caching
>  _Description: Pipeline flavor:
>   If you use the OpenStack Identity Service (Keystone), you might want to
> - select keystone. If you don't use this service, you can safely choose
> - caching only.
> \ No newline at end of file
> + select "keystone". If you don't use this service, you can safely choose
> + "caching" only.
> 
> Simply use quotes around choices. I would propose making the choices
> translatable but they seem to be jargon related to the "thing"
> (OpenStack blahblah) and making them translatable will just bring
> trouble to translators....

Especially if they then need to give both translated and original
versions of "OpenStack Identity Service (Keystone)".

Does this need an introductory instruction along the lines of:

    Please specify the flavor of pipeline to be used by Glance.

...or is the description line enough?

>  Template: glance-api/auth-url
>  Type: string
>  Default: http://localhost:5000
>  _Description: Auth server URL:
>   Type the URL of your auth server. This is typically the URL of your
>   OpenStack Identity Service (Keystone).

I don't know if debconf has input methods that aren't covered by the
term "typing", but the word seems out of place anyway.

  + Please specify the URL of your Glance authentication server. Typically        
  + this is also the URL of your OpenStack Identity Service (Keystone).
       
> -Description: OpenStack Image Registry and Delivery Service - Python client library
> +Description: OpenStack image registry and delivery service - Python client library
[...]
> -Description: OpenStack Image Registry and Delivery Service - Common
> +Description: OpenStack image registry and delivery service - Common
> 
> Just stop using capitals everywhere. This is my only proposed change
> because I don't understand a s*** about the remaining of the package
> description.

OpenStack themselves call it something shorter:
   Description: OpenStack Image Service - Python client library
   Description: OpenStack Image Service - common files
 
> What is OpenStack?
> What "image" are we talking about? Is this about a place where to
>  store my holiday and family pictures? It doesn't seem to be this but
>  nothing give a clue about what we're talking about.

Well, it's "cloud" computing, isn't it?  And that's just fog on a
higher level. 

> Who is Nova?

Wikipedia on the OpenStack platform lists two components: "Compute
(Nova)" and "Object Storage (Swift)".  Nova is a fabric controller,
named after NASA's "Nebula" platform.  So either it's something you
pour into your washing machine or it's an IaaS fluffer.

>   The Glance project provides an image registration, discovery and
>   delivery service. These services may be used as stand-along services, and
>   they may also be used by Nova to deliver images from object stores, such as
>   OpenStack's Swift service, to Nova's compute nodes.
 
Using material from other sources, I'd suggest:

    The Glance project provides services for discovering, registering, and
    retrieving virtual machine images over the cloud. They may be stand-alone
    services, or may be used to deliver images from object stores, such as
    OpenStack's Swift service, to Nova's compute nodes.
         
Just including the word "cloud" in there is enough to make most of the
pain go away... and adding "virtual machine images" to make it obvious
that it isn't talking about images of kittens.

Otherwise my package-description tweaks are mostly a matter of giving
"Glance API" the correct capitalisation.

Obligatory WhyTheName appendix:
I'm assuming Glance is just an arbitrary codename.  I'm astonished it
wasn't already in use for some GL/GNOME/GNU library already.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
-------------- next part --------------
Template: glance/paste-flavor
Type: select
Choices: keystone, caching, keystone+caching, cachemanagement, keystone+cachemanagement
Default: caching
_Description: Pipeline flavor:
 Please specify the flavor of pipeline to be used by Glance.
 .
 If you use the OpenStack Identity Service (Keystone), you might want to
 select "keystone". If you don't use this service, you can safely choose
 "caching" only.
-------------- next part --------------
Template: glance-api/auth-url
Type: string
Default: http://localhost:5000
_Description: Auth server URL:
 Please specify the URL of your Glance authentication server. Typically
 this is also the URL of your OpenStack Identity Service (Keystone).

Template: glance-api/auth-token
Type: string
_Description: Auth server admin token:
-------------- next part --------------
Source: glance
Section: net
Priority: extra
Maintainer: PKG OpenStack <openstack-devel at lists.alioth.debian.org>
Uploaders: Julien Danjou <acid at debian.org>,
           Thomas Goirand <zigo at debian.org>,
           Ghe Rivero <ghe at debian.org>
Build-Depends: debhelper (>= 7.0.50),
 python-all (>= 2.6.6-3~),
 po-debconf
Build-Depends-Indep:
 python-setuptools,
 python-sphinx,
 python-distutils-extra,
 python-sqlalchemy-ext | python-sqlalchemy (<< 0.6.3-2),
 python-nose,
 python-webob,
 python-migrate,
 python-routes,
 python-boto,
 python-kombu,
 python-httplib2 (>= 0.6.0)
Standards-Version: 3.9.2
Homepage: http://launchpad.net/glance
Vcs-Browser: http://anonscm.debian.org/gitweb/?p=openstack/glance.git;a=summary
Vcs-Git: git://anonscm.debian.org/openstack/glance.git

Package: python-glance
Architecture: all
Section: python
Depends: ${python:Depends}, ${misc:Depends},
 python-webob,
 python-routes,
 python-daemon,
 python-eventlet,
 python-sqlalchemy-ext | python-sqlalchemy (<< 0.6.3-2),
 python-pastedeploy,
 python-argparse,
 python-migrate,
 python-kombu,
 python-xattr,
 python-crypto,
 python-httplib2 (>= 0.6.0)
Description: OpenStack Image Service - Python client library
 The Glance project provides services for discovering, registering, and
 retrieving virtual machine images over the cloud. They may be stand-alone
 services, or may be used to deliver images from object stores, such as
 OpenStack's Swift service, to Nova's compute nodes.
 .
 This package contains the Python client libraries.

Package: glance-common
Architecture: all
Section: python
Replaces: glance (<< 2012.1~e2-3)
Depends: ${python:Depends}, ${misc:Depends},
    adduser,
    python-eventlet,
    python-glance (= ${source:Version}),
    python-migrate,
    python-routes,
    python-sqlalchemy-ext | python-sqlalchemy (<< 0.6.3-2),
    python-xattr,
    python-paste
Description: OpenStack Image Service - common files
 The Glance project provides services for discovering, registering, and
 retrieving virtual machine images over the cloud. They may be stand-alone
 services, or may be used to deliver images from object stores, such as
 OpenStack's Swift service, to Nova's compute nodes.
 .
 This package contains common files for Glance.

Package: glance-api
Architecture: all
Section: python
Replaces: glance (<< 2012.1~e2-3)
Depends: ${python:Depends}, ${misc:Depends}, glance-common (= ${source:Version}), debconf
Description: OpenStack Image Service - API server
 The Glance project provides services for discovering, registering, and
 retrieving virtual machine images over the cloud. They may be stand-alone
 services, or may be used to deliver images from object stores, such as
 OpenStack's Swift service, to Nova's compute nodes.
 .
 This package contains the Glance API server.

Package: glance-registry
Architecture: all
Section: python
Replaces: glance (<< 2012.1~e2-3)
Depends: ${python:Depends}, ${misc:Depends}, glance-common (= ${source:Version})
Description: OpenStack Image Service - registry server
 The Glance project provides services for discovering, registering, and
 retrieving virtual machine images over the cloud. They may be stand-alone
 services, or may be used to deliver images from object stores, such as
 OpenStack's Swift service, to Nova's compute nodes.
 .
 This package contains the Glance registry server.

Package: glance
Architecture: all
Section: python
Depends: glance-api (= ${source:Version}), glance-registry (= ${source:Version}),
 ${misc:Depends}
Description: OpenStack Image Service - metapackage
 The Glance project provides services for discovering, registering, and
 retrieving virtual machine images over the cloud. They may be stand-alone
 services, or may be used to deliver images from object stores, such as
 OpenStack's Swift service, to Nova's compute nodes.
 .
 This is a dependency package to install all of the Glance suite.

Package: python-glance-doc
Architecture: all
Section: doc
Depends: libjs-jquery, libjs-underscore, ${misc:Depends}
Description: OpenStack Image Service - Python library documentation
 The Glance project provides services for discovering, registering, and
 retrieving virtual machine images over the cloud. They may be stand-alone
 services, or may be used to deliver images from object stores, such as
 OpenStack's Swift service, to Nova's compute nodes.
 .
 This package contains the Python client library documentation.
-------------- next part --------------
diff -ru glance-2012.1~e3.pristine/debian/control glance-2012.1~e3/debian/control
--- glance-2012.1~e3.pristine/debian/control	2012-02-06 12:09:48.000000000 +0000
+++ glance-2012.1~e3/debian/control	2012-02-13 11:26:16.127861312 +0000
@@ -41,10 +41,10 @@
  python-xattr,
  python-crypto,
  python-httplib2 (>= 0.6.0)
-Description: OpenStack Image Registry and Delivery Service - Python client library
- The Glance project provides an image registration, discovery and
- delivery service. These services may be used as stand-along services, and
- they may also be used by Nova to deliver images from object stores, such as
+Description: OpenStack Image Service - Python client library
+ The Glance project provides services for discovering, registering, and
+ retrieving virtual machine images over the cloud. They may be stand-alone
+ services, or may be used to deliver images from object stores, such as
  OpenStack's Swift service, to Nova's compute nodes.
  .
  This package contains the Python client libraries.
@@ -62,61 +62,61 @@
     python-sqlalchemy-ext | python-sqlalchemy (<< 0.6.3-2),
     python-xattr,
     python-paste
-Description: OpenStack Image Registry and Delivery Service - Common
- The Glance project provides an image registration, discovery and
- delivery service. These services may be used as stand-along services, and
- they may also be used by Nova to deliver images from object stores, such as
+Description: OpenStack Image Service - common files
+ The Glance project provides services for discovering, registering, and
+ retrieving virtual machine images over the cloud. They may be stand-alone
+ services, or may be used to deliver images from object stores, such as
  OpenStack's Swift service, to Nova's compute nodes.
  .
- This package contains the glance common.
+ This package contains common files for Glance.
 
 Package: glance-api
 Architecture: all
 Section: python
 Replaces: glance (<< 2012.1~e2-3)
 Depends: ${python:Depends}, ${misc:Depends}, glance-common (= ${source:Version}), debconf
-Description: OpenStack Image Registry and Delivery Service - API
- The Glance project provides an image registration, discovery and
- delivery service. These services may be used as stand-along services, and
- they may also be used by Nova to deliver images from object stores, such as
+Description: OpenStack Image Service - API server
+ The Glance project provides services for discovering, registering, and
+ retrieving virtual machine images over the cloud. They may be stand-alone
+ services, or may be used to deliver images from object stores, such as
  OpenStack's Swift service, to Nova's compute nodes.
  .
- This package contains the glance api server.
+ This package contains the Glance API server.
 
 Package: glance-registry
 Architecture: all
 Section: python
 Replaces: glance (<< 2012.1~e2-3)
 Depends: ${python:Depends}, ${misc:Depends}, glance-common (= ${source:Version})
-Description: OpenStack Image Registry and Delivery Service - Registry
- The Glance project provides an image registration, discovery and
- delivery service. These services may be used as stand-along services, and
- they may also be used by Nova to deliver images from object stores, such as
+Description: OpenStack Image Service - registry server
+ The Glance project provides services for discovering, registering, and
+ retrieving virtual machine images over the cloud. They may be stand-alone
+ services, or may be used to deliver images from object stores, such as
  OpenStack's Swift service, to Nova's compute nodes.
  .
- This package contains the glance registry server.
+ This package contains the Glance registry server.
 
 Package: glance
 Architecture: all
 Section: python
 Depends: glance-api (= ${source:Version}), glance-registry (= ${source:Version}),
  ${misc:Depends}
-Description: OpenStack Image Registry and Delivery Service
- The Glance project provides an image registration, discovery and
- delivery service. These services may be used as stand-along services, and
- they may also be used by Nova to deliver images from object stores, such as
+Description: OpenStack Image Service - metapackage
+ The Glance project provides services for discovering, registering, and
+ retrieving virtual machine images over the cloud. They may be stand-alone
+ services, or may be used to deliver images from object stores, such as
  OpenStack's Swift service, to Nova's compute nodes.
  .
- This is a dependency package.
+ This is a dependency package to install all of the Glance suite.
 
 Package: python-glance-doc
 Architecture: all
 Section: doc
 Depends: libjs-jquery, libjs-underscore, ${misc:Depends}
-Description: OpenStack Image Registry and Delivery Service - Documentation
- The Glance project provides an image registration, discovery and
- delivery service. These services may be used as stand-along services, and
- they may also be used by Nova to deliver images from object stores, such as
+Description: OpenStack Image Service - Python library documentation
+ The Glance project provides services for discovering, registering, and
+ retrieving virtual machine images over the cloud. They may be stand-alone
+ services, or may be used to deliver images from object stores, such as
  OpenStack's Swift service, to Nova's compute nodes.
  .
- This package contains the documentation.
+ This package contains the Python client library documentation.
diff -ru glance-2012.1~e3.pristine/debian/glance-api.templates glance-2012.1~e3/debian/glance-api.templates
--- glance-2012.1~e3.pristine/debian/glance-api.templates	2012-02-06 13:45:31.000000000 +0000
+++ glance-2012.1~e3/debian/glance-api.templates	2012-02-09 23:06:31.619861049 +0000
@@ -2,8 +2,8 @@
 Type: string
 Default: http://localhost:5000
 _Description: Auth server URL:
- Type the URL of your auth server. This is typically the URL of your
- OpenStack Identity Service (Keystone).
+ Please specify the URL of your Glance authentication server. Typically
+ this is also the URL of your OpenStack Identity Service (Keystone).
 
 Template: glance-api/auth-token
 Type: string
diff -ru glance-2012.1~e3.pristine/debian/glance-common.templates glance-2012.1~e3/debian/glance-common.templates
--- glance-2012.1~e3.pristine/debian/glance-common.templates	2012-02-06 15:02:54.000000000 +0000
+++ glance-2012.1~e3/debian/glance-common.templates	2012-02-13 11:23:07.431527955 +0000
@@ -3,6 +3,8 @@
 Choices: keystone, caching, keystone+caching, cachemanagement, keystone+cachemanagement
 Default: caching
 _Description: Pipeline flavor:
+ Please specify the flavor of pipeline to be used by Glance.
+ .
  If you use the OpenStack Identity Service (Keystone), you might want to
- select keystone. If you don't use this service, you can safely choose
- caching only.
\ No newline at end of file
+ select "keystone". If you don't use this service, you can safely choose
+ "caching" only.