Commit Graph

17 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 83d133765e Correctly point to Task Statuses from Tasks doc.
This is a doc improvement to point the Task Statuses link in
tasks.html to the correct 'Task Statuses' section inside
status.html. Currently, this link points to the 'Image Statuses'
section instead of 'Task Statuses'. This patch addresses that.

Change-Id: Iaf877a48f92aec9e789809fb5f4b9be0ca0e23cf
Closes-Bug: 1622779
2016-09-12 16:40:34 -07:00
Jenkins 4742773a58 Merge "Adding detailed alt text to images for accessibility" 2016-04-18 12:34:42 +00:00
Sachin Patil 50b0252a25 Corrected section underline
Section underline must be at least as long as the title text

Change-Id: I13f5398bb564c91af6c721c699a5552f2a07e561
2016-04-15 11:40:59 +05:30
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
Sabari Kumar Murugesan 93b81315c6 Remove state transition from active to queued
After commit Ieb03aaba887492819f9c58aa67f7acfcea81720e it is no
longer necessary to maintain a state transition from ACTIVE to
QUEUED. The only time this happened was when someone removed
the last location from an image. Since this was removed we
don't need it anymore.

Also, updates the image state transition images and docs to
represent the current state transitions.

Closes-Bug: #1555448

Change-Id: I390ae2a7110f06046f38914e946139b3b729bd2d
2016-03-10 06:22:11 +00:00
Olena Logvinova 0142e27e91 [docs] Adds new image status - deactivated
This patch:

* adds a description of deactivated image status to
  http://docs.openstack.org/developer/glance/statuses.html
* updates the image with statuses on the same page.

Co-Authored-By: Mike Fedosin <mfedosin@mirantis.com>
Co-Authored-By: Olena Logvinova <ologvinova@mirantis.com>

Change-Id: Ic8aadd03b5d28744b8995701fe584e2647077b0b
Closes-Bug: #1503187
2015-10-14 14:11:42 +00:00
Fei Long Wang 47ee547018 Fix document issue of image recover status
Based on current implementation, image in pending_delete
status can't be recovered. This patch will fix the
document issue.

Change-Id: If4fe75cfb759ae0288f378cee77a71be4a306456
2015-01-05 15:41:36 +13:00
Nikhil Komawar 97a8fe7352 Documentation for Glance tasks
Added some docs for:-
    - configuration
    - notifications
    - statuses

partially implements blueprint async-glance-workers

Change-Id: I4e33bc3be2278d6906968d1dac3aff6587eef6df
2014-03-02 16:35:01 -06:00
Nassim Babaci 70d2c8c2d8 fix comments and docstrings misspelled words
Change-Id: I355b6fedf372b1273ceaebe22e8e890aa9c913c9
Closes-bug: #1267103
2014-01-08 17:03:44 +01:00
Fei Long Wang 5ebf2e0b9b Adding an image status transition diagram for dev doc
Now there is no image status transition diagram in the dev
doc, this patch will add one and keep the image source as
a dot file so that it can be updated easily in the future.
See http://www.graphviz.org to get more info about .dot file.

Fixes bug 1244995

Change-Id: I076c461f688be93eab8d3d1fa541990d7b79da5e
2013-11-25 13:13:56 +08:00
annegentle a2b9bed75d Updates OpenStack LLC with OpenStack Foundation
Patchset addresses reviewer's comments, rebase against master,
and follows new guidance from Foundation:
http://wiki.openstack.org/Documentation/Copyright

Change-Id: I94367461505778973528eb8835d991f4fb796dab
2013-02-17 19:19:43 -08:00
Eoghan Glynn 6873195cd1 Support zero-size image creation via the v1 API
Addresses LP 1025353 for the v1 API.

Transition image status to active immediately on creation
(as opposed to leaving it queued forever) if the size is set
to zero from the get-go.

The v2 implementation is left unchanged for now, as the image
status does not appear to ever transition from queued to active
in that case.

This change allows an image to be created that simply acts as
a properties bucket, but requires no image data. For example,
an image created from a booted-from-volume instance where only
the kernel, ramdisk ID, and block device mappings are required.

Change-Id: I61e96f3fe5f5245fec791170b4a8b4c72135c3de
2012-07-16 17:29:43 +01:00
Brian Waldon ee8c8ba8f5 Updating image status docs
Fixes lp bug#844932

Change-Id: Iee4571a2ebdd295f4324e02cde65a96fb53aceb9
2011-09-12 20:50:47 -04:00
jaypipes@gmail.com 14cc5df1cc Cleanup of RST documentation and addition of docs on an image's status 2011-01-17 13:09:14 -05:00