[jbosstools-issues] [JBoss JIRA] Commented: (JBDS-907) Guides restructuring

[OLga Chikvina (JIRA)]

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

OLga Chikvina commented on JBDS-907:
------------------------------------

My suggestions about "JBoss Server Manager Reference Guide":
   - Rename the guide to "JBoss AS and Archive Tools User Guide" as it contains not only the reference information.
   - Move the "Other relevant resources on the topic" to the end of the document.
   - On the whole, I propose the next structure of the guide:
          1. JBoss AS and Archive Tools Overview
             1.2. Key Features of JBoss AS and Archive Tools
             1.3. Requerements and Installation
          2. Quick Start
             2.1. Starting JBoss Server
             2.2. Deploying Application to JBoss Server
             2.3. Publishing to JBoss Server
             2.4. Project Archiving
             2.5. Stopping JBoss Server
          3. Reference
             [ Put all ref information here ]
          4. Summary
             4.1. Other relevant resources on the topic

We can work out the uniqe structure by the example of this guide and apply it to the others.

> Guides restructuring 
> ---------------------
>
>                 Key: JBDS-907
>                 URL: https://jira.jboss.org/jira/browse/JBDS-907
>             Project: JBoss Developer Studio
>          Issue Type: Task
>          Components: documentation
>    Affects Versions: 2.1.0
>            Reporter: Svetlana mukhina
>            Assignee: Michael Sorokin
>             Fix For: 2.1.0-doc
>
>   Original Estimate: 1 week
>  Remaining Estimate: 1 week
>
> New, more convenient and informative guides structure should be worked out.
> As an example you can use Dali Documentation - e.g. http://help.eclipse.org/help33/index.jsp?topic=/org.eclipse.jpt.doc.user/reference017.htm - Dali Java Persistence Tools User Guide

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira