[jboss-jira] [JBoss JIRA] (WFLY-1725) Update The Wildfly High Availability Guide

[Richard Achmatowicz (JIRA)]

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

Richard Achmatowicz edited comment on WFLY-1725 at 7/19/13 3:54 PM:
--------------------------------------------------------------------

I think the only thing we really need to agree on is what is in and what is not in with regard to content for the High Availability Guide. 

For example, in the EAP docs (https://access.redhat.com/site/documentation/JBoss_Enterprise_Application_Platform), the coverage of content is broken down into separate guides, and each guide has its own specific coverage:
* administration & configuration guide (starting/stopping/managing/deploying/configuring)
* api documentation (javadoc for all classes)
* development guide (key technologies: maven build/CDI/Hibernate/Web server/JTA/EJB/Clustering) 
* installation guide (download/install/start/stop/upgrade)
* migration guide (migrate app from 5.1 to 6/migration changes/debugging migration problems)
* security guide (everything about configuring security) 
Of course, we don't need this level of comprehensiveness in a project guide.


                
      was (Author: rachmato):
    I think the only thing we really need to agree on is what is in and what is not in with regard to content for the High Availability Guide. 

For example, in the EAP docs (https://access.redhat.com/site/documentation/JBoss_Enterprise_Application_Platform), the coverage of content is broken down into separate guides, and each guide has its own specific coverage:
* administration & configuration guide (starting/stopping/managing/deploying/configuring)
* api documentation (javadoc for all classes)
* development guide (key technologies: maven build/CDI/Hibernate/Web server/JTA/EJB/Clustering) 
* installation guide (download/install/start/stop/upgrade)
* migration guide (migrate app from 5.1 to 6/migration changes/debugging migration problems)
* security guide (everything about configuring security) 
Of course, we don't need this level of comprehensiveness.

My proposal would be like a section breakdown like this:
* introdction (brief overview of all features provided and how they relate to each other as a unified clustering subsystem)
* changes since AS7  (undertow, refactoring of apis/modules)
* individual subsystems and their configuration
** jgroups
** infinispan
** ejb
** undertow
** mod cluster
* functional areas (notes on configuring them, some developer related issues)
** web session clustering
** ejb clustering
** Hibernate 2LC
** load balancing
* modularity and class loading for app developers

                  
> Update The Wildfly High Availability Guide 
> -------------------------------------------
>
>                 Key: WFLY-1725
>                 URL: https://issues.jboss.org/browse/WFLY-1725
>             Project: WildFly
>          Issue Type: Bug
>          Components: Clustering
>    Affects Versions: 8.0.0.Alpha3
>            Reporter: Richard Achmatowicz
>            Assignee: Richard Achmatowicz
>             Fix For: 8.0.0.Beta1
>
>
> The main source of clustering-related documentation for a Wildfly user is the High Availability Guide in the Wildfly 8 documentation on docs.jboss.org.
> Update this document into a quality document which will aid the user's understanding of new features and configuration in Wildfly 8 clustering.

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