geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "wei zhang" <rebekah.zh...@gmail.com>
Subject Re: Documentation of new 2.2 features in current wiki?
Date Mon, 04 Aug 2008 07:44:50 GMT
Hi there,

This is Rebekah and I've been reading through the documentation with my
colleagues for a while. I think we can keep the current version of the
documentation and create another space for v2.2, because there will be users
who may want to track the previous information. Regarding the organization
of information, we have worked out new documentation structures based on the
2.1 info using two different appraches: one is pretty much book based,
keeping some of the current look&feel; the other is info center based. If we
are going to create a new space for v2.2, we can take either approach. As
long as the structure is ready, people can take topics they are interested
in and write up the content.

If you have any ideas or comments on the proposed structures, feel free to
let me know. Thanks.

Information center based approach (all in one): 0  Geronimo information
 1  What's new
  1.1  New features
   1.1.1  Custom server assemblies
   1.1.2  Geronimo administration console
   1.1.3  GShell
   1.1.4  Clustering
   1.1.5  Monitoring console plugin
   1.1.6  Plan Creator
  1.2  Enhanced features
   1.2.1  Geronimo distributions
   1.2.2  Configuration changes
  1.3  Compatibility with earlier versions
 2  Getting started with Apache Geronimo
  2.1  Getting the software
   2.1.1  Geronimo directory structure
  2.2  Starting the server
  2.3  Creating and deploying a sample application
 3  Planning and installing
  3.1  Installing prerequisite software
  3.2  Getting Geronimo
   3.2.1  Building Geronimo from source
    3.2.1.1  Building Geronimo with Maven
    3.2.1.2  Building Geronimo from Eclipse
  3.3  Installing Geronimo
   3.3.1  Installing Geronimo from binaries
  3.4  Initial configuration
   3.4.1  Available configuration files
   3.4.2  Changing the default port numbers
   3.4.3  Changing the username and password
  3.5  Starting and stopping the server
   3.5.1  Starting and Stopping Geronimo in GShell
  3.6  Running Geronimo as a non-root user
  3.7  Running multiple Geronimo instances
  3.8  Running Geronimo as a Windows, or UINX service
 4  Configuring and administering
  4.1  Deploying and and administering assets in Geronimo
   4.1.1  Deploying assets
    4.1.1.1  Deploying assets via the administration console
    4.1.1.2  Deploying assets from the command prompt
    4.1.1.3  Deploying assets via GShell
    4.1.1.4  Performing clustered deployment
    4.1.1.5  Deploying plugins
    4.1.1.6  Performing hot deployment
   4.1.2  Administering applications
    4.1.2.1  Installing and removing applications
    4.1.2.2  Starting and stopping application modules
  4.2  Configuring and administering the Apache Geronimo Server
   4.2.1  Administering Geronimo using the Geronimo administration console

   4.2.2  Administering Geronimo using command line tools
   4.2.3  Add new listeners for Web containers
   4.2.4  Aliasing modules
   4.2.5  Configuring virtual host
    4.2.5.1  Configuring virtual host in Jetty
    4.2.5.2  Configuring virtual host in Tomcat
   4.2.6  Configuring a remote Apache HTTP server
   4.2.7  Configuring JAX-WS engine
   4.2.8  Clustering
    4.2.8.1  Farming
    4.2.8.2  WADI clustering
   4.2.9  Custom server assemblies
    4.2.9.1  Plugin basics
    4.2.9.2  Buidling,installing plugins and extracting a server from an
exsiting server
    4.2.9.3  Assembling a server using Maven
  4.3  Congifuring services
   4.3.1  Configuring multiple repositories
   4.3.2  Adding archives to the Geronimo repository
   4.3.3  Configuring database pools
   4.3.4  Configuring JMS
  4.4  Administering security
   4.4.1  Basic Hints on Security Configuration
   4.4.2  Configuring JavaEE application client security
   4.4.3  Configuring login modules
   4.4.4  Configuring run-as and Default Subjects, and principal-role
mapping
   4.4.5  Administering certificates
   4.4.6  Administering users and groups
   4.4.7  Certification authority
   4.4.8  Adminstering security realms
    4.4.8.1  Certificate properties file realm
    4.4.8.2  Database (SQL) realm
    4.4.8.3  LDAP realm
  4.5  Configuring the transaction manager identity
  4.6  Creating an embedded database in Geronimo
  4.7  Monitoring the health of the Apache Geronimo server
   4.7.1  Configuring your own Monitoring Plugin DataSource
   4.7.2  Monitoring the status of the server using the Information portlet
