|
|
| Not logged in|Log in |
Glassfish Wiki
»
DocPlan
AS9.1 Documentation Plan
Doc Plan Owner: Paul Davies
- Overview
- Tech Pubs Staff
- Audience
- Deliverables
- Summary of Documentation Changes by Feature
- Schedule
- Release Exit Criteria
Overview
App Server 9.1 (Java EE 5.0) will be released initially as an independent feature release (IFR) and in the accessory folder of of JES5 U1. There will be significant product changes, so the entire doc set will be updated.- Admin Guide and Admin Console online/inline help will add: LB administration, clustering admin, JBI integration, session persistence, JSF, etc.
- High Availability Admin Guide will be updated with the latest HADB administration.
- The Java EE Tutorial will require minor updates.
- The WSIT Tutorial will be added to the docset.
- Developer's Guide will add: session persistence (added to AS9.0UR1) JBI integration info (JSR 208), JRS 196 implementation, and webservices interoperability
- Reference manual will be updated with the new asadmin commands
- Performance Tuning Guide updated with performance enhancements
- Installation Guide updated as necessary (covers install of AppServer NOT glassfish)
- QuickStart guide updated as necessary (not required for Milestone 2)
- Troubleshooting guides updated with JBI info.
- Error message online wiki catalog
Replacement of AppServer Editions With Profiles
In this release, AppServer Editions are replaced with Profiles. As a result of this change, we post only one doc set on docs.sun.com to cover all profiles. Content that applies only to a particular profile will carry a statement to that effect. Only one version of the bundled docs (e.g. OLH page), will be produced.
A usage profile (or profile) identifies how a particular type of users use the application server software. The profile for a particular type of users determines the set of Application Server features that are available to those users.
The following pre-defined profiles are provided with AS 9.1:
- Developer profile. Provides access to features optimized for developers (corresponding to the features of PE in previous releases).
- Cluster profile. Provides access to features of EE in previous releases, except for HADB, NSS, and Sun Java System JDBC drivers.
- Enterprise profile. Provides access to features available by default only in EE/JES, including HADB, NSS, and Sun Java System JDBC drivers.
Note - Only the cluster profile and developer profile will be usable at beta.
Bundles
The AS 9.1 software is supplied in the following bundles:
- PE/GlassFish
- EE/JES
The EE/JES bundle contains the software of the PE/GlassFish bundle plus HADB, NSS, and Sun Java System JDBC drivers.
A default profile is associated with each bundle is as follows:
- PE/GlassFish - Developer profile
- EE/JES - Cluster profile
Software Requirements for Each Profile
The required Application Server software depends on the choice of profile as follows:
- Developer profile - The PE/GlassFish bundle is sufficient.
- Cluster profile - The PE/GlassFish bundle is sufficient.
- Enterprise profile - The user has the following choices:
- Use the EE/JES bundle.
- Use the PE/GlassFish bundle, separately obtain and install the EE/JES features (for example, NSS and HADB), and make some global configuration changes.
The enterprise profile template is supplied in all bundles. However, a user who has the PE/Glassfish bundle can create a domain with the enterprise profile only if the EE/JES features (for example, NSS and HADB) are separately installed and some global configuration changes are made. If the EE/JES features are not available with a PE installation, creation and running of the enterprise profile fail. No mechanism to revert to the cluster profile is provided.
Tech Pubs Staff
- Alan Sommerer (SCA) - Manager
- Pal Davies (SCA) - Lead writer, lead for man pages
- Scott Fordin (BUR)
- Chinmayee Srivathsa (BLR)
- June Parks (SCA): works Wed-Fri
- Hanan Lang (SCA)
- Rajeev Jayarajan (BLR) - Lead for Admin Guide, online help
The Java EE and WSIT Tutorial team documents features of the Java EE (J2EE) platform:
- Eric Jendrock (BUR) - Lead
- Jennifer Ball (SCA)
- Debbie Carson (SCA)
- Ian Evans (SCA)
- Kim Haase (BUR)
Audience
Java Enterprise developers, administrators, and other IT professionals.
Deliverables
The following table lists the document deliverables. Author assignments are tentative.
| Document Name | Authors |
Comments
|
|---|---|---|
| Documentation
bundled with product |
||
| Bundled HTML pages about.html |
Hanan Lang |
Revised for beta1 delivery |
| Admin Console online help | Vipin Rajan - lead (Rajeev Jayarajan, Chinmayee Srivathsa) |
Admin Guide and Online Help doc plan |
| QuickStart Guide |
Chinmayee Srivathsa |
Complete version bundled for PE; same as online. |
| Migration Tool online help | Chinmayee Srivathsa | |
| Upgrade Tool online help | Chinmayee Srivathsa | |
| Update Tool online help | Hanan Lang | Placeholder files checked in for Milestone 4 beta delivery |
| Manuals
posted to docs.sun.com |
||
| Administration Guide | Rajeev Jayarajan - lead (Hanan Lang, Chinmayee Srivathsa) | Admin Guide and Online Help doc plan |
| Application Deployment Guide |
June Parks
|
Documents any appserver specific Deployment Descriptor files |
| Documentation Center |
Hanan Lang
|
Links to topics in the doc set and Java EE
Tutorial |
| Developer's Guide | June Parks | |
| Deployment Planning Guide | Hanan Lang |
|
| Error Message Reference | Scott Fordin | App Server Error Messages posted on the Glassfish wiki |
| High Availability Admin Guide | Paul Davies |
HA Admin Guide and Online Help doc plan |
| Installation Guide |
Chinmayee | Writer will also be point of contact for JES Install Guide. |
| Performance Tuning Guide | Rajeev Jayarajan |
|
| Quick Start Guide | Chinmayee |
|
| Reference Manual |
Paul Davies - lead (Rajeev Jayarajan, Chinmayee Srivathsa) |
Contains: - CLI reference (man pages) See man page doc plan |
| Admin Reference
|
June Parks | Documents domain.xml file |
| Release Notes | Scott Fordin
|
|
| Troubleshooting Guide | Scott Fordin | |
| Upgrade & Migration Guide | Chinmayee Srivathsa | |
| Related
Documentation |
||
| Java EE, WSIT, Sun Web Developer Pack, and firstcup Tutorials | Eric Jendrock (Kim Haase, Ian Evans, Debbie Carson, Jennifer Ball) |
|
| Compatibility Test Suite | Scott Fordin | |
| Documentation Wiki Posting |
||
| HTML version of docset to be posted on glassfish docs wiki | Hanan Lang | Postings to occur on a monthly basis and will include opportunity for customers to provide feedback. |
Summary of Documentation Changes by Feature
| Feature | Affected Documentation | Responsible Writers |
Admin, Update, and Upgrade |
||
| Admin Console GUI | Admin Guide | Vipin |
| Admin GUI online help, including help for JBI | Rajeev, Vipin, Chinmayee | |
| Admin GUI inline help and system text | Scott | |
| Admin CLI | Admin Guide | Vipin |
| CLI man pages | Chinmayee, Rajeev, Vipin | |
| All other AS docs might also be affected | All writers to investigate. | |
Update Center
|
Update Center online help | Hanan |
| Update Center inline help and help text | Hanan | |
| Administration Guide | Vipin | |
| Upgrade | Upgrade and Migration guide | N/A |
| GMS | Admin Guide | Vipin |
| Self-Management Templates | Admin Guide | Vipin |
| Usage Profile Support | Admin Guide | Vipin |
| asadmin create-domain man page | Vipin | |
| All other AS documentation might be affected | All writers to investigate. | |
| Inline upgrade | Admin Guide | Vipin |
| Upgrade and Migration Guide | Chinmayee | |
Admin Infrastructure |
||
| Domain Configuration Management | Admin Guide | Vipin |
| Admin Reference | June | |
| Administrative MBeans and JMX Infrastructure | No impact | N/A |
| Inter Process Communication using JMX Connectors | No impact | N/A |
| Management API (AMX) | No impact | N/A |
| JSR 77 Support | No impact | N/A |
| Administrative Security | Admin Guide | Vipin |
| Process Launcher and Startup/Shutdown | No impact | N/A |
| Synchronization | No impact | N/A |
| Node Agent | HA Admin Guide | Paul |
| Miscellaneous | Admin Guide | Vipin |
| Templates and samples | Paul | |
Integration, Interoperation, and Enhancements |
||
| WSIT | WSIT Tutorial | Tutorial Team |
| JBI Integration | Administration Guide | Rajeev |
| Developer's Guide | June | |
| CLI man pages | Chinmayee, Rajeev, Vipin | |
| JBI documentation
|
Gavotte documentation team | |
| Connection Pool Enhancements | Administration Guide | Chinmayee, Hanan |
| Developer's Guide | June | |
| Admin Reference | June | |
| Admin GUI online help | Chinmayee | |
| Admin GUI inline help and system text | Scott | |
| CLI help | Chinmayee, Rajeev, Vipin | |
| JDBC 4.0 support | Developer's Guide | June |
| MQ Integration | Administration Guide | Vipin |
| Developer's Guide | June | |
| HA Admin Guide (maybe) | Paul to verify with the MQ team | |
| Addons
for EE Might be internal only |
Upgrade and Migration Guide | Chinmayee |
High Availability Features |
||
| Load Balancer Enhancements | HA Admin Guide | Rajeev |
| Error Message Reference | Scott | |
| In-memory Replication | HA Admin Guide | Paul |
| Developer's Guide | June | |
| HA Admin CLI Help | Chinmayee, Rajeev, Vipin | |
| HA Admin Console GUI Help | Chinmayee | |
| IIOP Failover | HA Admin Guide | Paul |
| Developer's Guide | June | |
Features That Do Not Affect Documentation |
||
| Generic JMS RA Integration | None | N/A |
| Grizzly v2 | None | N/A |
Schedule
Based on schedule in AS9.1 Plan Proposal. For more detailed doc schedule information, see the AS9.1 Schedule.
In the following schedule, all times are C.O.B., PST, unless otherwise noted. See the preceding table to see which docs are bundled and which are posted to docs.sun.com. Although bundled, the About page has separate line items in the schedule. The tasks in parentheses require no action by tech pubs but do affect our schedule.
| Task |
Date
|
|---|---|
| Monthly HTML documentation posting | Posting to begin with Milestone 2 (Sept 25) and continue monthly until full release of AppServer |
| Admin Console Online Help L10N 80% handoff |
Jun 8, 2007 |
| Beta 3 Release - Docs posted to docs.sun.com |
Jul 6, 2007 |
| Begin final bundled doc technical review |
Jul 16, 2007 |
| Deadline for review feedback on bundled docs
|
Jul 20, 2007 |
| AS9.1 Hard Code Freeze (HCF) - affects only bundled docs |
Jul 30, 2007 |
| Admin Console Online Help L10N 100% handoff* | Jul 30, 2007 |
| Begin final unbundled doc technical review |
Aug 31, 2007 |
| Deadline for review feedback on unbundled docs
|
Sep 7, 2007 |
| Submit books for publication on docs.sun.com |
Sep 14, 2007
|
| AS9.1 FCS |
Sep 17, 2007 |
Localization
The following documents will be localized for AS9.1 EE:
- Release Notes
- Online Help
Release Exit Criteria for Docs
- Monthly glassfish wiki postings: pre-beta quality; snapshot of docs in their current state.
- Beta: Full doc set, beta quality, no unwaived P1 or P2 bugs. "Full doc set" means that no guides will be missing. "Beta quality" means that the scope of a document might be cut in order to meet the schedule deadlines. The tech writers will work with the engineers to determine which topics are the highest priority.
- RR: Full doc set, no unwaived P1, P2, or P3 bugs.
Accessiblity
Before FCS, we must verifiy accessibility of HTML files by running the following script:
/java/pubs/bin/check508 -t <fully-qualified-directory-name>
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")