|
|
| Not logged in|Log in |
Glassfish Wiki
»
GlassFishV3DocPlan
By any use of this Wiki, you acknowledge and agree to be bound by this website's
Terms of Use.
GlassFish v3 Documentation Plan
Table of Contents
- Related Information
- Feature Documentation Plans
- Individual Document Plans
- Documentation Information
- Engineering Information
- Engineering Staff
- Technical Writing Staff
- Summary of Deliverables
- Books
- Books Available Only to Registered Users
- Online Help Sets
- Man Pages
- Inline Help and System Texts
- Bundled HTML Pages
- Screencasts
- Wiki and Web Pages
- Documentation Requirements for This Release
- Product Features by Distribution
- Nucleus:
- Web
- AppServer
- Addons: Update Center Downloads
- Addons: NetBeans Plugin
- Addons: Eclipse Plugin
- Engineering Change Requests That Affect Documentation
- Documentation Change Requests
- Schedule
- Deliverables That Are to Be Translated
- Documentation Exit Criteria
Related Information
Feature Documentation Plans
- GlassFish v3 Feature Documentation Plan Template
- Administration Infrastructure Documentation Plan
- Administration CLI Documentation Plan
- Hundred-Kilobyte Kernel Documentation Plan
- Extensibility Documentation Plan
- Grizzly Documentation Plan
- AMX and GMBAL Documentation Plan
- ACC Documentation Plan
- JDBC and Connectors Documentation Plan
- Properties Plan
- Extensibility Documentation Plan
- Application Deployment Documentation Plan
- Logging Documentation Plan
- Monitoring Documentation Plan
- OSGi in GlassFish Documentation Plan
- Security Documentation Plan
Individual Document Plans
- Administration Guide
- Application Development Guide (formerly Developer's Guide)
- Application Deployment Guide
- Domain File Format Reference (formerly Administration Reference)
- Reference Manual
- Installation Guide
- Quick Start Guide
- Add-On Component Development Guide
- Upgrade and Migration Guide
- Documentation Center
- Troubleshooting Guide
- Error Message Reference
- High Availability Administration Guide
- Deployment Planning Guide
- Performance Tuning Guide
- HADB Commands Reference Manual
- Administration Console GUI Online Help
- asadmin CLI help
- Java EE 6 Tutorial, Volume I
- Java EE 6 Tutorial, Volume II
Documentation Information
- Audience Analysis
- User Task Analyses List
- Style Sheet
- Documentation Quality Assurance
- Documentation Meetings
- GlassFish v3 Prelude documentation
Engineering Information
- One-Pagers and Functional Specifications
- Java EE 6 Samples
- Engineering Schedule
- Tasks for GlassFish v3 milestones:
- Web Tier Tasks for v3 Final
- v2 Features Not in v3 Prelude
- Distributions
- Themes
- Requirements
- ContainersConfiguration for configuring RoR, Phobos and Groovy/Grails containers in V3
- Web Tier Feature List
- Deployment
- List of available administrative commands
- Administration Starting Point
- Administration Improvements
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 Kannan | no one |
| Transactions | Marina Vatkina | Smitha 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 Devika Chou | Elena Asarina |
| Runtime Management | Sreenivas Munnagi Harpreet Singh (20%) Prashanth Abbagani Rajeshwar Patil (50%) Devika Chou | Sankar Needleham |
| Admin CLI | Sreenivas Munnangi Devika 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, USA | US/Pacific | Manager |
| Paul Davies | Santa Clara, CA, USA | US/Pacific | Documentation project lead, writer |
| Eric Jendrock | Burlington, MA, USA | US/Eastern | Tutorials project lead, writer |
| Debbie Carson | Santa Clara, CA, USA | US/Pacific | Writer |
| Ian Evans | Santa Clara, CA, USA | US/Pacific | Writer |
| Mike Fitch | Santa Clara, CA, USA | US/Pacific | Writer |
| Devika. Gollapudi | Santa Clara, CA, USA | US/Pacific | Writer |
| Kim Haase | Burlington, MA, USA | US/Eastern | Writer |
| June Parks | Santa Clara, CA, USA | US/Pacific | Writer |
| Dixie Pine | Santa Clara, CA, USA | US/Pacific | Writer |
| Gail Risdal | Bellevue, WA, USA | US/Pacific | Writer |
| Chinmayee Srivathsa | Bangalore, India | India (GMT+5.30) | Writer |
| Julie Bettis | Broomfield, CO, USA | US/Mountain | Editor |
Summary of Deliverables
The documentation should cover all the features of the Application Server as listed in GlassFish V3 Distributions.
Books
Books are published on the docs.sun.comSM site.
The features of GlassFish v3 are similar to the features in a Platform Edition release such as
Sun Java System Application Server Platform Edition 9.0 Update 1 or
Sun GlassFish Enterprise Server v3 Prelude. The set of books for the GlassFish v3 release reflects this fact.
For the v3 final release, the books that are to be provided are listed in the following table.
| Title | Owner | Short Name | Part Number |
|---|---|---|---|
| Release Notes | Gail | SJSASEERN | 820-7688 |
| Quick Start Guide | Gail | SJSASEEQSG | 820-7689 |
| Installation Guide | Gail | SJSASEEIG | 820-7690 |
| Administration Guide | Dixie | SJSASEEAG | 820-7692 |
| Application Deployment Guide | Dixie | SJSASEEADG | 820-7693 |
| Your First Cup: An Introduction to the Java EE Platform | Tutorial team | FRSTCUPENTJAVA | 820-7759 |
| Application Development Guide | June | SJSASEEDG | 820-7695 |
| Add-On Component Development Guide | Paul | SGFESADDONDEV | 820-7727 |
| Scripting Framework Guide | Devika | JRUBYAPPDG | 820-7697 |
| Embedded Server Guide | June | GFEMBEDDED | 821-1208 |
| Troubleshooting Guide | Gail | SJSASEETSG | 820-7699 |
| Reference Manual | Paul | SJSASEEREFMAN | 820-7701 |
| Java EE 6 Tutorial, Volume I | Tutorial team | JAVAEE6TUTV1 | 820-7627 |
| Message Queue 4.4.1 Release Notes | Mike | MQRN | 821-1073 |
| Message Queue 4.4 Administration Guide | Mike | MQAG | 821-0027 |
| Message Queue 4.4 Developer's Guide for JMX Clients | Mike | MQJMX | 821-0031 |
| System Virtualization Support in Sun Java System Products | Java ES writer | SJESV12NSTMT | 820-4651 |
| Documentation Center[1] | Paul | ASEEHOME | 820-7691 |
| Domain File Format Reference[1][2] | June | SJSASEEAREF | 820-7694 |
| Upgrade Guide[1] | Kim | SJSASEEUMG | 820-7698 |
| Error Message Reference | Gail | SJSASEEERR | 820-7700 |
- To be added to the set of books for the v3 Preview release.
- Formerly Administration Reference
Books in earlier releases that are not to be supplied in this release:
| Title | Provisional Owner | Short Name | Part Number |
|---|---|---|---|
| HADB Commands Reference Manual | Paul | ASHADBREFMAN | |
| RESTful Web Services Developer's Guide[1] | Debbie | RESTWEBSVCSDG | |
| Clustering Administration Guide[2] | Dixie | SJSASEEHAAG | |
| Deployment Planning Guide | Paul | SJSASEEDPG | |
| Performance Tuning Guide | Dixie | SJSASEEPTG | |
| jMaki Application Development Guide[3] | Devika | JMAKIAPPDG | 820-7696 |
- RESTful Web Services Developer's Guide is obsolete in this release. Relevant content from the guide for v3 Prelude is to be migrated to the Java EE 6 Tutorial.
- Clustering Administration Guide was formerly known as High Availability Administration Guide.
- Ideally, the information in this document should be donated to the NetBeans team or the jMaki team.
Books Available Only to Registered Users
| Title | Owner | Short Name | Part Number |
|---|---|---|---|
| Java EE 6 Tutorial, Volume II | Tutorial team | JAVAEE6VOL2 | 820-7628 |
Online Help Sets
| Brief Title | Owner | Short Name | Part Number | Module ID |
|---|---|---|---|---|
| Admin Console Common Online Help | Kim | ASEEADCONOH | 820-7734 | common |
| Admin Console JavaMail Online Help | Kim | ASEEACOHJMAIL | 821-0305 | jmail |
| Admin Console Web Online Help | Kim | ASEEACOHWEB | 821-0306 | web |
| Admin Console JDBC Online Help | Kim | ASEEACOHJDBC | 821-0307 | jdbc |
| Admin Console JCA Online Help | Kim | ASEEACOHJCA | 821-0308 | jca |
| Admin Console EJB Lite Online Help | Kim | ASEEACOHEJBLT | 821-0309 | ejb-lite |
| Admin Console EJB Online Help | Kim | ASEEACOHEJB | 821-0310 | ejb |
| Admin Console CORBA Online Help | Kim | ASEEACOHCORBA | 821-0311 | corba |
| Admin Console JTS Online Help | Kim | ASEEACOHJTS | 821-0312 | jts |
| Admin Console JMS Online Help | Kim | ASEEACOHJMS | 821-0313 | jms |
| Admin Console Scripting Online Help | Kim | ASEEACOHSCRIPT | 821-0321 | jruby |
| Upgrade Tool Online Help | Kim | SJSASEEMTOH | ||
| asadmin CLI help | Paul | - | - |
Man Pages
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
| Properties File | Owner |
|---|---|
| Strings.properties | Paul |
Bundled HTML Pages
| Title | Owner | File Name |
|---|---|---|
| Quick Start for Basic Features | Paul[1] | quickstart.html |
| Sun Java System Application Server - Installation Complete | Paul | about.html |
| Proprietary Rights Notice | Paul | copyright.html |
| Features and Resources | Paul | features.html |
| Your Application Server is now running | Paul | index.html |
- Paul to edit and deliver HTML version generated from content written by Gail
Screencasts
| Title | Owner |
|---|---|
| GlassFish v3 Quick Start | Gail |
Wiki and Web Pages
| Title | Owner |
|---|---|
| GlassFish User FAQ[1] - wiki | Gail |
| GlassFish Developer FAQ[1] - wiki | Gail |
| Product Documentation - web | Gail |
| Documentation Home Page - web | Gail |
- Assumes that GlassFish v3 changes will affect the FAQs.
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 | TP2 | Minor - v2 |
| Basic admin CLI: support for http service configuration | TP2 | Minor - v2 |
| Basic admin CLI: support for web container | TP2 | Minor - v2 |
| Basic admin CLI: support for JDBC | TP2 | Minor - v2 |
| Basic admin GUI: support for deployment | TP2 | Minor - v2 |
| Basic admin GUI: support for http service configuration | TP2 | 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 Milestone | Documentation 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 entry | Beta | 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 Milestone | Documentation 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 Applications | TP2 | New but maybe by NetBeans writers |
Addons: Eclipse Plugin
| Feature | GF v3 Milestone | Documentation 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
- All open doc bugs for GlassFish v3.
Issue Tracker query criteria:
- Subcomponent: docs
- Status: UNCONFIRMED, NEW, STARTED, REOPENED
- Target milestone: v3
- Bundled doc bugs
Issue Tracker query criteria:
- Subcomponent: docs
- Status: UNCONFIRMED, NEW, STARTED, REOPENED
- Target milestone: v3
- Summary does not contain the substring [UB]
- Unbundled doc bugs
Issue Tracker query criteria:
- Subcomponent: docs
- Status: UNCONFIRMED, NEW, STARTED, REOPENED
- Target milestone: v3
- Summary contains the substring [UB]
Schedule
| Milestone | Date |
|---|---|
| Feature Doc Plans Complete | April 17 |
| JavaOne EA Release Soft code freeze (SCF) | April 20 |
| JavaOne EA Release Hard code freeze (HCF)/Bundled Doc Freeze | May 4 |
| JavaOne EA Release Unbundled Doc Freeze | May 25 |
| JavaOne EA Release Software Ship | May 27 |
| RR SCF | August 31 |
| RR FishCAT Program start | September 24 |
| RR FishCAT Program end | October 9 |
| RR Bundled documentation review start | October 16 |
| RR Bundled documentation review end | October 30 |
| RR P1/P2 bug cutoff | |
| RR Bundled documentation freeze | November 6 |
| RR HCF | November 9 |
| RR Unbundled documentation review start | November 23 |
| RR Unbundled documentation review end | December 1 |
| RR Checkin and submission of unbundled documents | December 8 |
| RR Publication of unbundled documents the docs.sun.comSM site | December 9 |
| RR Software ship | December 10 |
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
- Release Notes
- Administration Guide
- Online help sets for the Administration Console
- Inline help and system texts
Documentation Exit Criteria
- All planned documentation deliverables present and complete[1].
- No unwaived P1, P2, or P3 bugs.
- 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.
«
Home
Attachments
Info
Index
Changes
Prefs
This page (revision-215) was last changed on
07-Jan-10 16:03 PM, -0800
by PaulDavies
By any use of this Wiki, you acknowledge and agree to be bound by this website's
Terms of Use
Copyright © 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Copyright © 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
![[RSS]](http://wiki.glassfish.java.net/images/xml.png "Aggregate the RSS feed")