|
|
| Not logged in|Log in |
Glassfish Wiki
»
GlassFishV3PreludeDocPlan
By any use of this Wiki, you acknowledge and agree to be bound by this website's
Terms of Use.
GlassFish v3 Prelude Documentation Plan
This plan describes the work for the now completed GlassFish v3 Prelude documentation
.
Note - For information about documentation for the v3 Final release, see GlassFish v3 Doc Plan.
Table of Contents
- Related Information
- Documentation Information
- Individual Document Plans
- Engineering Information
- Engineering Staff
- Technical Writing Staff
- Summary of Deliverables
- TP2 Deliverables
- Books for TP2
- Online Help Sets for TP2
- Man Pages for TP2
- Inline Help and System Texts for TP2
- Bundled HTML Pages for TP2
- HTML Pages on the java.net Site
- Screencasts for TP2
- Wiki Pages for TP2
- v3 Prelude Deliverables
- Books for v3 Prelude
- 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
Documentation Information
- GlassFish v3 Documentation Plan
- Audience Analysis
- User Task Analyses List
- Style Sheet
- Documentation Quality Assurance
- Documentation Meetings
- GlassFish v2 UR1 documentation
Individual Document Plans
- Administration Guide
- Developer's Guide
- Application Deployment Guide
- Administration Reference
- Reference Manual
- Installation Guide
- Quick Start Guide
- Add-On Component Development Guide
- Troubleshooting Guide
- Administration Console GUI Online Help
- asadmin CLI help
Engineering Information
- One-Pagers and Functional Specifications
- Engineering Schedule
- Distributions
- v3 Prelude Feature List
- Technology Preview 2 Feature List
- 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 |
| 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 |
| SueAnn Spencer | Santa Clara, CA, USA | US/Pacific | Writer |
| Chinmayee Srivathsa | Bangalore, India | India (GMT+5.30) | Writer |
| Julie Bettis | Broomfield, CO, USA | US/Mountain | Editor |
Summary of Deliverables
This plan covers documentation only for the following milestones:
- Technology Preview 2 (TP2)
- Prelude
For information about documentation for the v3 Final release, see GlassFish v3 Doc Plan.
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 | Owner | Short Name | Part Number |
|---|---|---|---|
| Release Notes | Paul | SJSASEERN | 820-4494 |
| Quick Start Guide[1] | SueAnn | SJSASEEQSG | 820-4836 |
| Administration Guide | Dixie | SJSASEEAG | 820-4495 |
| Developer's Guide | June | SJSASEEDG | 820-4496 |
| Application Deployment Guide | June | SJSASEEADG | 820-4502 |
| Reference Manual | Paul | SJSASEEREFMAN | 820-4497 |
| RESTful Web Services Developer's Guide | Debbie | RESTWEBSVCSDG | 820-4867 |
| jMaki Application Developer's Guide | Devika | JMAKIAPPDG | 820-4868 |
| jRuby Application Developer's Guide | Devika | JRUBYAPPDG | 820-4926 |
| The Java EE 5 Tutorial[2] | Eric | SJSASEEJ2EET | 819-3669-10 |
| WSIT Tutorial [2] | Eric | SJSASWSITTUT | 820-1072-10 |
- For TP2, the Quick Start Guide will also be supplied as a bundled HTML page and a screencast.
- For TP2, the existing version of the tutorials will be used unchanged.
Online Help Sets for TP2
| Title | Owner | Short Name | Part Number |
|---|---|---|---|
| Admin GUI Console Online Help | Paul | ASEEADCONOH | 820-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.properties | Paul |
Bundled HTML Pages for TP2
| Title | Owner | File Name |
|---|---|---|
| Quick Start for Basic Features | SueAnn | 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 |
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
| Title | Owner |
|---|---|
| GlassFish v3 Technology Preview 2 Quick Start | SueAnn |
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 |
- 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 |
| Add-On Component Development Guide | Paul | SGFESADDONDEV | 820-6583 |
| Troubleshooting Guide | Gail | SJSASEETSG | 820-6823 |
| Roadmap to the Java EE5 Tutorial | Eric | JAVAEEWEBPFTUT | 820-5625 |
- For TP2, installation instructions were supplied as an HTML page on the java.net site.
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
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
| Milestone | Exit Criteria |
|---|---|
| TP2 | Documentation deliverables for TP2 present. Features of TP2 covered. No unwaived P1 bugs. No unevaluated P2 bugs. |
| Prelude | All planned documentation deliverables present and complete. 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-6) was last changed on
07-Jan-09 11:11 AM, -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")