in the Geronimo administration console
   4.7.3  Monitoring the performance of the server using the Monitoring
portlet in the Geronimo administration console
   4.7.4  Displaying JVM information
  4.8  Extensible Administration Console
   4.8.1  What is an Extensible Administration Console
   4.8.2  Planning and installing the Extensible Administration Console

    4.8.2.1  Installing an ACE in .war format from an archive file
    4.8.2.2  Installing an Administration Console Extension in .car format
from a repository
    4.8.2.3  Examples
   4.8.3  Customizing the Extensible Administration Console
    4.8.3.1  The Extensible Administration Console architecture
   4.8.4  Developing an Administrator Console Extension (ACE)
 5  Migrating
  5.1  JBoss to Geronimo
   5.1.1  Using the J2G migration tool
   5.1.2  EJB-BMP migration
   5.1.3  EJB-session beans migration
   5.1.4  Hibernate migration
   5.1.5  JDBC migration
   5.1.6  Servlets and JSPs migration
  5.2  Tomcat to Geronimo
 6  Developing
  6.1  Setting up your development environment
   6.1.1  Selecting tools and options
    6.1.1.1  Eclipse
     6.1.1.1.1  Maven Integration for Eclipse
     6.1.1.1.2  Web Tools Platform (WTP)
     6.1.1.1.3  Geronimo Eclipse plug-in
    6.1.1.2  NetBeans
    6.1.1.3  Apache Maven
    6.1.1.4  JBoss to Geronimo Migration Tool (J2G)
   6.1.2  Installing Eclipse
    6.1.2.1  Installing Eclipse using the WTP All-in-One package
    6.1.2.2  Downloading and installing Eclipse and WTP separately
    6.1.2.3  Installing Eclipse using Ant script from GEP build
   6.1.3  Installing Geronimo Eclipse Plug-in
    6.1.3.1  Installing GEP from within WTP
    6.1.3.2  Installing GEP using Eclipse Update Manager
    6.1.3.3  Installing GEP manually
   6.1.4  Defining Geronimo server runtimes and servers
    6.1.4.1  Defining a Geronimo server runtime
     6.1.4.1.1  Creating a project with a target runtime
    6.1.4.2  Defining a Geronimo server
   6.1.5  Configuring your development environment
    6.1.5.1  Editing a server configuration
    6.1.5.2  Making other configuration changes
  6.2  Developing applications for Geronimo
   6.2.1  Getting familiar with the development environment
    6.2.1.1  Configuring Application Specific Logging with Log4j
    6.2.1.2  Preparing to run SQL statements at Deployment Time
    6.2.1.3  Locating your application specific configuration files
    6.2.1.4  Quick Debugging JSPs of your application
    6.2.1.5  Deploying applications using the Geronimo Eclipse Plugin
(GEP)
   6.2.2  Developing Web applications with GEP
    6.2.2.1  Creating a Dynamic Web project using Eclipse
    6.2.2.2  Developing Web applications for accessing EJB
    6.2.2.3  Developing Web applications for accessing JDBC
    6.2.2.4  Developing Web applications for accessing JMS
    6.2.2.5  Developing JavaServer faces applications
     6.2.2.5.1  Basics of JavaServer Faces
     6.2.2.5.2  Developing AJAX with JSF applications in GEP
     6.2.2.5.3  Using JSP immediate expressions to access JSF
     6.2.2.5.4  Developing user interface with JSF
   6.2.3  Developing Web services in Geronimo
    6.2.3.1  Overview of Web services
    6.2.3.2  Web Services Architecture
    6.2.3.3  Web Services Description Language (WSDL)
    6.2.3.4  Developing Web services
     6.2.3.4.1  Developing a simple Calculator Web Service
     6.2.3.4.2  Developing JAX-RPC Web Services
     6.2.3.4.3  Developing a JAX-WS POJO Web Service
     6.2.3.4.4  Developing a JAX-WS EJB Stateless Session Bean Web Service

     6.2.3.4.5  Developing Clients for a JAX-WS Web Service
     6.2.3.4.6  Developing SAAJ Messaging Web Services
     6.2.3.4.7  Developing MTOM Web Services
     6.2.3.4.8  Developing a simple RESTful Service
     6.2.3.4.9  Developing Client for RESTful Web Service
    6.2.3.5  Migrating from JAX-RPC to JAX-WS
    6.2.3.6  WS Addressing
    6.2.3.7  Secruing your applications
   6.2.4  Developing JEE application clients
    6.2.4.1  Developing an application client to access EJB
    6.2.4.2  Deploying and running JEE application clients
    6.2.4.3  Using Java Persistence API in an application client
   6.2.5  Developing EJB applications
    6.2.5.1  Configuring, developing, and deploying enterprise applications
