[
http://jira.jboss.com/jira/browse/JBCACHE-764?page=comments#action_12347331 ]
Manik Surtani commented on JBCACHE-764:
---------------------------------------
We should re-structure JBC docs as well, possibly follow the excellent layout that is used
by Hibernate.
Perhaps something like:
Chapter 1: JBoss Cache overview
* Summary of features
* Getting started quickly - very simple programmatic use
* Why use JBoss Cache
* Typical uses
* PojoCache and link to separate docs
Chapter 2: Configuring JBoss Cache
* Via XML
* Programmatically, using Pojos
Chapter 3: Deploying JBoss Cache
* Via JNDI
* Via JMX
* In JBoss AS 5's MC
* Gathering runtime information
--- specialist topics ---
Chapter 4: Architecture
* Interceptor structure
* Listeners
* Managers (RegionManager, RpcManager, BuddyManager, CacheLoaderManager, etc)
* InvocationContexts and MethodCalls
* Dependent libraries and how these are used (esp. JGroups)
* Marshalling
Chapter 5: Replication
* REPL_SYNC, ASYNC
* Invalidation
* Buddy Replication
* Marshalling & class loading, regions
* State transfer
* Version interoperability
Chapter 6: Cache loading
* Why use cache loaders?
* Config options (async, singleton, shared)
* Shipped loaders
* Writing your own loader
Chapter 7: Eviction
* Why eviction?
* Regions
* Configuring eviction
* Shipped policies
* Writing your own policy
Chapter 8: Transactions and concurrency
--- summary ---
Chapter 9: Best practices and recommendations
Appendix A: List of all configuration options
Update docs, examples and tutorial to reflect 2.0.0 API
-------------------------------------------------------
Key: JBCACHE-764
URL:
http://jira.jboss.com/jira/browse/JBCACHE-764
Project: JBoss Cache
Issue Type: Task
Security Level: Public(Everyone can see)
Reporter: Manik Surtani
Assigned To: Manik Surtani
Fix For: 2.0.0.GA
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.jboss.com/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira