Home Index Changes Prefs Log in »

※このページは翻訳中です。※

GlassFish v3 Documentation Plan

Related Information

Individual Document Plans

Documentation Information

Engineering Information

Engineering Staff

Responsibility Area Development SQE
Manager Engineering-Abhijit Kumar QA-Alex Pineda
Tech Lead Engineering-Jerome Dochez QA-Sherry Shen
HK2 Kohsuke Kawaguchi
Sahoo (OSGi support)
no one
Grizzly, Comet Jean-Francois Arcand
Kin-Man Chung (50%)
Shaline Gowda
Web container (servlet, JSP) Shing-Wai Chan
Amy Roh
Sudipa Bhattacharya
JSF Lidia Marchioni
jRuby support Vivek Pandey
Pramod Gopinath
Ming Zhang
jMaki Carla Mott no one
Jersey Martin Matula
Paul Sandoz
no one
Groovy/Grails Martin Grebac
Vivek Pandey
Barbara Louis
Kin-Man Chung
JeanFrancois Arcand
Ming Zhang
Sherry Shen
Java Persistence Mitesh Meswani Ming Zhang
Sherry Shen
JDBC Jagadish Prasad Ramu
Sivakumar Thyagarajan
Shalini Muthukrishnan
Smitha Prabhu
JNDI (naming) Mahesh Kannanno one
Transactions Marina VatkinaSmitha Prabhu
Security VB Kumar
Venugopal
Jagadesh Munta
Deployment Hong Zhang
Tim Quinn
Jane Young
Lidia Marchioni
Admin Infrastructure Kedar Mhaswade
Siraj Ghaffar (50%)
Lloyd Chambers (50%)
Nandini Ektare
Byron Nevins
Sankar Neelakandan
Davis Nguyen
Logging Lidia Marchioni
Monitoring Prashant Abbagani
Sreenivas Munnangi
Harpreet Singh
Mahesh Kannan
Rajeshwar Patil
Jennifer Chou
Elena Asarina
Runtime Management Sreenivas Munnagi
Harpreet Singh (20%)
Prashanth Abbagani
Rajeshwar Patil (50%)
Jennifer Chou
Sankar Needleham
Admin CLI Sreenivas Munnangi
Jennifer Chou
Prashant Abbagani
Rajeshwar Patil
Harpreet Singh
Sankar Needleham
Admin GUI Anissa Lam
Ken Paulsen
Senthil Chidambaram
Ana Caballero
Davis Nguyen
Update Center Rajeshwar Patil (50%)
Snjezana Sevo-Zenzerovic (50%)
Nolan Luu
NetBeans Plugin Peter Williams
Vince Kraemer (25%)
Ludo
Dasari Kumar
Davis Nguyen (30%)
Eclipse Plugin Rochelle Raccah
Nitya Doraisamy (after Ubuntu)
Ludo
Davis Nguyen (20%)
Packaging and Build Kohsuke Kawaguchi
Dindesh Patil
no one
Release Engineering Terena Chin-Fujii no one
I18N Program Ming Dong no one

Additional links to engineers:

Technical Writing Staff

Name Location Time Zone Role
Alan Sommerer Santa Clara, CA, USAUS/Pacific Manager
Paul Davies Santa Clara, CA, USAUS/Pacific Documentation project lead, writer
Eric Jendrock Burlington, MA, USA US/Eastern Tutorials project lead
Jennifer Ball Santa Clara, CA, USAUS/Pacific Writer
Debbie Carson Santa Clara, CA, USAUS/Pacific Writer
June Parks Santa Clara, CA, USAUS/Pacific Writer
Dixie Pine Santa Clara, CA, USAUS/Pacific Writer
Gail Risdal Bellevue, WA, USA US/Pacific Writer
SueAnn Spencer Santa Clara, CA, USAUS/Pacific Writer
Chinmayee SrivathsaBangalore, India India (GMT+5.30)Writer
Julie Bettis Broomfield, CO, USA US/Mountain Editor

Summary of Deliverables

Documentation will provided at the following milestones:

  • Technology Preview 2 (TP2)
  • Prelude
  • Beta
  • FCS

TP2 Deliverables

The TP2 release is aimed at developers. The focus of the documentation for TP2 is tasks that demonstrate to new users the simplicity of GlassFish v3 and the speed with which users can progress from download to productivity with GlassFish v3.

At TP2, the documentation should cover only the features of TP2, which are a subset of all the features of the Application Sever.

For TP2, the most common usage scenarios are as follows:

  • Iterative development, which involves:
    • Deployment
    • Debugging
    • Access to persistent data through JPA and JDBC
  • Use of scripting languages such as Ruby for development
  • Configuration of SSL with custom certificates
  • Extension of basic functionality through addition of modules
  • Automation of start-up and shutdown
  • Development of applications with GlassFish v3 TP2 for deployment on GlassFish v2

Books for TP2

Title OwnerShort Name Part Number
Release Notes Paul SJSASEERN 820-4494
Quick Start Guide[1]SueAnn SJSASEEQSG 820-4836
Administration GuideDixie SJSASEEAG 820-4495
Developer's Guide June SJSASEEDG 820-4496
Application Deployment GuideJune SJSASEEADG820-4502
Reference Manual Paul SJSASEEREFMAN820-4497
RESTful Web Services Developer's GuideDebbieRESTWEBSVCSDG820-4867
jMaki Application Developer's GuideJenniferJMAKIAPPDG820-4868
jRuby Application Developer's GuideJenniferJRUBYAPPDG820-4926
The Java EE 5 Tutorial[2] Eric SJSASEEJ2EET 819-3669-10
WSIT Tutorial [2] Eric SJSASWSITTUT 820-1072-10
  1. For TP2, the Quick Start Guide will also be supplied as a bundled HTML page and a screencast.
  2. For TP2, the existing version of the tutorials will be used unchanged.

Online Help Sets for TP2

Title Owner Short NamePart Number
Admin GUI Console Online HelpPaulASEEADCONOH820-4508
asadmin CLI help Paul - -
Update Center Online Help Update Center Writers- -

Man Pages for TP2

Paul is responsible for delivery of man pages into Application Server builds. Owners of individual man pages are listed in the GlassFish v3 Man Page Document Plan.

Inline Help and System Texts for TP2

Properties File Owner
Strings.propertiesPaul

Bundled HTML Pages for TP2

Title OwnerFile Name
Quick Start for Basic Features SueAnn QuickStart.html
Sun Java System Application Server - Installation CompletePaul about.html
Proprietary Rights Notice Paul copyright.html
Features and Resources Paul features.html
Your Application Server is now running Paul index.html

HTML Pages on the java.net Site

Title Owner
GlassFish v3 Technology Preview Welcome Page Gail
GlassFish v3 Technology Preview 2 Installation Guide Paul

Screencasts for TP2

TitleOwner
GlassFish v3 Technology Preview 2 Quick StartSueAnn

Wiki Pages for TP2

Title Owner
GlassFish v3 Technology Preview 2 Rodamap to the Java EE Tutorial Ian
GlassFish User FAQ[1] Gail
GlassFish Developer FAQ[1] Gail
  1. Assumes that GlassFish v3 changes will affect the FAQs.

v3 Prelude Deliverables

The v3 Prelude deliverables comprise the TP2 deliverables plus the deliverables that are listed in the sections that follow.

Books for v3 Prelude

Title Owner Short Name Part Number
Installation Guide[1]SueAnn SJSASEEIG 820-5968
Administration Reference June SJSASEEAREF 820-4507
  1. For TP2, installation instructions were supplied as an HTML page on the java.net site.

Beta Deliverables

At beta, the documentation should cover all the features of the Application Server as listed in GlassFish V3 Distributions.

The beta deliverables comprise the v3 Prelude deliverables plus the deliverables that are listed in the sections that follow.

Books for Beta

Title Owner Short Name Part Number
Upgrade and Migration Guide SJSASEEUMG
Documentation Center ASEEHOME
Troubleshooting Guide SJSASEETSG
Error Message Reference SJSASEEERR
High Availability Administration Guide SJSASEEHAAG
Deployment Planning Guide SJSASEEDPG
Performance Tuning Guide SJSASEEPTG
HADB Commands Reference Manual ASHADBREFMAN
Message Queue Release Notes MQ WritersMQRN
Message Queue Developer's Guide for JMX ClientsMQ WritersMQJMX

Online Help Sets for Beta

Title OwnerShort NamePart Number
Upgrade Tool Online Help SJSASEEMTOH

FCS Deliverables

At FCS, the documentation should cover all the features of the Application Server.

The FCS deliverables are the beta deliverables at FCS quality.

Documentation Requirements for This Release

Documentation requirements come from:

  • Product features
  • Engineering change requests that affect documentation
  • Documentation change requests

Product Features by Distribution

Nucleus:

Feature GF v3 Milestone Documentation Impact
HK2 TP2 New
Grizzly TP2 New
Logging TP2 Minor - v2
Basic admin CLI: support for deployment TP2Minor - v2
Basic admin CLI: support for http service configurationTP2Minor - v2
Basic admin CLI: support for web container TP2Minor - v2
Basic admin CLI: support for JDBC TP2Minor - v2
Basic admin GUI: support for deployment TP2 Minor - v2
Basic admin GUI: support for http service configurationTP2 Minor - v2
Basic admin GUI: support for web container TP2 Minor - v2
Basic admin GUI: support for JDBC TP2 Minor - v2

Web

Nucleus plus:

Feature GF v3 MilestoneDocumentation Impact
Web Container: Servlet 2.5 TP2 Minor - v2
Web Container: JSP 2.1 TP2 Minor - v2
Web Container: JSF 1.2 TP2 Minor - v2
Web Container: jMaki 1.x TP2 New
Configuration TP2 Minor - v2
Web Tier configuration TP2 New
Deployment: web modules TP2 Minor - v2
Deployment: Groovy modules Beta New
Deployment: jRuby modules TP2 New
Application Mgmt 1st phase: Edit/Manage servlet init parameters and env entryBeta New
Application Mgmt 1st phase: Start/Stop support Beta New
Security: SSL infrastructure TP2 Minor - v2
Security: File and JDBC Realm TP2 Minor - v2
Security: Container Authentication and Authorization TP2 None for TP2
Security: SPIs to support Metro TP2 None for TP2
Java Persistence API (JPA)1.0 Support TP2 Minor - v2
JPA 1.0 Support- Java Transaction API TP2 None for TP2
Scripting: jRuby support TP2 New
Scripting: Groovy support Beta New
Scripting: FastCGI support Beta
RESTful services (code name Jersey) TP2 New
JDBC TP2
JDBC Connection Pooling TP2 Minor - v2
JDBC Connection Pooling - Java Connector Architecture 1.5 Beta None for TP2
Clustering Beta
Full Admin Console Support Beta
Full Admin CLI Support Beta
Update Center - CLI support for downloading additional content TP2 New - not by AS writers
Update Center - simple GUI (nice to have) TP2 New - not by AS writers
Image pacakging System (IPS) Beta
Standalone Installer based on IPS Beta

AppServer

Web plus:

Feature GF v3 Milestone Documentation Impact
All Java EE Beta

Addons: Update Center Downloads

Feature GF v3 MilestoneDocumentation Impact
Metro TP2 Minor -v2
Jersey TP2 New
Groovy runtime Beta New
jRuby runtime TP2 New
EclipseLink TP2 New

Addons: NetBeans Plugin

Feature GF v3 Milestone Documentation Impact
Development and Deployment Support for Web Applications TP2 New but maybe by NetBeans writers
Development and Deployment Support for Groovy Applications Beta New but maybe by NetBeans writers
Development and Deployment Support for jRuby ApplicationsTP2 New but maybe by NetBeans writers

Addons: Eclipse Plugin

Feature GF v3 MilestoneDocumentation Impact
Development and Deployment Support for Web Applications TP2 New - low priority
Development and Deployment Support for Groovy Applications (nice to have) Beta New - low priority
Development and Deployment Support for jRuby Applications (nice to have)TP2 New - low priority

Engineering Change Requests That Affect Documentation

Documentation Change Requests

Schedule

Milestone Date
TP2: Task Analyses complete Fri Feb 29, 2008
TP2: Bundled documentation review start Mon Mar 17, 2008
TP2: Bundled documentation review end Fri Mar 21. 2008
TP2: Delivery of bundled documentation into the build Fri Mar 28, 2008
TP2: Hard code freeze (HCF) Fri Mar 28, 2008
TP2: Unbundled documentation review start Mon Apr 7, 2008
TP2: Unbundled documentation review end Fri Apr 11, 2008
TP2: Checkin and submission of unbundled documents Fri Apr 25, 2008
TP2: Software ship Mon Apr 28, 2008
Prelude: Task Analyses complete
Prelude: Soft code freeze (SCF) Mon Aug 11, 2008
Prelude: Initial delivery of OLH to pubstool for G11N Mon Aug 11, 2008
Prelude: Bundled documentation review start Mon Aug 11, 2008
Prelude: Bundled documentation review end Fri Aug 22, 2008
Prelude: P1/P2 bug cutoff Mon Sep 22, 2008
Prelude: Delivery of bundled documentation into the build Mon Sep 29. 2008
Prelude: Hard code freeze (HCF) Mon Sep 29, 2008
Prelude: Unbundled documentation review start Mon Oct 6, 2008
Prelude: Unbundled documentation review end Fri Oct 10, 2008
Prelude: Checkin and submission of unbundled documents Fri Oct 24, 2008
Prelude: Software ship Wed Oct 29, 2008

Bundled documentation consists of documentation that is bundled with the product, namely:

  • Online help
  • Inline help and system texts
  • Man pages
  • Bundled HTML pages

Unbundled documentation consists of documentation that is published on the web separately from the product, namely:

  • Books
  • Screencasts
  • Wiki pages

Deliverables That Are to Be Translated

Documentation Exit Criteria

MilestoneExit Criteria
TP2 Documentation deliverables for TP2 present.
Features of TP2 covered.
No unwaived P1 bugs.
No unevaluated P2 bugs.
Beta All planned documentation deliverables present.
All deliverables at "beta quality"[1]
No unwaived P1 or P2 bugs.
FCS All planned documentation deliverables present and complete.
No unwaived P1, P2, or P3 bugs.
  1. The scope of a document deliverable might be cut to meet the schedule. The technical writers will work with the engineers to determine which topics are the highest priority.

日本語翻訳: XXXXX

英文 (翻訳したバージョン: 130)

« Home Attachments Info Index Changes Prefs
This page (revision-1) was last changed on 02-Oct-08 06:44 AM, -0700 by JackSpallaw