| <h1>GlassFish v3 Documentation Plan</h1>
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.com^SM^ 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.
- 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
Jspwiki style: sortable
sortable
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
- 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.com^SM^ 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.
|
