[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=12792529#comment-12792529 ] 

Richard Achmatowicz edited comment on WFLY-1725 at 7/23/13 3:21 PM:
--------------------------------------------------------------------

I've had a further think about organization. Here is one possible view:

{noformat}
section list
------------
Wildfly High Availability Guide
 Introduction
 Changes since AS7
 Subsystem Reference
  JGroups Subsystem
  Infinispan Subsystem
  EJB Subsystem (already exists elsewhere in guide, just recap clustering related stuff)
  mod_cluster Subsystem
 Clustering Features Reference
  HTTP Services
   Clustered Web Sessions
   Clustered SSO
   Load Balancing
    Apache + mod_jk
    Apache + mod_cluster
  Clustered EJB
  Hibernate
Related Issues
 Modularity and Class loading

This somewhat tracks the organization of the old clustering guide.

subsystem content (jgroups, infinispan, ejb, mod_cluster)
-----------------
should answer the questions:
- what does the subsystem do?
- how to configure it?

example of content
- purpose of subsystem
- full configuration example + explanation of elements and attributes
- some key use cases (e.g. how to create a JGroups stack)

features content (HTTP sessions, clustered sso, load balancing, clustered ejb, hibernate)
----------------
should answer the questions:
- what does the (clustering) feature give us?
- how do we enable the features for our apps? (defaults for all apps, or settings per app)
- how can we tune the feature? (e.g. performance recommendations, special configuration requirements)

example of content
- could use a more prose like exposition of the feature, as Jaikiran does in the description of EJB features
where he works through a simple example and covers content as he goes along
OR
- descripion of feature X
- enabling of feature X
- tuning of feature X
{noformat}

                
      was (Author: rachmato):
    I've had a further think about organization. Here is one possible view:

section list
------------
Wildfly High Availability Guide
 Introduction
 Changes since AS7
 Subsystem Reference
  JGroups Subsystem
  Infinispan Subsystem
  EJB Subsystem (already exists elsewhere in guide, just recap clustering related stuff)
  mod_cluster Subsystem
 Clustering Features Reference
  HTTP Services
   Clustered Web Sessions
   Clustered SSO
   Load Balancing
    Apache + mod_jk
    Apache + mod_cluster
  Clustered EJB
  Hibernate
Related Issues
 Modularity and Class loading

This somewhat tracks the organization of the old clustering guide.

subsystem content (jgroups, infinispan, ejb, mod_cluster)
-----------------
should answer the questions:
- what does the subsystem do?
- how to configure it?

example of content
- purpose of subsystem
- full configuration example + explanation of elements and attributes
- some key use cases (e.g. how to create a JGroups stack)

features content (HTTP sessions, clustered sso, load balancing, clustered ejb, hibernate)
----------------
should answer the questions:
- what does the (clustering) feature give us?
- how do we enable the features for our apps? (defaults for all apps, or settings per app)
- how can we tune the feature? (e.g. performance recommendations, special configuration requirements)

example of content
- could use a more prose like exposition of the feature, as Jaikiran does in the description of EJB features
where he works through a simple example and covers content as he goes along
OR
- descripion of feature X
- enabling of feature X
- tuning of feature X


                  
> 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