Bug 1289524

Summary:	[Docs] [Release Notes] Check syntax and links
Product:	Red Hat CloudForms Management Engine	Reporter:	Andrew Dahms <adahms>
Component:	Documentation	Assignee:	Shikha <snansi>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Dayle Parker <dayleparker>
Severity:	medium	Docs Contact:
Priority:	medium
Version:	5.5.0	CC:	dayleparker, jhardy, mfeifer, obarenbo
Target Milestone:	GA
Target Release:	5.5.1
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-01-07 06:49:01 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 2015-12-08 11:49:00 UTC

The Release Notes 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 1 Andrew Dahms 2015-12-08 11:56:39 UTC

Assigning to Shikha for review.

Comment 2 Shikha 2015-12-15 02:35:51 UTC

Hi Andrew,
I have reviewed the Release Notes guide and created merge request:
https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_CloudForms/merge_requests/97

Dayle, please review the merge request.

Regards,
Shikha

Comment 3 Dayle Parker 2016-01-07 06:06:05 UTC

Changes look good - thanks Shikha! I added the :experimental: line to master.adoc so the menu: tag renders.

Merged commit into master.

Comment 4 Andrew Dahms 2016-01-07 06:49:01 UTC

This content is now live on the Customer Portal.

Closing.