[jbosstools-issues] [JBoss JIRA] (JBDS-2818) Text in Early Access and Update page needs minor editing

[Michelle Murray (JIRA)]

    [ https://issues.jboss.org/browse/JBDS-2818?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12850700#comment-12850700 ] 

Michelle Murray commented on JBDS-2818:
---------------------------------------

For " you changed "installer" to "JBDS universal installer"": you previously just had "download the installer" and I thought this was confusing as in the previous step you were talking about JDK so I was trying to make it obvious it was about JBDS. And i was trying to keep it short by using JBDS - but you're right that that is a not allowed abbreviation. To resolve how about "Download the JBoss Developer Studio installer."

For terminal vs CLI: IBM writing style states do not use terminal where you mean CLI - "Terminal should only be used in mainframe context." And regarding Windows, IBM states "In docs for both Windows and other operating systems, use command line." And I used the word enter rather than type as it indicates that the text in the CLI should be followed by enter key. To resolve how about "To start the installer, double-click the installer file or open a command line and enter ... "

For adding Red Hat: As far as I can see I have only added Red Hat to headers or the title of the page, and when there was no page title I added it to the first sentence. I have even removed a couple of instances from other files where it wasn't needed. I did leave instances that were in links to product information or download pages to avoid confusing the user. I don't see that there is anything to resolve here. But feel free it add more info for clarity.
                
> Text in Early Access and Update page needs minor editing
> --------------------------------------------------------
>
>                 Key: JBDS-2818
>                 URL: https://issues.jboss.org/browse/JBDS-2818
>             Project: Developer Studio (JBoss Developer Studio)
>          Issue Type: Bug
>      Security Level: Public(Everyone can see) 
>          Components: documentation
>    Affects Versions: 7.0.1.GA
>            Reporter: Michelle Murray
>            Assignee: Nick Boldt
>             Fix For: 7.1.0.Beta1
>
>
> Both of these templates need the text modifying (to fit Red Hat writing style and 508 compliance):
> https://devstudio.jboss.com/updates/7.0/
> https://devstudio.jboss.com/earlyaccess/7.0.0.GA.html
> *Common text modifications:*
> * Section "Installation :: Core Tooling"
> {quote}
> 1. If not already installed, download and install Oracle JDK or OpenJDK 7 (or 6).
> 2. Download the JBDS universal installer from <link>.
> 3. To start the installer, double-click the installer file or in a CLI enter java -jar jbdevstudio-*.jar
> {quote}
> * Section "Looking for JBoss EAP ..."
> Logo has changed, now just logotype. Looking for link.
> *  Section "Getting Started Guide:"
> {quote}
> Adding *JBoss* EAP to JBDS
> {quote}
> *Early Access text modifications:*
> * Title should be "*Red Hat* JBoss Developer Studio ......"
> * Intro text
> {quote}
> We wish to give customers and users early access to *JBoss Developer Studio* so *that* we can make the next version of JBoss Developer Studio an even better environment for developing with and for Red Hat JBoss Middleware.
> {quote}
> *Updates text modifications*
> * Why do we have this text? I ask because, for example, in https://devstudio.jboss.com/updates/7.0/, on the right-hand side the "installer" link in installation step 2 takes you to https://devstudio.jboss.com/earlyaccess/7.0.0.GA.html where you can download what looks like the GA version without subscription or opting in to a trial. Also you can get JBDS BYOE without subscription or trial on Eclipse marketplace. Seems the text is outdated but I don't know all the ins and outs of JBDS marketing and alike - hence asking the question.
> {quote}
> If you do not already have a copy of JBoss Developer Studio, you can purchase a subscription or get a 
> 30-day Free Trial from here: https://access.redhat.com/downloads/.
> {quote}

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