Commit Graph

9 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
Jenkins 74a3d147e3 Merge "Correct url in doc source" 2016-12-27 09:44:11 +00:00
Li Wei ce3e7b33a8 Correct url in doc source
From github to see, these links can not be opened, like
https://github.com/openstack/glance/blob/master/doc/source/architecture.rst
we should add . in front. there are four *.png in /doc/source/images/...
corresponding to the four *.rst.

Change-Id: I21af59dfd87872e02cff8dddb51d2f2b72e86082
2016-10-27 17:03:38 +08:00
Alexander Bashmakov eb7507ac93 Update description of image_destroy method.
Trivial doc fix.

Change-Id: I2a44034c2d6ac09b9e6bb54db9a1b227e8f0c37d
2016-09-16 13:02:31 -07:00
Alexander Bashmakov e81229b92a Correcting description of image_update API method.
Currently, the description refers to the method returning:
    "a dictionary representation of a newly created *Image* object"
This is probably copy-pasted from image_create.
Updated database_architecture.rst to say:
    "a dictionary representation of the updated *Image* object"

Change-Id: Ie3101fa6c17bd6c62958543c327964c9e85f428a
2016-07-25 14:24:38 +00:00
Mike Turvey 1bea843152 Adding detailed alt text to images for accessibility
In order to accomodate developers with screen readers, alt text
has been modified to provide an accurate and full description of
the diagrams in the documentation. Screen readers use the
alt text as a description of an image.

Change-Id: I6343c6d9d980331ef2b0f4f23b1fa2d37b0ba602
Closes-Bug: 1432214
2016-04-13 16:31:23 -07:00
Daniel Krook 0ab3ced922 Updated the wording in the database architecture docs.
Change-Id: Ie4f6a7076f8a06970fbe846b9aaa0e544f528aa5
2016-03-09 15:57:56 -05:00
Cory Benfield b45bd50265 Use stevedore directive to document plugins.
Add directives to the documentation to bring in docstrings from the
plugins used by glance.

Change-Id: I06df808446c749588b719001e172721db6d43660
2015-08-27 13:48:32 +01:00
Olena Logvinova 351e5f1ad7 Glance database architecture section
Adds a database architecture description section
to the Glance Developer guide.

Change-Id: Ice951ecc344a1172d5bffc4f5d0dc329b75e9483
Co-Authored-By: Mike Fedosin <mfedosin@mirantis.com>
Co-Authored-By: Olena Logvinova <ologvinova@mirantis.com>
2015-04-17 19:39:10 +03:00