Bug 1295609 - [Docs] [AWS] Check Syntax and Links
Summary: [Docs] [AWS] Check Syntax and Links
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat CloudForms Management Engine
Classification: Red Hat
Component: Documentation
Version: 5.5.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: GA
: 5.6.0
Assignee: Red Hat CloudForms Documentation
QA Contact: Suyog Sainkar
URL:
Whiteboard: doc
Depends On:
Blocks: 1289516
TreeView+ depends on / blocked
 
Reported: 2016-01-05 02:29 UTC by Andrew Dahms
Modified: 2016-05-09 06:59 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-05-09 06:59:36 UTC
Category: ---
Cloudforms Team: ---
Target Upstream Version:


Attachments (Terms of Use)

Description Andrew Dahms 2016-01-05 02:29:36 UTC
The Integration with AWS CloudFormation and OpenStack Heat 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 Andrew Dahms 2016-02-24 04:34:29 UTC
Assigning Suyog as the QA contact.

Comment 2 Shikha 2016-02-24 06:04:37 UTC
Hi Andrew,
I have reviewed and updated the syntax for Integration with AWS 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

Hi Suyog,
Please review the following changes:

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

Regards,
Shikha

Comment 3 Lucy Bopf 2016-04-01 06:41:45 UTC
Hi Shikha,

Thank you for making these changes! I've now merged the updates to master.

Moving this bug to VERIFIED.

Comment 5 Lucy Bopf 2016-05-09 06:59:36 UTC
The updated documentation is now available at the following location:

https://access.redhat.com/documentation/en/red-hat-cloudforms/version-4.0/integration-with-aws-cloudformation-and-openstack-heat/

Closing.


Note You need to log in before you can comment on or make changes to this bug.