| <html>
<head>
<title>JBI Integration into AS9.1 DocPlan</title>
</head>
<body>
<center>
<h1>JBI Integration with AS9.1 Documentation Plan</h1>
</center>
<b>Revision Date</b>
<script>
d = new Date( Date.parse(document.lastModified) );
document.writeln(d.getMonth() + 1 + "/" + d.getDate() + "/" + d.getFullYear());
</script><br>
<b>Doc Plan Owner</b>: Hanan Lang
<ul>
<li><a href="#overview">JBI Integration Overview</a>
<li><a href="#profiles">JBI Integration and AppServer Profiles</a>
</li><li><a href="#staff">JBI Writers</a>
</li><li><a href="#deliverables">JBI Related AppServer Documentation Deliverables</a>
<li><li><a href="#featurelist">Summary of Documentation Changes by Feature</a>
</li><li><a href="#schedule">Schedule</a>
</li><li><a href="#criteria">Release Exit Criteria</a>
</li></ul>
<p></p><h2><a name="overview"></a>JBI Integration Overview</h2>
JBI Integration will be documented in the Application Server documentation set insofar as users interact with JBI as part of the overall appserver. The following user views will be documented:
<ul>
<li>Admin Guide will add conceptual information needed to understand the JBI integration in the AppServer.
</li><li>Admin Console will document the JBI node screens and standalone-instance JBI tab (inline and Online help).
</li><li>Developer's Guide will add JBI integration info (JSR 208) from a developer's perspective.
</li><li>Reference manual will be updated with the new JBI asadmin commands.
</li><li>Installation Guide updated as necessary to include any JBI related screens (covers install of AppServer NOT glassfish).
</li><li>QuickStart guide will be updated with any JBI setup as necessary (not required for Milestone 2)
</li><li>Troubleshooting guides will be updated with JBI troubleshooting tips.
</li><li>Error message online wiki catalog will add any JBI related error messages.
</li><li>Release notes will include any JBI known issues.</ul>
<p>
All AppServer documents will reference the Open ESB opensource website and the Open ESB documentation.
</p><h3>JBI Integration and AppServer Profiles</h3>
<p>In this release, AppServer Editions are replaced with Profiles. As a
result of this change, 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.
</p>
<p>
</p><h2><a name="staff"></a>JBI Writers</h2>
<ul>
<li>Alan Sommerer (SCA) - Manager
</li><li>Paul Davies (SCA) - Lead writer
</li><li>Hanan Lang (SCA) - Admin Guide topics, online help topics
</li><li>Scott Fordin (BUR) - Release Notes, Troubleshooting Guide, Error Message Reference
</li><li>Chinmayee Srivathsa (BLR) - Admin Guide topics, asadmin manpages, admin console online help
</li><li>June Parks (SCA) - works Weds-Fri Developer's Guide
</li><li>Rajeev Jayarajan (BLR) - JBI topics in Admin Guide, online help, and manpages.
</li></ul>
<p>
</p><h2><a name="deliverables"></a>JBI Related AppServer Documentation Deliverables</h2>
<p>
The following table lists the JBI related Appserver document deliverables. Author assignments are tentative.
<p>
<table border="1"> <caption>JBI Related AppServer Documentation Deliverables</caption> <tbody>
<tr>
<th bgcolor="#cccccc"><b>Document Name</b></th> <th bgcolor="#cccccc"><span style="font-weight: bold;">Authors<br>
</span></th>
<th bgcolor="#cccccc"><span style="font-weight: bold;">Comments</span><br> <p> </p></th>
</tr>
<tr>
<td style="text-align: center; vertical-align: middle;" rowspan="1" colspan="3" bgcolor="#ffffcc"><span style="font-weight: bold;">Documentation
bundled with product</span><br>
</td>
</tr>
<tr>
<td>JBI nodes and Standalone instance JBI tab in Admin Console online help</td> <td>Rajeev Jayarajan<br>
</td>
<td><a href="http://swpubs.sfbay/writing/appserver/as9/plans/adminplan.html"> Admin Guide and Online Help doc plan </a> </td> </tr>
<tr>
<td valign="top">QuickStart Guide</td>
<td valign="top">Chinmayee Srivathsa</td>
<td valign="top">Mentions any JBI related setup as necessary.</td>
</tr> <tr> <td style="text-align: center; vertical-align: middle;" rowspan="1" colspan="3" bgcolor="#ffffcc"><span style="font-weight: bold;">Manuals posted to docs.sun.com</span><br>
</td>
</tr>
<tr>
<td>JBI topics in Administration Guide </td> <td>Rajeev Jayarajan</td> <td><a href="http://swpubs.sfbay/writing/appserver/as9/plans/adminplan.html">Admin Guide and Online Help doc plan</a> </td>
</tr> <tr>
<td valign="top">Documentation Center<br>
</td> <td valign="top">Hanan Lang<br> <p> </p></td>
<td valign="top">Links to JBI topics in the AppServer doc set</td>
</tr>
<tr>
<td>Developer's Guide</td> <td>June Parks</td> <td>References any JBI integration details from a developer's perspective.</td>
</tr>
<tr>
<td>Error Message Reference</td> <td>Scott Fordin</td>
<td> <a class="wikipage" href="/gfwiki/Wiki.jsp?page=AppServerErrorMessages">documents any JBI Error Messages</a> posted on the Glassfish wiki
</td> </tr>
<tr>
<td> Installation Guide</td>
<td>Chinmayee</td>
<td>Any JBI related screens in the installer will be documented.</td> </tr>
<tr>
<td>Quick Start Guide</td>
<td>Chinmayee</td>
<td>Any JBI related setup issues will be identified.</td>
</tr>
<tr>
<td>Reference Manual ()</td>
<td>Rajeev Jayarajan</td> <td valign="middle">Contains: CLI JBI commands manpages
<a href="http://swpubs.sfbay/writing/appserver/as9/reviewdrafts/mpages/index.html">See man page doc plan</a><br>
</td>
</tr> <tr>
<td>Release Notes</td>
<td>Scott Fordin</td>
<td>Add any known issues for JBI integration as viewed through the AppServer.</td>
</tr>
<tr>
<td>Troubleshooting Guide</td>
<td>Scott Fordin</td>
<td>Provides any JBI related troubleshooting tips as they related to use of the AppServer.</td>
</tr> <tr>
<td rowspan="1" colspan="3" style="text-align: center;" bgcolor="#ffffcc"><span style="font-weight: bold;">Documentation Wiki Posting</span><br>
</td>
</tr> <tr>
<td>HTML version of docset to be posted on glassfish docs wiki</td> <td>Hanan Lang</td>
<td>Postings to occur on a monthly basis and will include opportunity for customers to provide feedback.
</td>
</tr>
</tbody>
</table>
<p>
<a name="featurelist"><h2>Summary of Documentation Changes by Feature</h2></a>
</p><p> </p><table border="1">
<tbody><tr>
<td><b>Feature</b></td>
<td><b>Affected Documentation</b></td>
<td><b>Responsible Writers</b></td>
</tr>
<tr>
<td colspan="3">
<h3>Administration</h3>
</td>
</tr>
<tr>
<td rowspan="3">
<a href="/gfwiki/attach/OnePagersOrFunctionalSpecs/AdminGuiOnePager.html">AdminConsole GUI </a></td>
<td>Admin Guide JBI topics
</td>
<td>Rajeev
</td>
</tr>
<tr>
<td>Admin GUI online help, including help for JBI</td>
<td>Rajeev</td>
</tr>
<tr>
<td>Admin GUI inline help for JBI screens</td>
<td>Scott Fordin</td>
</tr> <tr>
<td>JBI command man pages
</td>
<td>Rajeev
</td>
</tr> <tr>
<td>Management API (AMX)
</td>
<td>Developer's Guide
</td>
<td>June
</td>
</tr> <tr>
<td colspan="3">
<h3>Integration</h3>
</td>
</tr> <tr>
<td rowspan="4">
<a href="/gfwiki/attach/OnePagersOrFunctionalSpecs/jbi.txt">JBI
Integration</a>
</td>
<td><a name="jbidocimpact"></a>Administration Guide
</td>
<td>Rajeev
</td>
</tr>
<tr>
<td>Developer's Guide
</td>
<td>June
</td>
</tr>
<tr>
<td>CLI man pages
</td>
<td>Chinmayee, Rajeev, Vipin
</td>
</tr>
<tr>
<td><a class="external" href="http://openesb.sfbay/Wiki.jsp?page=OpenESBDocs">Open ESB documentation</a><img class="outlink" src="jbidocplan_files/out.png" alt="">
</td>
<td>Gavotte documentation team </td>
</tr> </tbody></table> <p></p><h2><a name="schedule"></a>Schedule</h2>
<p>
Based on schedule in AS9.1 Plan Proposal. For more detailed doc schedule information, see the AS9.1 Schedule.
</p><p>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.
</p><p>
</p><p></p><p> </p><p> </p><p></p><table border="1" cellpadding="2" cellspacing="2" height="308" width="586">
<caption><b>AS9.1 EE Schedule (2005)</b> </caption>
<tbody>
<tr>
<th align="left" bgcolor="#cccccc" valign="middle">Task<br>
</th>
<th align="left" bgcolor="#cccccc" valign="middle">Date<br> <p> </p></th>
</tr>
<tr>
<td valign="top">Monthly HTML documentation posting</td>
<td>Posting to begin with Milestone 2 (Sept 25) and continue monthly until full release of AppServer</td>
</tr>
<tr>
<td valign="top">Admin Console Online Help L10N 80% handoff<br>
</td>
<td valign="top">TBD<br>
</td>
</tr> <tr>
<td valign="middle">Beta Release - Docs posted to docs.sun.com<br>
</td>
<td valign="middle">TBD<br>
</td>
</tr>
<tr>
<td style="vertical-align: top;"><b>AppServer Bundled docs - </b><b>final deadline for FCS review feedback</b></td> <td style="vertical-align: top;"><span style="font-weight: bold;">TBD</span><br>
</td>
</tr>
<tr>
<td style="vertical-align: top;">AS9.1 Hard Code Freeze (HCF) <a class="editpage" title="Create 'AffectsBundledDocsOnly'" href="/gfwiki/Edit.jsp?page=AffectsBundledDocsOnly">Affects bundled docs only</a><br>
</td>
<td style="vertical-align: top;">TBD<br> <p></p></td>
</tr> <tr>
<td valign="top">Admin Console Online Help L10N 100% handoff<sup>*</sup></td>
<td valign="top">TBD<br>
</td>
</tr>
<tr> <td valign="top">Begin final doc technical review <br>
</td>
<td valign="top">TBD<br>
</td>
</tr>
<tr>
<td valign="top">Deadline for review feedback <br> <p> </p></td>
<td valign="top">TBD<br>
</td>
</tr>
<tr>
<td valign="top">Submit books for publication on docs.sun.com<br>
</td>
<td valign="top">TBD<br> <p> </p></td>
</tr> <tr>
<td style="vertical-align: top;" bgcolor="#ffcccc">AS9.1 FCS<br>
</td>
<td style="vertical-align: top;" bgcolor="#ffcccc">TBD<br>
</td>
</tr>
</tbody>
</table>
<p>
</p><h3>Localization</h3>
<p>
The following documents will be localized for AS9.1:
</p><ul>
<li>Release Notes
</li><li>Online Help
</li></ul>
<p>
</p>
<p></p><h2><a name="criteria"></a>Release Exit Criteria for Docs</h2>
<p>
</p><ul>
<li>Monthly glassfish wiki postings: pre-beta quality; snapshot of docs in their current state.
</li><li>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.
</li><li>RR: Full doc set, no unwaived P1, P2, or P3 bugs.
</li></ul> <p></p><h3>Accessiblity</h3> <p>Before FCS, we must verifiy accessibility of HTML files by running the following script:
</p><p>
<code>/java/pubs/bin/check508 -t <fully-qualified-directory-name></code>
</p>
</body></html>
|
