Small fixes to clean up Image admin guide
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://
http://
Add period (.) after last word in section "readonly".
http://
Please provide actual links to the "Architecture section" and the "Registries section".
http://
Use "..., follow the instructions in the section that applies to your environment."
http://
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://
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://
Use "..., follow the instructions in this section."
http://
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://
Rather than use quotations in the text, I would use the code font to mark the URI components.
http://
Quotation marks around "registries" should be double quotation marks rather than back quotes.
Provide actual link rather than using "section about Controlling Servers".
http://
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://
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://
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, ..."
Changed in openstack-manuals: | |
importance: | Undecided → Low |
status: | New → Confirmed |
Changed in openstack-manuals: | |
assignee: | nobody → Anne Gentle (annegentle) |
This guide is now folded into the Compute Admin manual.