Bug 1295598 - [Docs] [Self-Service] Check syntax and links
[Docs] [Self-Service] Check syntax and links
Product: Red Hat CloudForms Management Engine
Classification: Red Hat
Component: Documentation (Show other bugs)
Unspecified Unspecified
medium Severity medium
: GA
: 5.5.2
Assigned To: Shikha
Dayle Parker
Depends On:
Blocks: 1289516
  Show dependency treegraph
Reported: 2016-01-04 19:50 EST by Andrew Dahms
Modified: 2016-04-27 20:32 EDT (History)
4 users (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Last Closed: 2016-01-07 00:29:53 EST
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Attachments (Terms of Use)

  None (edit)
Description Andrew Dahms 2016-01-04 19:50:33 EST
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-04 21:48:40 EST
Assigning to Shikha for review.
Comment 2 Shikha 2016-01-06 10:24:10 EST
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.

Comment 3 Dayle Parker 2016-01-06 20:35:56 EST
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 00:29:53 EST
These changes are now live on the Customer Portal.


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