with Eclipse and Geronimo
    6.2.5.2  Developing EJB applications with Stateless Session Bean
    6.2.5.3  Developing EJB applications with Stateful Session Bean
    6.2.5.4  Developing JMS applications with Message-Driven Bean
   6.2.6  Persistence
    6.2.6.1  Developing container managed persistence with JPA
    6.2.6.2  Developing bean managed persistence with JPA
    6.2.6.3  Developing persistence for JSF applications using JPA
   6.2.7  Developing portlets for the Geronimo administration console
   6.2.8  Converting your current applications into plugins
  6.3  Creating deployment plans
   6.3.1  Deployment plan changes for going from Geronimo 1.1 to Geronimo
2.1
   6.3.2  Creating deployment plans using the deployment plan wizard
   6.3.3  Understanding XML schemas for deployment plans
   6.3.4  Configurations in deployment plans
   6.3.5  Creating deployment plans for applications
    6.3.5.1  Creating deployment plans for Web applications
    6.3.5.2  Creating deployment plans for EJB applications
    6.3.5.3  Creating deployment plans for enterprise applications
    6.3.5.4  Creating deployment plans for JEE application clients
    6.3.5.5  Creating deployment plans for message driven beans
   6.3.6  Annotations
  6.4  Geronimo architecture
   6.4.1  Repositories
   6.4.2  GBeans
   6.4.3  Modules and assemblies
 7  Reference
  7.1  Tools and commands
   7.1.1  GShell
    7.1.1.1  Running GShell
    7.1.1.2  Geronimo GShell commands
    7.1.1.3  Starting and stopping Geronimo in GShell
    7.1.1.4  Connecting to an already running Geronimo instance
   7.1.2  Startup
   7.1.3  Shutdown
   7.1.4  Geronimo
   7.1.5  deploy
   7.1.6  Client
   7.1.7  JAX-WS tools
  7.2  Samples
   7.2.1  Sample applications
   7.2.2  Sample plug-ins
 8  Troubleshooting
  8.1  Troubleshooting runtime issues
  8.2  Troubleshooting Web services issues


Book based approach (two separate books: user's guide and developer's
guide):
0  User's Guide
1  What's new
1.1  New features
1.1.1  Custom server assemblies
1.1.2  Geronimo administration console
1.1.3  GShell
1.1.4  Clustering
1.1.5  Monitoring console plugin
1.1.6  Plan Creator
1.2  Enhanced features
1.2.1  Geronimo distributions
1.2.2  Configuration changes
1.3  Compatibility with earlier versions
2  Getting started with Apache Geronimo
2.1  Getting the software
2.2  Starting the server
2.3  Creating and deploying a sample application
3  Installing and running Apache Geronimo
3.1  Installing prerequisite software
3.2  Downloading Geronimo
3.3  Installing Geronimo
3.3.1  Building Geronimo from source
3.3.2  Installing Geronimo from binaries
3.4  Constructing a special-purpose server using maven
3.5  Planning the topology
3.5.1  Configuring a two-tier system
3.5.2  Configuring a three-tier system
3.6  Starting and stopping the server
3.6.1  Starting and Stopping Geronimo in GShell
3.7  Running Geronimo as a non-root user
3.8  Running multiple Geronimo instances
4  Migrating to Apache Geronimo
4.1  JBoss to Geronimo
4.1.1  Using the J2G migration tool
4.1.2  EJB-BMP migration
4.1.3  EJB-session beans migration
4.1.4  Hibernate migration
4.1.5  JDBC migration
4.1.6  Servlets and JSPs migration
4.2  Tomcat to Geronimo
5  Configuring Geronimo
5.1  Available configuration files
5.2  Changing the default port numbers
5.3  Aliasing modules
5.4  Changing the username and password
5.5  Configuring Geronimo as a Windows or UNIX service
5.6  Configuring virtual host in Geronimo Jetty
5.7  Configuring virtual host in Geronimo Tomcat
5.8  Configuring a remote Apache HTTP server
5.9  Configuring JAX-WS engine
5.10  Clustering
5.10.1  Farming
5.10.2  WADI clustering
5.11  Configuring multiple repositories
5.12  Custom server assemblies
5.12.1  Buidling,installing plugins and extracting a server from an exsiting
server
5.12.2  Assembling a server using Maven
6  Deploying and and Administering assets in Geronimo
6.1  Selecting deployment options
6.1.1  Deploying assets from the command prompt
6.1.2  Deploying assets via GShell
6.1.3  Performing clustered deployment
6.1.4  Deploying plugins
6.1.5  Deploying assets via the administration console
6.1.6  Deploying applications using the Geronimo Eclipse Plugin (GEP)
6.1.7  Performing hot deployment
6.2  Annotations
6.3  Administering applications
6.3.1  Installing and removing applications
6.3.2  Starting and stopping application modules
6.4  Creating deployment plans
6.4.1  Deployment plan changes for going from Geronimo 1.1 to Geronimo 2.1

