[jbosstools-issues] [JBoss JIRA] (TOOLSDOC-290) Adhering to Red Hat writing style by correcting the titles of admonitions

[Michelle Murray (JIRA)]

Michelle Murray created TOOLSDOC-290:
----------------------------------------

             Summary: Adhering to Red Hat writing style by correcting the titles of admonitions
                 Key: TOOLSDOC-290
                 URL: https://issues.jboss.org/browse/TOOLSDOC-290
             Project: Documentation for JBoss Tools and Developer Studio
          Issue Type: Bug
      Security Level: Public (Everyone can see)
          Components: Getting Started Guide
    Affects Versions: 4.0.0.CR1
            Reporter: Michelle Murray
            Assignee: Isaac Rooskov


About: JBDS Getting Started Guide, 5.0.1, titles of admonitions

Issue: Red Hat Writing Style Guide states "Admonitions automatically include a suitable title according to the type of admonition. Do not use a phrase or anything else for the title."

[3.2.2] 'Tip' title should read 'Note'
[1.2, 3.1.1, 3.1.1.1] 'Note:' needs the colon removed

Workaround: Need to remove the titles from all admonitions in the .xml files. The correct name for the admonition will be automatically added by both publican and maven document builds.



--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira