[OpenStack-docs] How to tackle DocImpact bugs (specifically: Glance metadata catalog)

Bernd Bausch berndbausch at gmail.com
Wed May 27 04:33:16 UTC 2015


Launchpad has two DocImpact bugs about the glance metadata catalog (see
links after this paragraph). While the developer docs now contain
information about the metadata catalog, there is nothing in the
user/administrator docs. I suppose this is why they are still open.
https://bugs.launchpad.net/openstack-manuals/+bug/1366286 "Glance Metadata
Definitions Catalog - Seed"
https://bugs.launchpad.net/openstack-manuals/+bug/1378237 "Glance metadata
concepts need to be added"

Before I jump in and work on this, I have a few questions that this
community may be able to help with.

- Which book(s) would this normally go to? For example, a page in the Glance
CLI docs that covers the commands, a page in the admin guide that covers the
concepts and workflow - would you agree? 

- while the developer docs cover the concepts and the API, I would really
like to know what led to the addition of the metadata catalog (what itch
does it scratch, so to speak), and what good and bad use cases can be
proposed. My immediate reflex would be asking the developer community or
start with the Glance docs liaison. Other suggestions? 
(if a glance developer reads this, feel free to jump in :)

- Finally, should I be fazed by the fact that there are (at least) two
DocImpact bugs? I would think one stone kills both birds in this case. Can I
put a double "closes-bug" clause in my git header?

Bernd





More information about the OpenStack-docs mailing list