Commit Graph

6 Commits

Author SHA1 Message Date
Doug Hellmann 1c7f556d4f rearrange existing documentation to follow the new layout standard
This change moves existing files, updates a few of the cross-references
and paths, and fixes some formatting. It is not meant to be the final
word on how the main page looks or how the other files are organized,
but it gets everything roughly into shape. If the glance team wants to
make changes, please do those as follow-up patches

This change depends on the spec and on a feature of pbr that allows us
to move where the auto-generated class reference documentation ends up
in the tree.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Change-Id: I9dde267793a5913acb5b1ec028cfb66bc5189783
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-21 14:15:58 -04:00
Travis Tripp 5829139ccf Fix use of etc. in metadefs docs.
OpenStack house style is no Latin, which includes "etc.".
This fixes the usage in the metadefs documentation.

Change-Id: Ic88bd2a9286b2647a927f2fb8ecdec480053a91c
Closes-Bug: 1610311
2016-08-05 16:42:20 -06:00
Travis Tripp 33ae05ee86 Change Metadefs OS::Nova::Instance to OS::Nova::Server
The metadata definitions in etc/metadefs allow each namespace to be associated
with a resource type in OpenStack. Now that Horizon is supporting adding
metadata to instances (just got in during the mitaka cycle - so unrealeased),
I realized that we used OS::Nova::Instance instead of OS::Nova::Server in
Glance. This doesn’t align with Heat [0] or Searchlight [1].

There are a couple of metadef files that have OS::Nova::Instance that need to
change to OS::Nova::Server. I see also that OS::Nova:Instance is in one of
the db scripts. That script simply adds some initial "resource types" to the
database. [3]. It should be noted that there is no hard dependency on that
resource type to be in the DB script. You can add new resource types at any
time via API or JSON files and they are automatically added.

I'm not sure if the change to the db script needs to be done in a different
patch or not, but that can easily be accommodated.

See bug for additional links.

Change-Id: I196ce1d9a62a61027ccd444b17a30b2c018d9c84
Closes-Bug: 1537903
2016-02-02 15:05:22 -07:00
Doug Hellmann 87ad0a4927 escape underline introducing a spurrious link reference
Change-Id: I2037fb76dc5143784df0e187038eb868f8083760
2015-10-01 15:46:19 +00:00
venkatamahesh 40277b7b59 Corrected hyperlink in metadefs documentation
Updated the reference to the Nova "Virt driver guest
vCPU topology configuration" spec to its current
location among the implemented Juno specs.


Change-Id: I4832a73444a6372c0ecede11fa437f14c90fc76a
Closes-Bug: #1488924
2015-09-09 13:22:55 +00:00
Travis Tripp 0aab5e2716 Include Metadata Defs Concepts in Dev Docs
The http://docs.openstack.org/developer/glance/
site currently doesn't include the Juno Metadata
Definitions concepts.  This patch adds
an overview of the concepts to this site.

This provides a synopis of the concepts in:
https://github.com/openstack/glance-specs/blob/master/specs/juno/metadata-schema-catalog.rst

DocImpact
Closes-Bug: 1367432
Related-Bug: 1367908
Related-Bug: 1363615
Related-Bug: 1366286
Related-Bug: 1363383
Change-Id: Iad4d388cbbf2f63fa243d04d35032de0cb0bc1b4
2014-09-29 15:49:41 -06:00