Small fixes to clean up Image admin guide

Bug #925599 reported by Anne Gentle
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Low
Anne Gentle

Bug Description

These are all found in the DISQUS comments at: http://docs.openstack.org/docblitz/openstack-image-service/admin/content/ . Many of these are artifacts of an RST > docbook conversion, so the fixes are simple.

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/glance-api-server.html
Add period (.) after last word in section "readonly".

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/glance-registry-servers.html
Please provide actual links to the "Architecture section" and the "Registries section".

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/installing-from-packages.html
Use "..., follow the instructions in the section that applies to your environment."

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/debianubuntu.html
MA: Interestingly, the contents of this page are not being duplicated on this page, but starting with the next page, the duplication begins again. [It appears to me that this bug has now been fixed, MA, 2-2-2012]
AG: Yep, odd! I have a question into the Doc Tools team on this one, it's a weird one.
MA: I am seeing a strange character comprised of 4 dots (apparently representing a new-line character?) after each of the numbered list items and before the command on the command-line.
AG: Ah, that is a result of the rst2docbook conversion. I'll fix, thanks for the catch!

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/installing-from-source-tarballs.html
Same strange character (represented by 4 dots) after item #2 in the list and before the command on the command-line.

I suggest using a carriage return to split the one line into 2 command-lines for item #3.

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/installing-from-a-bazaar-branch.html
Use "..., follow the instructions in this section."

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/debianubuntu-1.html
Same strange character (4 dots) after numbered items. (I won't repeat this bug anymore.)

Also suggest splitting command-lines for #1 into 2 separate lines using a carriage return. (I won't repeat this bug anymore.)

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/image-identifiers.html
Rather than use quotations in the text, I would use the code font to mark the URI components.

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/image-registries.html
Quotation marks around "registries" should be double quotation marks rather than back quotes.

Provide actual link rather than using "section about Controlling Servers".

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/api-in-summary.html
In the other Rackspace API docs I am familiar with, we use a table for this info with 3 headers for the columns: Verb, URI, Description.

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/filtering-images-returned-via-get-images-and-get-imagesdetail.html
I would use italic font for the values of the query parameters rather than code font to show that they are variables to be supplied by the user.

I would also give an example of the URI showing some of the query parameters.

http://docs.openstack.org/docblitz/openstack-image-service/admin/content/post-images.html
On the third bullet in the list, fix typo: "... and must be one of ..."

On the fourth bullet, add or: "... is ari, aki, or ami, ..."

Anne Gentle (annegentle)
Changed in openstack-manuals:
importance: Undecided → Low
status: New → Confirmed
Anne Gentle (annegentle)
Changed in openstack-manuals:
assignee: nobody → Anne Gentle (annegentle)
Revision history for this message
Anne Gentle (annegentle) wrote :

This guide is now folded into the Compute Admin manual.

Changed in openstack-manuals:
status: Confirmed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.