Bug 1295601

Summary:	[Docs] [Scripting] Check Syntax and Links
Product:	Red Hat CloudForms Management Engine	Reporter:	Andrew Dahms <adahms>
Component:	Documentation	Assignee:	Red Hat CloudForms Documentation <cloudforms-docs>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Dayle Parker <dayleparker>
Severity:	medium	Docs Contact:
Priority:	medium
Version:	5.5.0	CC:	adahms, dayleparker, jhardy, lbopf, mfeifer, obarenbo
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-05-26 02:13:35 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:
Bug Depends On:
Bug Blocks:	1289516

Description Andrew Dahms 2016-01-05 00:54:00 UTC

The Scripting Actions in CloudForms 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 1 Shikha 2016-03-01 05:56:28 UTC

Hi Andrew,
I have reviewed and updated the syntax for Scripting Actions in Cloudforms guide.
Following edits have been made:

* Remove any procedure titles
* Remove any 'Result::' blocks
* Use ** for buttons, labels, and replaceables
* Use `` for literals
* Ensure delimiters (e.g. ======) are six characters long
* Use menu tags wherever applicable
* Update links to other guides in the suite to use the correct title and
  section name

Please assign a QE to review the following changes and merge request:

Merge request: https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_CloudForms/merge_requests/128

Regards,
Shikha

Comment 2 Shikha 2016-03-31 06:32:02 UTC

Hi Dayle,
Please review the following merge request:
Merge request: https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_CloudForms/merge_requests/128
Regards,
Shikha

Comment 3 Lucy Bopf 2016-03-31 13:51:04 UTC

Hi Shikha,

Thank you for following up on the QA for this bug! I have reviewed the merge request, made one minor update, and merged the changes to master.

Moving this bug to VERIFIED.

Comment 5 Lucy Bopf 2016-05-26 02:13:35 UTC

These updates have been published, and the content is available at:

https://access.redhat.com/documentation/en/red-hat-cloudforms/version-4.1-beta/scripting-actions-in-cloudforms/

Moving to CLOSED.