[jbosstools-issues] [JBoss JIRA] (TOOLSDOC-289) Adhering to Red Hat and IBM writing styles

Tue Oct 30 02:40:01 EDT 2012

Michelle Murray created TOOLSDOC-289:
----------------------------------------

             Summary: Adhering to Red Hat and IBM writing styles
                 Key: TOOLSDOC-289
                 URL: https://issues.jboss.org/browse/TOOLSDOC-289
             Project: Documentation for JBoss Tools and Developer Studio
          Issue Type: Bug
      Security Level: Public (Everyone can see)
          Components: Getting Started Guide
            Reporter: Michelle Murray
            Assignee: Isaac Rooskov

About: JBDS Getting Started Guide, 5.0.1

Issue: The following do not adhere to the Red Hat or IBM writing styles

[1.1,P2,L2] OS > operating system

[Table1.1,R4,C2] Web pages > web pages

[1.2,P3,L1] just > omit

[3.1.1,P1,L1] you should follow > follow

[3.1.1,B3,L1] Please > omit

[3.1.1,B3,L2] you've > you have

[3.1.1,Note,L3] i.e. > that is

[3.2.2,B2] in a terminal window > on the command line

[3.2.2] you launch JBoss > you start JBoss

[4.2.1,Operating System] reports the Operating System > operating system

[4.2.1,Linux distribution version] as the Operating System > operating system

[5.1,After Fig5.6, P1, L1] go to Section > see Section

[5.2,After Fig5.14,P1,L2] A screen will then appear > A window will then open

[5.2,After Fig5.19,P1,L2] button that appears. > button in the window that opens. 

[7.1,After Fig7.3] should now appear > should now be visible

[7.2,B1] right click > right-click the server's name

[7.3,P1,L1] right click > right-click

[7.3,P1,L1] press Stop. > select Stop.

[9,P1,L1] you'll > you will

[9,P2,L1] We'll assume that > It will be assumed that 

[9.1,P1,L1] i.e. > that is

[9.1,P1,L2] Thus this section will perform you all necessary steps on how to do this. > omit?

[9.1,After Fig9.1] should appear > should be visible

[9.2,B1] Right click > Right-click

[9.2.1,P1,L1] Let's now make a little change so that a JSP page displays “Hello World!” message. > To edit the JSP page so that it displays the “Hello World!” message, insert the following line inside the <body> </body> tags: ...

[9.2.2,After Fig9.6,P1,L1] Let's add > To add ...:

[9.2.3.1,After Fig9.7] Right click > Right-click

[9.2.3.1,After Fig9.7] select New Archive -> JAR

[9.2.4,B1] e.g. > For example, insert this piece of code

[9.2.5,B2] right click > right-click

[9.2.5,B2] haven't > have not

--
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