Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1058952

Summary: REST API Guide has curl commands that aren't in code blocks
Product: Red Hat Enterprise Virtualization Manager Reporter: Matt Reid <mreid>
Component: DocumentationAssignee: Dan Macpherson <dmacpher>
Status: CLOSED WONTFIX QA Contact: ecs-bugs
Severity: medium Docs Contact:
Priority: unspecified    
Version: 3.5.0CC: aburden, acathrow, gklein, jbiddle, juwu, sclark, yeylon, ykatabam, zdover
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-07-14 15:36:47 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1099562    
Attachments:
Description Flags
Section 2 curl commands look as I expect
none
Section 3 curl commands are formatted differently none

Description Matt Reid 2014-01-28 20:08:35 UTC 
Description of problem:
The REST API Guide starts off displaying curl commands as I expect, offsetting them in code blocks (or whatever it is that they're called), rather than having them sit normally in the document (see Section 2 for examples). 

When you get to section 3, however, the curl commands are in the normal flow of the document, bolded, but not in code blocks anymore. When I was referred to this document yesterday, I initially scanned right over the command, because I had always seen terminal commands offset and treated differently than body text. It took me a bit to realize the command they were talking about was right there in front of me.

Maybe it's not a hard rule that it be displayed like in Section 2, but that's what I've been accustomed to.

Version-Release number of selected component (if applicable):
https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.0/html-single/REST_API_Guide/index.html

Additional info:
Comment 1 Matt Reid 2014-01-28 20:09:14 UTC 
Created attachment 856819 [details]
Section 2 curl commands look as I expect
Comment 2 Matt Reid 2014-01-28 20:09:44 UTC 
Created attachment 856820 [details]
Section 3 curl commands are formatted differently
Comment 7 Jodi Biddle 2014-07-14 15:36:47 UTC 
While what Zac describes is possible, it represents a significant amount of time to fix a guide that we no longer support by a handful of releases now, for what is essentially a cosmetic change. I'm making the executive decision to say "close-wontfix" on this one, and I hope you'll turn your eagle eye to the 3.4 technical docs instead :)
Comment 8 Matt Reid 2014-07-14 21:05:18 UTC 
That's fair, we ran into an error complaining about the REST API at one point during our install of RHEV, and ended up looking at this guide, since it was the only thing that looked like a good source for REST info (it's got REST in the name!). I thought at the time perhaps that the API hadn't changed since the 3.x major release, and was still valid. I guess the guide has been deprecated and the new content pulled into an Admin/Developer/Technical guide though?

Thanks for digging into it though Zac and everyone else!