Bug 1295611 - [Docs] [Satellite] Check Syntax and Links
Summary: [Docs] [Satellite] 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.5.2
Assignee: Shikha
QA Contact: Suyog Sainkar
URL:
Whiteboard:
Depends On:
Blocks: 1289516
TreeView+ depends on / blocked
 
Reported: 2016-01-05 02:34 UTC by Andrew Dahms
Modified: 2016-04-28 00:32 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-01-28 09:14:43 UTC
Category: ---
Cloudforms Team: ---
Target Upstream Version:

Attachments (Terms of Use)
Add an attachment (proposed patch, testcase, etc.)

Description Andrew Dahms 2016-01-05 02:34:01 UTC 
The Integration with Red Hat Satellite 6 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-01-13 04:24:52 UTC 
Assigning to Shikha for review.
Comment 2 Shikha 2016-01-14 06:28:14 UTC 
Hi Andrew,

I have reviewed and updated syntax for the Integration with Red Hat Satellite 6 guide.

Merge Request:
https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_CloudForms/merge_requests/111

Suyog,
Please review and accept the merge request.

Regards,
Shikha
Comment 4 Andrew Dahms 2016-01-28 09:14:43 UTC 
These changes are now live on the Customer Portal.

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