[Openstack-docs] Documentation for new Glance Metadata Definition Catalog

Chylinski, Arkadiusz arkadiusz.chylinski at intel.com
Thu Aug 21 07:11:03 UTC 2014


+Pawel S., Pawel K., Michal D., Michal J., Szymon - who are developing parts of this feature from Intel site.

Pozdrawiam / Kind Regards
Arkadiusz Chylinski (Arek)


From: Anne Gentle [mailto:anne.gentle at RACKSPACE.COM]
Sent: Wednesday, August 20, 2014 10:53 PM
To: Tripp, Travis S; openstack-docs at lists.openstack.org
Cc: Sundar, Murali; Sampath, Lakshmi; Okuma, Wayne; Chylinski, Arkadiusz; Mark Washenberger; Arnaud Legendre
Subject: Re: Documentation for new Glance Metadata Definition Catalog

Hi Travis,
Looking at the feature, it touches multiple guides, yep. I don't think we'd need a blueprint, though, as the blueprint already happened in glance. We would expect to track it with a DocImpact flag on the code commits that landed, then a doc bug is registered for tracking purposes. Blueprints for docs are for major cross-project updates, this seems like a feature addition.

Here's what we'd need to ensure we cover the doc needs for this feature:
 - API Reference information: WADL update in the openstack/api-site repository. You may be able to automate the generation of the WADL for a starting point with this tool:
https://github.com/stackforge/sphinxcontrib-docbookrestapi/blob/master/sphinxcontrib/docbookrestapi/docbook.py
 - CLI Reference information: The python-glanceclient additions may be pulled in with our scripted CLI Reference.
 - User Guide information: You should document how users tag their resources in the User Guide at http://docs.openstack.org/user-guide/content/. That's done by updating the openstack/openstack-manuals repo.
 - Admin User Guide or Cloud Admin Guide: If it's an admin task to tag resources, you may want to write an admin section in the Cloud Admin User Guide, also sourced in the openstack/openstack-manuals repo.

Let us know on IRC or this openstack-docs mailing list if you have any further questions; we're here to help.
Thanks!
Anne

From: <Tripp>, Travis S <travis.tripp at hp.com<mailto:travis.tripp at hp.com>>
Date: Wednesday, August 20, 2014 at 12:46 PM
To: Anne Gentle <anne.gentle at rackspace.com<mailto:anne.gentle at rackspace.com>>
Cc: "Sundar, Murali (murali.sundar at intel.com<mailto:murali.sundar at intel.com>)" <murali.sundar at intel.com<mailto:murali.sundar at intel.com>>, "Sampath, Lakshmi" <lakshmi.sampath at hp.com<mailto:lakshmi.sampath at hp.com>>, "Okuma, Wayne" <wayne.okuma at hp.com<mailto:wayne.okuma at hp.com>>, "Chylinski, Arkadiusz (arkadiusz.chylinski at intel.com<mailto:arkadiusz.chylinski at intel.com>)" <arkadiusz.chylinski at intel.com<mailto:arkadiusz.chylinski at intel.com>>, Mark Washenberger <mark.washenberger at markwash.net<mailto:mark.washenberger at markwash.net>>, Arnaud Legendre <arnaudleg at gmail.com<mailto:arnaudleg at gmail.com>>
Subject: Documentation for new Glance Metadata Definition Catalog

Hello Anne,

We will be landing a major new feature in Glance in Juno.  We would like to ensure that we get the OpenStack manual documentation updated with information about it in the appropriate guides.  We can contribute documentation, but we are not sure if you need a single blueprint for each guide or if we can just register a single blueprint and then update all guides. We hope that it isn't too late for us to contribute updates.

The feature is this one:  https://github.com/openstack/glance-specs/blob/master/specs/juno/metadata-schema-catalog.rst

Thank you!
Travis



--------------------------------------------------------------------

Intel Technology Poland sp. z o.o.
ul. Slowackiego 173 | 80-298 Gdansk | Sad Rejonowy Gdansk Polnoc | VII Wydzial Gospodarczy Krajowego Rejestru Sadowego - KRS 101882 | NIP 957-07-52-316 | Kapital zakladowy 200.000 PLN.

Ta wiadomosc wraz z zalacznikami jest przeznaczona dla okreslonego adresata i moze zawierac informacje poufne. W razie przypadkowego otrzymania tej wiadomosci, prosimy o powiadomienie nadawcy oraz trwale jej usuniecie; jakiekolwiek
przegladanie lub rozpowszechnianie jest zabronione.
This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). If you are not the intended recipient, please contact the sender and delete all copies; any review or distribution by
others is strictly prohibited.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140821/80bd0345/attachment.html>


More information about the Openstack-docs mailing list