6.4.2  Creating deployment plans using the deployment plan wizard
6.4.3  Understanding XML schemas for deployment plans
6.4.4  Configurations in deployment plans
6.4.5  Creating deployment plans for applications
6.4.5.1  Creating deployment plans for Web applications
6.4.5.2  Creating deployment plans for EJB applications
6.4.5.3  Creating deployment plans for enterprise applications
6.4.5.4  Creating deployment plans for JEE application clients
6.4.5.5  Creating deployment plans for message driven beans
7  Administering Apache Geronimo
7.1  Administering the Apache Geronimo Server
7.1.1  Administering Geronimo using the Geronimo administration console
7.1.2  Administering Geronimo using command line tools
7.1.3  Add new listeners for Web containers
7.2  Administering security
7.2.1  Basic Hints on Security Configuration
7.2.2  Configuring JavaEE application client security
7.2.3  Configuring login modules
7.2.4  Configuring run-as and Default Subjects, and principal-role mapping

7.2.5  Administering certificates
7.2.6  Administering users and groups
7.2.7  Adminstering security realms
7.2.8  Certificate properties file realm
7.2.9  Certification authority
7.2.10  Database (SQL) realm
7.2.11  LDAP realm
7.3  Congifuring services
7.3.1  Configuring multiple repositories
7.3.2  Adding archives to the Geronimo repository
7.3.3  Configuring database pools
7.3.4  Configuring JMS
7.4  Configuring the Transaction Manager identify
7.5  Creating an embedded database in Geronimo
7.6  Monitoring the health of the Apache Geronimo server
7.6.1  Configuring your own Monitoring Plugin DataSource
7.6.2  Monitoring the status of the server using the Information portlet in
the Geronimo administration console
7.6.3  Monitoring the performance of the server using the Monitoring portlet
in the Geronimo administration console
7.6.4  Displaying JVM information
7.7  Extensible Administration Console
7.7.1  What is an Extensible Administration Console
7.7.2  Planning and installing the Extensible Administration Console
7.7.2.1  Installing an ACE in .war format from an archive file
7.7.2.2  Installing an Administration Console Extension in .car format from
a repository
7.7.2.3  Examples
7.7.3  Customizing the Extensible Administration Console
7.7.3.1  The Extensible Administration Console architecture
7.7.4  Developing an Administrator Console Extension (ACE)
8  Tools and commands
8.1  GShell
8.1.1  Running GShell
8.1.2  Geronimo GShell commands
8.1.3  Starting and stopping Geronimo in GShell
8.1.4  Connecting to an already running Geronimo instance
8.2  Startup
8.3  Shutdown
8.4  Geronimo
8.5  deploy
8.6  Client
8.7  JAX-WS tools
9  Troubleshooting
9.1  Troubleshooting runtime issues
9.2  Troubleshooting Web services issues
10  Samples
10.1  Sample applications
10.2  Sample plug-ins


