Installer 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 |
| Paul Davies |
Peer Reviewer |
Santa Clara, CA, USA |
US/Pacific |
pauldavies@dev.java.net |
| Sathyan Catari |
Feature Lead |
Santa Clara, CA, USA |
US/Pacific |
scatari@dev.java.net |
| Tom Mueller |
Software Engineer |
Omaha, NE, USA |
US/Central |
tmueller@dev.java.net |
| Ludovic Champenois |
Software Engineer |
Santa Clara, CA, USA |
US/Pacific |
ludo@dev.java.net |
| Snjezana Sevo-Zenzerovic |
Software Engineer |
Santa Clara, CA, USA |
US/pacific |
snjezana_o@dev.java.net |
| Ming Dong |
QA Engineer |
Santa Clara, CA, USA |
US/Pacific |
ming@dev.java.net |
Audience This feature is aimed at system administrators and application developers. Summary of the Feature From a User's Perspective The Installer components provide GUI and command-line tools for performing GlassFish installations and upgrades. As part of these features, the Installer supports custom and standard installations, and installations in standalone or clustered modes, including DAS and individual nodes. 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 Installation Guide Changes
| Section |
Documentation Impact |
Writer |
Reviewers |
Description of Change |
| Entire book |
Major |
Scott |
Sathyan |
Installer GUI has changed significantly, so almost entire book needs to be rewritten. |
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 |
| Installation Guide changes |
|
|
Reviewers are listed in the Statement of Work. Email aliases:
Comment ID
|
Section
|
Comment
|
PMD-001
|
Installation Guide Changes, Chapter 1, Installing GlassFish Server 3.1 |
If the 1st row is just preview of the remaining changes in Chapter 1, remove it.
|
PMD-002
|
Installation Guide Changes, Installation Overview |
Look at the Deployment Planning Guide for release v2.1.1 to see if any of these topics are discussed there and, if so, just plan on cross-referencing from the Administration Guide. See also PMD-004.
|
| PMD-003 |
Installation Guide Changes, Installation Requirements |
I'm not sure that it's appropriate to link to the Oracle product support matrix from documentation for GlassFish Server Open Source Edition. Determine from product marketing how best to state the hardware and software requirements for the open-source edition.
|
PMD-004
|
Installation Guide Changes |
State precisely where in Chapter 1 you plan to explain how to:
- Choose between typical and custom installations.
- Perform standalone installations and clustered installations (including DAS and node).
- Specify Windows service options, database options, and Message Queue options.
|
| PMD-005 |
Upgrade Guide Changes
|
None of the changes listed seems relevant to this section, which addresses compatibility issues that affect Java applications that run on earlier releases with which the current release is binary compatible. Delete this section form the doc plan, as the planned changes should not be made.
|
| PMD-006 |
Related Information
|
Fix the broken link to the Installer 1-pager.
|
 Posted by pauldavies at Jul 28, 2010 10:45
|
| Comment ID |
Comment |
| PMD-001 |
Removed row from table. |
| PMD-002 |
Changed entry to pointers to Administration Guide; correspondingly, new Administration Guide Changes table created. All chapters from 2.1.1 Deployment Planning Guide to be migrated to new Part I, "Deployment Planning" in 3.1 Administration Guide. |
| PMD-003 |
Changed wording in change description, kept Oracle link as question mark. |
| PMD-004 |
See my comments for PMD-002; new Part I proposed for Administration Guide. |
| PMD-005 |
Removed table for Upgrade Guide. |
| PMD-006 |
Link changed since initial publication of doc plan; updated link accordingly. |
Posted by sfordin at Aug 06, 2010 16:14
|
|
