Packaging Documentation Plan for GlassFish Server Open Source Edition 3.1
People and Roles
| Name |
Role |
Location |
Time Zone |
Email |
| Scott Fordin |
Documentation Feature Owner |
Burlington, MA, USA |
US/Eastern |
sfordin@dev.java.net |
| Snjezana Sevo-Zenzerovic |
Software Engineer |
Santa Clara, CA, USA |
US/Pacific |
snjezana@dev.java.net |
| Alexis Moussine-Pouchkine |
Software Engineer |
Velizy, France |
Europe/CEST |
am74686@dev.java.net |
| Joe DiPol |
Software Engineer |
Santa Clara, CA, USA |
US/Pacific |
jfdipol@dev.java.net |
| Siraj Ghaffar |
Software Engineer |
Alpharetta, GA, USA |
US/Eastern |
sirajg@dev.java.net |
| Paul Davies |
Peer Reviewer |
Santa Clara, CA, USA |
US/Pacific |
pauldavies@dev.java.net |
Audience This feature is aimed at system administrators and application developers. Summary of the Feature From a User's Perspective This project defines GlassFish 3.1 product packaging based on the Image Packaging System (IPS). IPS packaging will make it possible to deliver the GlassFish Open Source Edition 3.1 release as a standalone product distribution through the Update Center 2.x content delivery mechanism. Product packages will be organized based on functional component boundaries and will be mapped to OSGi bundles. Package naming and versioning will follow IPS Packaging Best Practices. With the exception of the glassfish-scripting package, all packages from GlassFish version 3.0.1 will be brought forward to GlassFish version 3.1. In addition, six new packages will be added to the GlassFish 3.1 distribution. These packages are described in the GlassFish v3.1 Packaging One-Pager. Availability This feature is available in all GlassFish Server distributions. Statement of Work This section describes in detail for each document the work that is required by the introduction of the feature, such as changes, addition of new material, relocation of existing material, and removal of existing material. Documentation Impact:
- None
- Minor
- Moderate
- Major
- New
Note - If a document is task based (as opposed to reference), the changes should be determined from the user task analysis for the feature.
Changes to Books Administration Guide Changes
| Section |
Documentation Impact |
Writer |
Reviewers |
Description of Change |
| 10, Extending and Updating GlassFish Server |
|
|
|
|
| Adding Components |
Minor |
Scott |
Snjezana |
Replace sample output listings of installed and available packages with more current list |
| Removing Installed Components |
Minor |
Scott |
Snjezana |
Replace sample output listing of installed packages with more current list |
Application Development Guide Changes
| Section |
Documentation Impact |
Writer |
Reviewers |
Description of Change |
| 3, Using Ant with Enterprise Server |
New |
Scott |
Siraj |
Rewrite entire chapter; sun-appserv-ant.jar is no longer part of v3 distribution; replaced by glassfish-ant-tasks; tasks and reference information for Ant tasks need to be updated accordingly |
Changes to man Pages No changes to man pages are anticipated. Changes to Online Help No changes to online help are anticipated. Review Schedule The review schedule for the documentation items that are affected by this feature is provided in the following table.
| Item |
Review Start Date |
Review End Date |
| Administration Guide |
|
|
| Application Development Guide |
|
|
Reviewers are listed in the Statement of Work. Email aliases:
Comment ID
|
Section
|
Comment
|
PMD-001
|
Release Notes Changes |
In earlier releases, the documentation expressly excluded the information about packages that you are planning to add. The documentation team was advised by engineering not to try to include information that is subject to change during the lifetime of the product. Instead, users should obtain this information directly from the packages themselves by using Update Tool, the Administration Console, or the pkg command.
Withdrawal of support for scripting languages will be handled in a separate documentation project.
Therefore, remove this section, as this project should not affect the Release Notes.
|
 Posted by pauldavies at Jul 29, 2010 18:29
|
| Comment ID |
Comment |
| PMD-001 |
Removed all Release Notes entries. |
Posted by sfordin at Aug 06, 2010 14:20
|
| Comment ID |
Section |
Comment |
| SRF-001 |
App Dev Guide Chapter 3, "Using Ant with Enterprise Server" |
Per Snjezana, sun-appserv-ant.jar is replaced by glassfish-ant-tasks, so chapter needs to be rewritten accordingly. |
Posted by sfordin at Aug 06, 2010 15:07
|
|
