Bug 1295598 - [Docs] [Self-Service] Check syntax and links
Summary: [Docs] [Self-Service] 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: Dayle Parker
URL:
Whiteboard:
Depends On:
Blocks: 1289516
TreeView+ depends on / blocked
 
Reported: 2016-01-05 00:50 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-07 05:29:53 UTC
Category: ---
Cloudforms Team: ---
Target Upstream Version:

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

Description Andrew Dahms 2016-01-05 00:50:33 UTC 
The Introduction to the Self-Service Portal 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-05 02:48:40 UTC 
Assigning to Shikha for review.
Comment 2 Shikha 2016-01-06 15:24:10 UTC 
Hi Andrew,
I have reviewed and updated the syntax and links for the Introduction to the Self-Service Portal guide.
Dayle, please review the merge request.
https://gitlab.cee.redhat.com/rhci-documentation/docs-Red_Hat_CloudForms/merge_requests/106

Regards,
Shikha
Comment 3 Dayle Parker 2016-01-07 01:35:56 UTC 
I've added a little bit of extra markup to GUI labels that were previously unlabelled, after checking the content against the self-service portal test instance. 

Other than that, the guide looks good and everything from Comment 0 has been addressed -- merged in Gitlab.
Comment 4 Andrew Dahms 2016-01-07 05:29:53 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.