suggestions re OpenStack Object Storage Developer Manual
Bug #854159 reported by
Rose Coste
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
openstack-manuals |
Fix Released
|
Low
|
Razique Mahroua |
Bug Description
(the Admin book tries & fails to use Disqus; the Dev book doesn't try, or i'd use that rather than launchpad for this)
improve readability by marking literals as <code></code>: glance-api.conf glance-
What is a Glance Registry and who is its owner?
Link to the intended target or at least give its name instead of "see the next chapter"
tags: | added: docblitz documentation |
Changed in openstack-manuals: | |
assignee: | nobody → Razique Mahroua (razique) |
status: | New → Fix Committed |
Changed in openstack-manuals: | |
importance: | Undecided → Low |
tags: | added: object-api |
Changed in openstack-manuals: | |
status: | Fix Committed → Fix Released |
To post a comment you must log in.
in http:// docs.openstack. org/docblitz/ openstack- image-service/ developer/ content/ the-glance- rest-api. html
This section says RESTful; Intended Audience section says ReSTful; choose.
"metadata about both X and Y", not "both metadata about X and Y"
in http:// docs.openstack. org/docblitz/ openstack- image-service/ developer/ content/ requesting- detailed- metadata- on-public- vm-images. html
public is italicized here. what does that mean? how does public relate to available?
why is text below the code sample in a grey box like the code sample?
samples aren't numbered, no List of Samples
in http:// docs.openstack. org/docblitz/ openstack- image-service/ developer/ content/ filtering- images- returned- via-get- images- and-get- imagesdetail. html
these look like the same attributes as in the preceding section's sample, but they are shaped like XML although the sample is shaped like JSON. these explanatory notes could be tied to callouts laid over the code sample, merging these 2 sections
http:// docs.openstack. org/docblitz/ openstack- image-service/ developer/ content/ requesting- detailed- metadata- on-a-specific- image.html
This should be at least 3 sentences: meta-updated_ at` timestamp is the timestamp when an image's metadata was last updated, not its image data, as all image data is immutable once stored in Glance There may be multiple headers that begin with the prefix `x-image- meta-property- `.
All timestamps returned are in UTC The `x-image-