Bug 1295616

Summary:	[Docs] [REST] Check Syntax and Links
Product:	Red Hat CloudForms Management Engine	Reporter:	Andrew Dahms <adahms>
Component:	Documentation	Assignee:	Shikha <snansi>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Suyog Sainkar <ssainkar>
Severity:	medium	Docs Contact:
Priority:	medium
Version:	5.5.0	CC:	adahms, jhardy, mfeifer, obarenbo, snansi, ssainkar
Target Milestone:	GA
Target Release:	5.5.2
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:	doc
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-03-10 02:11:54 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:	1289516

Description Andrew Dahms 2016-01-05 02:38:30 UTC

The Red Hat CloudForms REST API guide must be reviewed to standardize use of AsciiDoc syntax and to update links to other guides in the Red Hat CloudForms documentation suite.

This includes the following items -

* Remove any procedure titles
* Remove any 'Result::' blocks
* Use 'btn:[Button Name]' for buttons
* Use +Text+ for labels and replaceables
* Ensure delimiters (e.g. ======) are six characters long
* Update links to other guides in the suite to use the correct title and
  section name

Comment 2 Andrew Dahms 2016-02-24 04:32:48 UTC

Hi Shikha,

Thank you for the needinfo request.

Assigning Suyog as the QA contact. Suyog - would you be able to take a look at the changes for this bug?

Kind regards,

Andrew

Comment 4 Andrew Dahms 2016-03-10 02:11:54 UTC

This content is now live on the Customer Portal.

Closing.