0  Developer's Guide
1  Getting started
1.1  Getting the software
1.2  Installing Geronimo Eclipse plug-in
1.3  Defining a new server runtime
1.4  Packaging your applications
1.5  Deploying your applications
1.6  Running your applications
2  Setting up your development environment
2.1  Selecting tools and options
2.1.1  Eclipse
2.1.2  NetBeans
2.1.3  Apache Maven
2.1.4  Web Tools Platform (WTP)
2.1.5  Geronimo Eclipse plug-in
2.1.6  JBoss to Geronimo Migration Tool (J2G)
2.1.7  Maven Integration for Eclipse
2.2  Installing Eclipse
2.2.1  Installing Eclipse using the WTP All-in-One package
2.2.2  Downloading and installing Eclipse and WTP separately
2.2.3  Installing Eclipse using Ant script from GEP build
2.3  Installing Geronimo Eclipse Plug-in
2.3.1  Installing GEP from within WTP
2.3.2  Installing GEP using Eclipse Update Manager
2.3.3  Installing GEP manually
2.4  Defining Geronimo server runtimes and servers
2.4.1  Defining a Geronimo server runtime
2.4.1.1  Creating a project with a target runtime
2.4.2  Defining a Geronimo server
2.5  Configuring your development environment
2.5.1  Editing a server configuration
2.5.2  Making other configuration changes
3  Planning development and deployment
3.1  Configuring Application Specific Logging with Log4j
3.2  Preparing to run SQL statements at Deployment Time
3.3  Locating your application specific configuration files
3.4  Quick Debugging JSPs of your application
4  Developing applications for Geronimo
4.1  Developing Web applications with GEP
4.1.1  Creating a Dynamic Web project using Eclipse
4.1.2  Developing Web applications for accessing EJB
4.1.3  Developing Web applications for accessing JDBC
4.1.4  Developing Web applications for accessing JMS
4.1.5  Adding a JSP to the project
4.2  Developing Web services in Geronimo
4.2.1  Overview of Web services
4.2.2  Web Services Architecture
4.2.3  Web Services Description Language (WSDL)
4.2.4  Developing Web services with GEP
4.2.4.1  Developing a simple Calculator Web Service
4.2.4.2  Developing JAX-RPC Web Services
4.2.4.3  Developing a JAX-WS POJO Web Service
4.2.4.4  Developing a JAX-WS EJB Stateless Session Bean Web Service
4.2.4.5  Developing Clients for a JAX-WS Web Service
4.2.4.6  Developing SAAJ Messaging Web Services
4.2.4.7  Developing MTOM Web Services
4.2.4.8  Developing a simple RESTful Service
4.2.4.9  Developing Client for RESTful Web Service
4.2.5  Migrating from JAX-RPC to JAX-WS
4.2.6  WS Addressing
4.2.7  Secruing your applications
4.3  Developing JavaServer faces applications
4.3.1  Basics of JavaServer Faces
4.3.2  Developing AJAX with JSF applications in GEP
4.3.3  Using JSP immediate expressions to access JSF
4.3.4  Developing user interface with JSF
4.4  Developing JEE application clients
4.4.1  Developing an application client to access EJB
4.4.2  Deploying and running JEE application clients
4.4.3  Using Java Persistence API in an application client
4.5  Developing EJB applications
4.5.1  Configuring, developing, and deploying enterprise applications with
Eclipse and Geronimo
4.5.2  Developing EJB applications with Stateless Session Bean
4.5.3  Developing EJB applications with Stateful Session Bean
4.5.4  Developing JMS applications with Message-Driven Bean
4.6  Persistence
4.6.1  Developing container managed persistence with JPA
4.6.2  Developing bean managed persistence with JPA
4.6.3  Developing persistence for JSF applications using JPA
4.7  Developing portlets for the Geronimo administration console
4.8  Geronimo supported Java EE 5 annotations
5  Building Geronimo
5.1  Geronimo plug-ins
5.1.1  Converting your current applications into plugins
5.1.2  Creating custom server assemblies
5.1.2.1  Creating custom server assemblies using the administrative
console
5.1.2.2  Creating custom server assemblies using GShell
5.2  Building Geronimo with Maven
5.2.1  Constructing a special-purpose server using maven
5.3  Building Geronimo from Eclipse
6  Appendix
6.1  Geronimo directory structure
6.2  Repositories
6.3  GBeans
6.4  Modules and assemblies


Thanks & best regards
Rebekah Zhang

On 7/30/08, David Jencks <david_jencks@yahoo.com> wrote:
> I've been playing around with openid and jaspi and would like to write up
> some documentation before I forget how it all works :-)
>
> I don't think we have enough people interested in documentation to pursue
> anything but the easiest-to-write path in documentation.  In particular I
> think more than one active copy of the docs is asking for disaster.
>
> I'd like to suggest that feature documentation should generally start with
a
> "starting with version xxx" comment.  So, I'd put the openid/jaspi
> documentation in the current (2.1) wiki with a "starting with 2.2" notice.

> Obviously there's the problem that the wiki has the 2.1 version in its
name.
> I don't know if a wiki can have its name changed but don't regard this as
> critical.
>
> I'm going to start doing this pending comments and better ideas.  At the
> rate I write I don't think I'll be causing significant damage before we
have
> time for a full discussion :-)
>
> thanks
> david jencks
>
>

Mime
View raw message