[JBoss JIRA] (TOOLSDOC-378) Documentation on adding EAP to JBDS 7 is not as effective as documentation for JBDS 6
by Michelle Murray (JIRA)
[ https://issues.jboss.org/browse/TOOLSDOC-378?page=com.atlassian.jira.plug... ]
Michelle Murray commented on TOOLSDOC-378:
------------------------------------------
Regarding ensuring matching anchors and section titles:
This was something that I thought was automatic and that I couldn't change. But now I know that I can make sections and anchors match and I will endeavour to do it as part of the pre-release checklist. Given that docs for 7.0 have only just been released, mismatching anchors have been fixed as part of tech review (TOOLSDOC-379).
> Documentation on adding EAP to JBDS 7 is not as effective as documentation for JBDS 6
> -------------------------------------------------------------------------------------
>
> Key: TOOLSDOC-378
> URL: https://issues.jboss.org/browse/TOOLSDOC-378
> Project: Documentation for JBoss Tools and Developer Studio
> Issue Type: Bug
> Security Level: Public(Everyone can see)
> Components: Getting Started Guide, Installation Guide
> Affects Versions: 4.1.0
> Reporter: Nick Boldt
> Assignee: Michelle Murray
>
> For JBDS 6 we had this, complete with screenshots and example content:
> https://access.redhat.com/site/documentation/en-US/JBoss_Developer_Studio...
> Now, we have this:
> {code:title=https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Developer_Studio/7.0/html-single/Getting_Started_Guide/index.html#Set_Up_a_Runtime_Server_Using_Server_Manager}
> 5.2. Set Up a Server Using Runtime Detection
> Servers can be set up from within the Java EE Web Project wizard. But for the purposes of exploring JBoss Developer Studio the procedure below sets up the server first.
> Procedure 5.2. Set Up a Server Using Runtime Detection
> Click Window→Preferences, expand JBoss Tools and select JBoss Tools Runtime Detection.
> Click Add.
> Select the directory containing the JBoss Enterprise Application Platform 6.0 or JBoss Enterprise Application Platform 6.1 installation and click OK. The directory is now scanned for application servers and JBoss Enterprise Application Platform 6.x found.
> To create a server for JBoss Enterprise Application Platform 6.x, ensure the jboss-eap-6.x check box is selected and click OK.
> Click Apply and click OK to close the Preferences window. The server is listed in the Servers tab.
> The server is initially shown in stopped mode. To start the server, right-click jboss-eap-6.x and click Start. After a short pause, the view switches to the Console tab and shows the startup output of the server.
> {code}
> AND we have this, which is more verbose but fails to mention any EAP 6.x specific examples.
> https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Develope...
> Additionally, the html anchor "Set_Up_a_Runtime_Server_Using_Server_Manager" for "5.2 Set Up a Server Using Runtime Detection" doesn't match the content.
> https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Develope...
> -----
> Could the content in both places be updated/merged to equally complete, and could screenshots be added too?
--
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
12 years, 8 months
[JBoss JIRA] (TOOLSDOC-384) Technical Review of 7.0 User Guide
by Michelle Murray (JIRA)
Michelle Murray created TOOLSDOC-384:
----------------------------------------
Summary: Technical Review of 7.0 User Guide
Key: TOOLSDOC-384
URL: https://issues.jboss.org/browse/TOOLSDOC-384
Project: Documentation for JBoss Tools and Developer Studio
Issue Type: Sub-task
Security Level: Public (Everyone can see)
Components: User Guide
Affects Versions: 4.1.0
Reporter: Michelle Murray
Assignee: Michelle Murray
Fix For: 4.1.0
Conduct a post release technical review of 7.0 User Guide to catch any previously missed technical or copy errors.
--
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
12 years, 8 months
[JBoss JIRA] (TOOLSDOC-383) Technical Review of 7.0 Migration Guide
by Michelle Murray (JIRA)
[ https://issues.jboss.org/browse/TOOLSDOC-383?page=com.atlassian.jira.plug... ]
Michelle Murray commented on TOOLSDOC-383:
------------------------------------------
Anchors fixed:
* 3.1. Change the Version of Eclipse Being Used with JBoss Developer Studio BYOE
* 3.2. Change the Path of the JVM used to Run JBoss Developer Studio
> Technical Review of 7.0 Migration Guide
> ---------------------------------------
>
> Key: TOOLSDOC-383
> URL: https://issues.jboss.org/browse/TOOLSDOC-383
> Project: Documentation for JBoss Tools and Developer Studio
> Issue Type: Sub-task
> Security Level: Public(Everyone can see)
> Components: Migration Guide
> Affects Versions: 4.1.0
> Reporter: Michelle Murray
> Assignee: Michelle Murray
> Fix For: 4.1.0
>
>
> Conduct a post release technical review of 7.0 Migration Guide to catch any previously missed technical or copy errors.
--
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
12 years, 8 months
[JBoss JIRA] (TOOLSDOC-383) Technical Review of 7.0 Migration Guide
by Michelle Murray (JIRA)
[ https://issues.jboss.org/browse/TOOLSDOC-383?page=com.atlassian.jira.plug... ]
Michelle Murray commented on TOOLSDOC-383:
------------------------------------------
Typos fixed:
* 3.1 Change the Version of Eclipse Being Used with JBDS BYOE = JBoss Developer Studio *7* BYOE supports Eclipse Kepler only. (> 7.0)
And: updated table 3.1
* 3.2 Change the Path of the JRE used to Run JBDS = JBoss Developer Studio stores the *Java runtime environment (JRE) path* selected during the installation process. (> JVM path of the Java developer kit)
And: If you change the JRE path, JBoss Developer Studio *will fail* to start. (> fails)
And: Open the* JBDS_installation_directory*/studio/jbdevstudio.ini file with a text editor. (> path/to/JBoss Developer Studio)
> Technical Review of 7.0 Migration Guide
> ---------------------------------------
>
> Key: TOOLSDOC-383
> URL: https://issues.jboss.org/browse/TOOLSDOC-383
> Project: Documentation for JBoss Tools and Developer Studio
> Issue Type: Sub-task
> Security Level: Public(Everyone can see)
> Components: Migration Guide
> Affects Versions: 4.1.0
> Reporter: Michelle Murray
> Assignee: Michelle Murray
> Fix For: 4.1.0
>
>
> Conduct a post release technical review of 7.0 Migration Guide to catch any previously missed technical or copy errors.
--
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
12 years, 8 months