GlassFish - World's first Java EE 7 Application Server


File Layout 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
Hong Zhang Software Engineer Burlington, MA, USA US/Eastern xiaohong_zhang@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 product file layout used to deliver the content of GlassFish Server Open Source Edition 3.1 as a standalone product distribution in IPS format that can integrated in Update Center 2.x.

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

Multiple/All Books Changes

The default product installation parent directory is changing in GlassFish 3.1 from glassfishv3 to glassfish3, which requires minor updates to many documents in the GlassFish 3.1 documentation set. Specifically, all instances of glassfishv3 must be changed to glassfish3 in large number of book component and shared entity files. Moreover, for GlassFish installations on Microsoft Windows, the path names will have to be further modified, as follows:

  • system drive:\glassfish3 (Windows XP platform)
  • %UserProfile%\glassfish3 (Windows Vista and newer Windows platforms)

The following table lists all the book files and entity files in which these changes must be made. Rather than listing individual books in separate tables in separate sections in this document, the table below is a compilation of the all the affected files, with one row for each book or component. In all cases, the Documentation Impact is Minor.

Book/Component Writer Reviewers Affected Files
Common Preface Scott Snjezana appserv-paths.sgm
JRuby Scripting Guide (JRUBYAPPDG) Scott Snjezana jruby.sgm
Administration Guide (SJSASEEAG) Scott Snjezana domain-instance.sgm
gstart.sgm
monitor.sgm
usermgmt.sgm
Developer's Guide (SJSASEEDG) Scott Snjezana dgasant.sgm
dgjdbc.sgm
Installation Guide (SJSASEEIG) Scott Snjezana installer-common-steps.sgm
install.sgm
uninstall.sgm
Release Notes (SJSASEERN) Scott Snjezana relnotes.sgm
Upgrade Guide (SJSASEEUMG) Scott Snjezana upgrade.sgm

Common Preface Changes

The common Preface is shared by most GlassFish 3.1 books. Changes to the common Preface are automatically picked up all books that use the Preface. The change listed below is in addition to the Multiple/All Books Changes, above.

Section Documentation Impact Writer Reviewers Description of Change
Default Paths and File Names Minor Scott Paul Update the default paths for as-install and as-install-parent:
  • system drive:\glassfish3 (Windows XP platform)
  • %UserProfile%\glassfish3 (Windows Vista and newer Windows platforms)

Release Notes Changes

Section Documentation Impact Writer Reviewers Description of Change
What's New, Changes Related to File Layout Minor Scott Snjezana Describe new default installation directories.

Upgrade Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
1, Enterprise Server Compatibility Issues Minor Scott Snjezana Describe new default installation directories.

Changes to man Pages

Similar to the table in Multiple/All Books Changes, above, the following table lists all the man page files in which instances of glassfishv3 must be changed to glassfish3 or the default Windows installation paths must be updated. In all cases, the Documentation Impact is Minor.

Module Writer Reviewers Affected Files
com.sun.enterprise.admin.cli Scott Snjezana start-domain.1
com.sun.enterprise.admin.cli.optional Scott Snjezana create-service.1
com.sun.enterprise.v3.admin.commands Scott Snjezana generate-jvm-report.1
com.sun.enterprise.v3.admin Scott Snjezana list-modules.1

Changes to Online Help

Admin Console Online Help Changes

See the GlassFish 3.1 Admin Console Doc Plan for a list of Admin Console online help changes.

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
Global Book/Component Updates    
Global man Page Updates    
Global Online Help Updates    
Common Preface    
Upgrade Guide    
Release Notes    

Reviewers are listed in the Statement of Work.

Related Information

Email aliases: