[jbosstools-issues] [JBoss JIRA] (TOOLSDOC-378) Documentation on adding EAP to JBDS 7 is not as effective as documentation for JBDS 6

[Nick Boldt (JIRA)]

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

Nick Boldt commented on TOOLSDOC-378:
-------------------------------------

Re: anchor... as long as the #Section_Title anchor label matches the Section_Title.html page filename, I'm not concerned the appearance of content having moved. Then again, as long as the CONTENT is good (with screenshots and examples) then the URL is secondary. It was just something I noticed which seemed like a bug, not a feature. ;)

Currently, both the html and html-single content uses the same anchor / page title:

https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Developer_Studio/7.0/html/Getting_Started_Guide/Set_Up_a_Runtime_Server_Using_Server_Manager.html
  vs.
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

Perhaps [~rob.stryker] or [~maxandersen] have an opinion on the doc w.r.t runtime detection setup? I was simply noticing that the instructions varied between the Install and User guides and that it seemed the 6.0 doc was more complete (again, because of screenshots/examples, which you've noted are forthcoming).

                
> 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/6.0/html-single/Getting_Started_Guide/index.html#AddingJBossServer
> 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_Developer_Studio/7.0/html/Installation_Guide/Set_up_Automatic_Runtime_Detection.html
> 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_Developer_Studio/7.0/html-single/Getting_Started_Guide/index.html#Set_Up_a_Runtime_Server_Using_Server_Manager
> -----
> 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