|
|
| Line 1: |
Line 1: |
| − | <html>
| |
| | | | |
| − | <head>
| |
| − | <meta http-equiv=Content-Type content="text/html; charset=windows-1252">
| |
| − | <meta name=Generator content="Microsoft Word 12 (filtered)">
| |
| − | <style>
| |
| − | <!--
| |
| − | /* Font Definitions */
| |
| − | @font-face
| |
| − | {font-family:Wingdings;
| |
| − | panose-1:5 0 0 0 0 0 0 0 0 0;}
| |
| − | @font-face
| |
| − | {font-family:"Cambria Math";
| |
| − | panose-1:2 4 5 3 5 4 6 3 2 4;}
| |
| − | @font-face
| |
| − | {font-family:Cambria;
| |
| − | panose-1:2 4 5 3 5 4 6 3 2 4;}
| |
| − | @font-face
| |
| − | {font-family:Calibri;
| |
| − | panose-1:2 15 5 2 2 2 4 3 2 4;}
| |
| − | /* Style Definitions */
| |
| − | p.MsoNormal, li.MsoNormal, div.MsoNormal
| |
| − | {margin-top:0in;
| |
| − | margin-right:0in;
| |
| − | margin-bottom:10.0pt;
| |
| − | margin-left:0in;
| |
| − | line-height:115%;
| |
| − | font-size:11.0pt;
| |
| − | font-family:"Calibri","sans-serif";}
| |
| − | h1
| |
| − | {mso-style-link:"Heading 1 Char";
| |
| − | margin-top:12.0pt;
| |
| − | margin-right:0in;
| |
| − | margin-bottom:3.0pt;
| |
| − | margin-left:0in;
| |
| − | line-height:115%;
| |
| − | page-break-after:avoid;
| |
| − | font-size:16.0pt;
| |
| − | font-family:"Cambria","serif";}
| |
| − | h2
| |
| − | {mso-style-link:"Heading 2 Char";
| |
| − | margin-top:12.0pt;
| |
| − | margin-right:0in;
| |
| − | margin-bottom:3.0pt;
| |
| − | margin-left:0in;
| |
| − | line-height:115%;
| |
| − | page-break-after:avoid;
| |
| − | font-size:14.0pt;
| |
| − | font-family:"Cambria","serif";
| |
| − | font-style:italic;}
| |
| − | h3
| |
| − | {mso-style-link:"Heading 3 Char";
| |
| − | margin-top:12.0pt;
| |
| − | margin-right:0in;
| |
| − | margin-bottom:3.0pt;
| |
| − | margin-left:0in;
| |
| − | line-height:115%;
| |
| − | page-break-after:avoid;
| |
| − | font-size:13.0pt;
| |
| − | font-family:"Cambria","serif";}
| |
| − | p.MsoTitle, li.MsoTitle, div.MsoTitle
| |
| − | {mso-style-link:"Title Char";
| |
| − | margin-top:12.0pt;
| |
| − | margin-right:0in;
| |
| − | margin-bottom:3.0pt;
| |
| − | margin-left:0in;
| |
| − | text-align:center;
| |
| − | line-height:115%;
| |
| − | font-size:16.0pt;
| |
| − | font-family:"Cambria","serif";
| |
| − | font-weight:bold;}
| |
| − | p.MsoSubtitle, li.MsoSubtitle, div.MsoSubtitle
| |
| − | {mso-style-link:"Subtitle Char";
| |
| − | margin-top:0in;
| |
| − | margin-right:0in;
| |
| − | margin-bottom:3.0pt;
| |
| − | margin-left:0in;
| |
| − | text-align:center;
| |
| − | line-height:115%;
| |
| − | font-size:12.0pt;
| |
| − | font-family:"Cambria","serif";}
| |
| − | a:link, span.MsoHyperlink
| |
| − | {color:blue;
| |
| − | text-decoration:underline;}
| |
| − | a:visited, span.MsoHyperlinkFollowed
| |
| − | {color:purple;
| |
| − | text-decoration:underline;}
| |
| − | p.MsoNoSpacing, li.MsoNoSpacing, div.MsoNoSpacing
| |
| − | {margin:0in;
| |
| − | margin-bottom:.0001pt;
| |
| − | font-size:11.0pt;
| |
| − | font-family:"Calibri","sans-serif";}
| |
| − | span.MsoSubtleEmphasis
| |
| − | {color:gray;
| |
| − | font-style:italic;}
| |
| − | span.MsoIntenseEmphasis
| |
| − | {color:#4F81BD;
| |
| − | font-weight:bold;
| |
| − | font-style:italic;}
| |
| − | span.MsoSubtleReference
| |
| − | {font-variant:small-caps;
| |
| − | color:#C0504D;
| |
| − | text-decoration:underline;}
| |
| − | span.MsoIntenseReference
| |
| − | {font-variant:small-caps;
| |
| − | color:#C0504D;
| |
| − | letter-spacing:.25pt;
| |
| − | font-weight:bold;
| |
| − | text-decoration:underline;}
| |
| − | span.Heading1Char
| |
| − | {mso-style-name:"Heading 1 Char";
| |
| − | mso-style-link:"Heading 1";
| |
| − | font-family:"Cambria","serif";
| |
| − | font-weight:bold;}
| |
| − | span.Heading2Char
| |
| − | {mso-style-name:"Heading 2 Char";
| |
| − | mso-style-link:"Heading 2";
| |
| − | font-family:"Cambria","serif";
| |
| − | font-weight:bold;
| |
| − | font-style:italic;}
| |
| − | span.TitleChar
| |
| − | {mso-style-name:"Title Char";
| |
| − | mso-style-link:Title;
| |
| − | font-family:"Cambria","serif";
| |
| − | font-weight:bold;}
| |
| − | span.Heading3Char
| |
| − | {mso-style-name:"Heading 3 Char";
| |
| − | mso-style-link:"Heading 3";
| |
| − | font-family:"Cambria","serif";
| |
| − | font-weight:bold;}
| |
| − | span.SubtitleChar
| |
| − | {mso-style-name:"Subtitle Char";
| |
| − | mso-style-link:Subtitle;
| |
| − | font-family:"Cambria","serif";}
| |
| − | span.ornotepadcommenttext
| |
| − | {mso-style-name:or_notepadcommenttext;}
| |
| − | @page WordSection1
| |
| − | {size:8.5in 11.0in;
| |
| − | margin:1.0in 1.0in 1.0in 1.0in;}
| |
| − | div.WordSection1
| |
| − | {page:WordSection1;}
| |
| − | /* List Definitions */
| |
| − | ol
| |
| − | {margin-bottom:0in;}
| |
| − | ul
| |
| − | {margin-bottom:0in;}
| |
| − | -->
| |
| − | </style>
| |
| − |
| |
| − | </head>
| |
| − |
| |
| − | <body lang=EN-US link=blue vlink=purple>
| |
| − |
| |
| − | <div class=WordSection1>
| |
| − |
| |
| − | <p class=MsoTitle>Documentation Plan for EclipseLink 2.4</p>
| |
| − |
| |
| − | <h1>Change Record</h1>
| |
| − |
| |
| − | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
| |
| − | style='border-collapse:collapse;border:none'>
| |
| − | <tr>
| |
| − | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><strong><span style='font-family:"Calibri","sans-serif"'>Date
| |
| − | </span></strong></p>
| |
| − | </td>
| |
| − | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
| |
| − | border-left:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><strong><span style='font-family:"Calibri","sans-serif"'>Author</span></strong></p>
| |
| − | </td>
| |
| − | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
| |
| − | border-left:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><strong><span style='font-family:"Calibri","sans-serif"'>Change
| |
| − | Record</span></strong></p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>7/28/11</p>
| |
| − | </td>
| |
| − | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Ben Gelernter</p>
| |
| − | </td>
| |
| − | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>First draft</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>8/11/11</p>
| |
| − | </td>
| |
| − | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Ben Gelernter</p>
| |
| − | </td>
| |
| − | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Incorporated changes from doc manager review.</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=213 valign=top style='width:159.6pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>8/17/11</p>
| |
| − | </td>
| |
| − | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Ben Gelernter</p>
| |
| − | </td>
| |
| − | <td width=213 valign=top style='width:159.6pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Incorporated changes from doc team review</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| − |
| |
| − | <p class=MsoNormal> </p>
| |
| − |
| |
| − | <p class=MsoNormal>This documentation plan describes how the documentation team
| |
| − | will provide EclipseLink documentation for the EclipseLink; (EL) 2.4 release.</p>
| |
| − |
| |
| − | <h1>Schedule</h1>
| |
| − |
| |
| − | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
| |
| − | style='border-collapse:collapse;border:none'>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Milestone</b></p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-left:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Date</b></p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Doc plan first draft</p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>8/10/11</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Doc plan posted</p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>8/17/11 </p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Doc plan comments due</p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>8/24/11</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Final doc plan </p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>8/29/11</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>EclipseLink release 2.4</p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><s>10/26/11</s> – probably postponed until "into the
| |
| − | new year," per Doug C.</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| − |
| |
| − | <p class=MsoNormal> </p>
| |
| − |
| |
| − | <h1>Audience</h1>
| |
| − |
| |
| − | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
| |
| − | style='border-collapse:collapse;border:none'>
| |
| − | <tr>
| |
| − | <td width=187 valign=top style='width:1.95in;border:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>User</b></p>
| |
| − | </td>
| |
| − | <td width=451 valign=top style='width:4.7in;border:solid windowtext 1.0pt;
| |
| − | border-left:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Description</b></p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=187 valign=top style='width:1.95in;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Application Developers</p>
| |
| − | </td>
| |
| − | <td width=451 valign=top style='width:4.7in;border-top:none;border-left:none;
| |
| − | border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Developers who want to develop applications using any of
| |
| − | the following technologies for persistence services:</p>
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>Java Persistence Architecture (JPA) 2.x plus the
| |
| − | EclipseLink JPA extensions</li>
| |
| − | <li class=MsoNormal>Java Architecture for XML Binding 2.x (JAXB) plus the
| |
| − | EclipseLink MOXy extensions.</li>
| |
| − | <li class=MsoNormal>Java API for XML Web Services 2.x (JAX-WS) plus EclipseLink
| |
| − | Database Web Services (DBWS) features. </li>
| |
| − | </ul>
| |
| − | <p class=MsoNormal>Developers should be familiar with the concepts and
| |
| − | programming practices of:</p>
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>Java SE</li>
| |
| − | <li class=MsoNormal>Java EE</li>
| |
| − | </ul>
| |
| − | <p class=MsoNormal><b><i>//REVIEWERS: Should this specify a Java version?
| |
| − | which?//</i></b></p>
| |
| − | <p class=MsoNormal><b>Assumed knowledge:</b></p>
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>Developers using EclipseLink JPA should be familiar with
| |
| − | the concepts and programming practices of JPA 2.x.</li>
| |
| − | <li class=MsoNormal>Developers using EclipseLink MOXy should be familiar
| |
| − | with the concepts and programming practices of JAXB 2.x.</li>
| |
| − | <li class=MsoNormal>Developers using EclipseLink DBWS should be familiar
| |
| − | with the concepts and programming practices of JAX-WS 2.x.</li>
| |
| − | </ul>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=187 valign=top style='width:1.95in;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Administrator/Deployer</p>
| |
| − | </td>
| |
| − | <td width=451 valign=top style='width:4.7in;border-top:none;border-left:none;
| |
| − | border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Users who want to deploy and manage applications using the
| |
| − | EclipseLink persistence technologies.<b><i> </i></b></p>
| |
| − | <p class=MsoNormal><b>Assumed knowledge:</b></p>
| |
| − | <p class=MsoNormal>These users should be familiar with basic operations of
| |
| − | the chosen Java EE compliant application server.</p>
| |
| − | <p class=MsoNormal><b><i>//REVIEWERS: Is this correct simply to say
| |
| − | "Java EE compliant app server"? Should it be something like
| |
| − | "Java </i></b><b><i><span style='font-size:14.0pt;line-height:115%'>5</span>
| |
| − | EE compliant app server—some features are available only with Java 6 (or 7?)
| |
| − | EE, and therefore users of those features should be familiar with those
| |
| − | features in Java 6/7."? It may not even be important to specify. Please
| |
| − | advise//</i></b></p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| − |
| |
| − | <p class=MsoNormal> </p>
| |
| − |
| |
| − | <h1>Planned Documentation Deliverables</h1>
| |
| − |
| |
| − | <p class=MsoNormal>The Documentation team will document EclipseLink-specific
| |
| − | features for:</p>
| |
| − |
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>JPA (this is the highest priority)</li>
| |
| − | <li class=MsoNormal>MOXy</li>
| |
| − | <li class=MsoNormal>DBWS</li>
| |
| − | </ul>
| |
| − |
| |
| − | <p class=MsoNormal>The Documentation team will not document EIS, SDO, <span
| |
| − | class=ornotepadcommenttext>or any other "native" TopLink
| |
| − | functionality (i.e., non-JPA such as ORM, OX, etc.)</span>..</p>
| |
| − |
| |
| − | <h2>Documentation Design</h2>
| |
| − |
| |
| − | <p class=MsoNormal>The wiki topics will be handled as follows:</p>
| |
| − |
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>All EclipseLink documentation will be maintained under the
| |
| − | <i>Documentation Center</i> on the EclipseLink wiki at <a
| |
| − | href="http://wiki.eclipse.org/EclipseLink/UserGuide">http://wiki.eclipse.org/EclipseLink/UserGuide</a>.
| |
| − | </li>
| |
| − | <li class=MsoNormal>Versioning will be handled as follows:</li>
| |
| − | <ul style='margin-top:0in' type=circle>
| |
| − | <li class=MsoNormal>A note "New in EL 2.<i>n</i>" will be placed
| |
| − | next to new topics in the TOCs, where <i>n</i> refers to the release when
| |
| − | the feature was introduced. This is currently handled using template <span
| |
| − | style='font-family:"Courier New"'>{{EclipseLink/NewIn2<i>n</i>}}</span>.</li>
| |
| − | <li class=MsoNormal>A note " New in version 2.<i>n</i>." will be
| |
| − | added at the beginning of a topic documenting a new feature. This is
| |
| − | currently handled using <span style='font-family:"Courier New"'>{{EclipseLink_NewIn|version=2.n}}.</span></li>
| |
| − | <li class=MsoNormal>If a new feature is handled in an existing topic and the
| |
| − | topic changes more than 50%, the note " New in version 2.<i>n</i>."
| |
| − | will be placed at the beginning of the topic or at the beginning of the appropriate
| |
| − | section. </li>
| |
| − | <li class=MsoNormal>Header and footers on the wiki page will contain no
| |
| − | references to release numbers. </li>
| |
| − | <li class=MsoNormal>If a feature is deprecated, a note will placed next to
| |
| − | the documentation for the feature.</li>
| |
| − | </ul>
| |
| − | <li class=MsoNormal>Each topic will document one "feature." The term
| |
| − | "feature" here is somewhat loose. In some cases, it is a single
| |
| − | annotation. In some cases, the topic will document how to use multiple
| |
| − | annotations together for a specific purpose, e.g., single-table
| |
| − | multi=tenancy.</li>
| |
| − | <li class=MsoNormal>These topics are more-or-less "reference"
| |
| − | topics. That is, they document the primary APIs and XML used to implement
| |
| − | the feature. There can be limited discussion about how to use the code to
| |
| − | achieve the purpose of the feature, but we will not attempt to put the
| |
| − | feature in a larger context or to fully document all related features<span
| |
| − | style='color:red'>. </span></li>
| |
| − | <li class=MsoNormal>The JPA topics will primarily focus on using annotations,
| |
| − | when they are available. For example, a topic may begin with something
| |
| − | like, "Use the @Xyz annotation to…" and most or all examples and
| |
| − | code snippets will show annotations. When the feature can also be coded
| |
| − | using XML, the topic can discuss the XML (including a reference to the
| |
| − | schema), but the documentation for XML will not be as extensive as the
| |
| − | documentation for the annotation.</li>
| |
| − | <li class=MsoNormal>Every topic will cross-reference:</li>
| |
| − | <ul style='margin-top:0in' type=circle>
| |
| − | <li class=MsoNormal> Any associated example provided by Development and
| |
| − | located in the Samples section of the wiki.</li>
| |
| − | <li class=MsoNormal>Any associated Javadoc. When an annotation is available,
| |
| − | the reference will be to the annotation(s), not the "native
| |
| − | API."</li>
| |
| − | </ul>
| |
| − | <li class=MsoNormal>The Documentation team will not document features that are
| |
| − | not EclipseLink-specific. In particular, features that are documented in
| |
| − | the specification for the underlying technology. For example features
| |
| − | documented in the <i>JSR-000317 JavaTM Persistence 2.0</i> specification
| |
| − | will not be documented. However, anyone with permission to edit the wiki
| |
| − | may add topics to the wiki. As time permits, the Documentation team may
| |
| − | provide advice on the organization of topics. Any non-Documentation person
| |
| − | adding topics is responsible for adding and maintaining the following:</li>
| |
| − | <ul style='margin-top:0in' type=circle>
| |
| − | <li class=MsoNormal>Previous and Next browse sequence links at the bottom of
| |
| − | the page </li>
| |
| − | <li class=MsoNormal>Links from the Table of Contents</li>
| |
| − | <li class=MsoNormal>Links from the parent, or container, topic, if there is
| |
| − | one. For example, the JPA documentation includes a "Weaving
| |
| − | Topic" which introduces several weaving-related topics under it. </li>
| |
| − | </ul>
| |
| − | </ul>
| |
| − |
| |
| − | <p class=MsoNormal style='margin-left:1.0in'>Note: A container topic should not
| |
| − | contain only a list of links. Every topic must include at least an overview
| |
| − | sentence. For example: "The EclipseLink cache is an in-memory repository
| |
| − | that stores recently read or written objects based on class and primary key values.
| |
| − | Caching is discussed in the following topics:"</p>
| |
| − |
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>Individual topics will not include cross references to the
| |
| − | standard specifications (JPA, JAXB). There will be one overview topic (or
| |
| − | an overview topic for each service) that will contain the link to the
| |
| − | appropriate specification.</li>
| |
| − | <li class=MsoNormal>If design documents (specs) are not available or do not
| |
| − | contain enough source material (including examples), writers will file
| |
| − | bugs against Development via BugZilla.</li>
| |
| − | </ul>
| |
| − |
| |
| − | <h2>Tasks/Deliverables</h2>
| |
| − |
| |
| − | <p class=MsoNormal>The following tasks are not specifically associated with the
| |
| − | EclipseLink 2.4 release but will be handled by the Documentation team during
| |
| − | this period:</p>
| |
| − |
| |
| − | <h3>General</h3>
| |
| − |
| |
| − | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
| |
| − | style='border-collapse:collapse;border:none'>
| |
| − | <tr>
| |
| − | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b><i>Task/Deliverable</i></b></p>
| |
| − | </td>
| |
| − | <td width=233 valign=top style='width:174.4pt;border:solid windowtext 1.0pt;
| |
| − | border-left:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b><i>Writer</i></b></p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Identify topics in the JPA TOC that are documented in the
| |
| − | JPA specification to clarify which existing items are the responsibility of
| |
| − | Documentation and which are the responsibility of Development.</p>
| |
| − | </td>
| |
| − | <td width=233 valign=top style='width:174.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Ben Gelernter, Rick Sapir</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Review JPA topics to make sure all 2.2 and 2.3 features
| |
| − | are documented and reviewed. Update as needed.</p>
| |
| − | <p class=MsoNormal> </p>
| |
| − | </td>
| |
| − | <td width=233 valign=top style='width:174.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Ben Gelernter</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Create an Introduction/Overview section:</p>
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>If introductory information exists elsewhere (e.g., the
| |
| − | JPA intro section), move it to this section</li>
| |
| − | <li class=MsoNormal>Write any introductory information that is missing,
| |
| − | including cross-references to the specifications (JPA, JAXB)</li>
| |
| − | </ul>
| |
| − | </td>
| |
| − | <td width=233 valign=top style='width:174.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Ben Gelernter, Rick Sapir</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Review existing topics for consistency, e.g.:</p>
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>Navigation links</li>
| |
| − | <li class=MsoNormal>Lists of links in topics (TOCs for sections)</li>
| |
| − | <li class=MsoNormal>Headers/footers</li>
| |
| − | <li class=MsoNormal>Tables, examples</li>
| |
| − | <li class=MsoNormal>Key API links (qualified by path?) </li>
| |
| − | </ul>
| |
| − | </td>
| |
| − | <td width=233 valign=top style='width:174.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Ben Gelernter</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=406 valign=top style='width:304.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Create documentation style guide specific to EclipseLink. </p>
| |
| − | <p class=MsoNormal>The main source for documentation style is the Eclipse
| |
| − | documentation standards. However, as EclipseLink-specific style issues that not
| |
| − | covered by the Eclipse standards arise, the writers will post them on this
| |
| − | wiki page. We will spend minimal time developing standards.</p>
| |
| − | <p class=MsoNormal>Eclipse Doc Style Guide (for Eclipse Help): <a
| |
| − | href="http://wiki.eclipse.org/Eclipse_Doc_Style_Guide">http://wiki.eclipse.org/Eclipse_Doc_Style_Guide</a></p>
| |
| − | <p class=MsoNormal>Writers may also find these pages useful: <a
| |
| − | href="http://wiki.eclipse.org/DocumentationGuidelines">http://wiki.eclipse.org/DocumentationGuidelines</a>
| |
| − | and <a href="http://wiki.eclipse.org/DocumentationGuidelines/StyleGuidelines">http://wiki.eclipse.org/DocumentationGuidelines/StyleGuidelines</a></p>
| |
| − | </td>
| |
| − | <td width=233 valign=top style='width:174.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal> Tom Pfaeffle (create the page)</p>
| |
| − | <p class=MsoNormal>Entire team may contribute.</p>
| |
| − | <p class=MsoNormal><b><i> </i></b></p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| − |
| |
| − | <p class=MsoNormal> </p>
| |
| − |
| |
| − | <p class=MsoNormal>The following tables show the features that will be
| |
| − | documented for EL 2.4.</p>
| |
| − |
| |
| − | <h3>JPA Features</h3>
| |
| − |
| |
| − | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
| |
| − | style='border-collapse:collapse;border:none'>
| |
| − | <tr>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Feature </b></p>
| |
| − | </td>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Design documents, examples, any other source material</b></p>
| |
| − | </td>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Subject Matter Expert</b></p>
| |
| − | </td>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Writer</b></p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Enhanced Schema Provisioning: </b>Schema upgrade to
| |
| − | handle application version upgrades. Upon request the Schmea will be extended
| |
| − | to add additional tables, columns, indexes.</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Not yet available?</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>?</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal> </p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>MetadataSource support for PU Properties: </b>During
| |
| − | the bootstrap of a JPA persistence unit the Metadatasource will provide additional
| |
| − | PU properties that can come from an external source to customize the PU
| |
| − | properties used in the EntityManagerFactory creation.</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Not yet available?</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>?</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal> </p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>JPA 2.1</b>: Provide early access to some of the JPA
| |
| − | 2.1 defined features. This will depend on the progress the expert group
| |
| − | makes.</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Not yet available?</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>?</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal> </p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Gemini JPA</b>: With the Gemini JPA 1.0 release
| |
| − | scheduled to come out this summer the current solution available (which we
| |
| − | have deprecated) need to be fully transitioned to leverage the Gemini
| |
| − | solutions. This will involve updates or migration of examples but may also
| |
| − | involve a coordinated Gemini release if feature work is included</p>
| |
| − | <p class=MsoNormal>From the Gemini JPA wiki (http://www.eclipse.org/gemini/jpa/):
| |
| − | "The Gemini JPA project is about modular implementations of Java Persistence
| |
| − | API technology. This project currently provides the integration with the
| |
| − | EclipseLink JPA provider to support the OSGi JPA specification approach that
| |
| − | clients can use to get JPA support in an OSGi framework."</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Not yet available?</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>?</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal> </p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| − |
| |
| − | <h3>MOXy Features</h3>
| |
| − |
| |
| − | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
| |
| − | style='border-collapse:collapse;border:none'>
| |
| − | <tr>
| |
| − | <td width=164 valign=top style='width:123.3pt;border:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Feature </b></p>
| |
| − | </td>
| |
| − | <td width=283 valign=top style='width:212.2pt;border:solid windowtext 1.0pt;
| |
| − | border-left:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Design documents, examples, any other source material</b></p>
| |
| − | </td>
| |
| − | <td width=124 valign=top style='width:92.85pt;border:solid windowtext 1.0pt;
| |
| − | border-left:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Subject Matter Expert</b></p>
| |
| − | </td>
| |
| − | <td width=67 valign=top style='width:50.45pt;border:solid windowtext 1.0pt;
| |
| − | border-left:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Writer</b></p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=164 valign=top style='width:123.3pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Object-JSON</b> Mapping support</p>
| |
| − | </td>
| |
| − | <td width=283 valign=top style='width:212.2pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Not yet available?</p>
| |
| − | </td>
| |
| − | <td width=124 valign=top style='width:92.85pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>?</p>
| |
| − | </td>
| |
| − | <td width=67 valign=top style='width:50.45pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Rick Sapir</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| − |
| |
| − | <h3>DBWS Features</h3>
| |
| − |
| |
| − | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
| |
| − | style='border-collapse:collapse;border:none'>
| |
| − | <tr>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Feature</b></p>
| |
| − | </td>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Design documents, examples, any other source material</b></p>
| |
| − | </td>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Subject Matter Expert</b></p>
| |
| − | </td>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-left:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>Writer</b></p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>2.3 Features:</b></p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Meetings in progress</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>David Twelves</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal> </p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td valign=top style='border:solid windowtext 1.0pt;border-top:none;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal><b>RESTful JPA</b>: Provide a JAX-RS solution for easily
| |
| − | making a JPA persistence unit available through REST calls.</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Not yet available?</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>David Twelves</p>
| |
| − | </td>
| |
| − | <td valign=top style='border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;
| |
| − | border-right:solid windowtext 1.0pt;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Rick Sapir</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| − |
| |
| − | <p class=MsoNormal> </p>
| |
| − |
| |
| − | <h1>Scheduling and Reviews</h1>
| |
| − |
| |
| − | <p class=MsoNormal>Schedules must include time for:</p>
| |
| − |
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>Documentation reviews by Dev/QA. Reviews will be conducted
| |
| − | on the wiki.</li>
| |
| − | <li class=MsoNormal>A final production review of the wiki including, but not limited
| |
| − | to:</li>
| |
| − | </ul>
| |
| − |
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <ul style='margin-top:0in' type=circle>
| |
| − | <li class=MsoNormal>Links to samples</li>
| |
| − | <li class=MsoNormal>Links to Javadoc</li>
| |
| − | <li class=MsoNormal>Cross-references</li>
| |
| − | <li class=MsoNormal>Style consistency</li>
| |
| − | </ul>
| |
| − | </ul>
| |
| − |
| |
| − | <p class=MsoNormal style='text-indent:.5in'>All writers will contribute to the production
| |
| − | review.</p>
| |
| − |
| |
| − | <h1>Bugs</h1>
| |
| − |
| |
| − | <p class=MsoNormal>All writers must have BugZilla accounts and review and
| |
| − | handle documentation bugs against their EclipseLink topics.</p>
| |
| − |
| |
| − | <p class=MsoNormal>If a writer is responsible for a feature that has no
| |
| − | corresponding design documentation or if the design documentation does not
| |
| − | contain enough information (missing details, code snippets, release, etc.), the
| |
| − | writer should file a BugZilla bug against Development. (Use your judgment:
| |
| − | often a phone call or e-mail can clear up a problem.)</p>
| |
| − |
| |
| − | <h1>Assignments</h1>
| |
| − |
| |
| − | <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0
| |
| − | style='border-collapse:collapse;border:none'>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Joe Garcia</p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-left:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Manager </p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Donna Micozzi</p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Manager </p>
| |
| − | <p class=MsoNormal> </p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Ben Gelernter</p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Lead, JPA topics</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Ed Spear</p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>JPA topics (TBD)</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Rick Sapir</p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>MOXy</p>
| |
| − | <p class=MsoNormal>DBWS</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | <tr>
| |
| − | <td width=319 valign=top style='width:239.4pt;border:solid windowtext 1.0pt;
| |
| − | border-top:none;padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>Tom Pfaeffle</p>
| |
| − | </td>
| |
| − | <td width=319 valign=top style='width:239.4pt;border-top:none;border-left:
| |
| − | none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
| |
| − | padding:0in 5.4pt 0in 5.4pt'>
| |
| − | <p class=MsoNormal>JPA topics (TBD)</p>
| |
| − | </td>
| |
| − | </tr>
| |
| − | </table>
| |
| − |
| |
| − | <p class=MsoNormal> </p>
| |
| − |
| |
| − | <h1>Issues</h1>
| |
| − |
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>Printable Version</li>
| |
| − | </ul>
| |
| − |
| |
| − | <p class=MsoNormal style='margin-left:.5in'>We are considering providing a
| |
| − | printable version of the EclipseLink wiki topics. When a new version of
| |
| − | EclipseLink is released (and all documentation issues are wrapped up), we want
| |
| − | to generate a PDF version (and, if possible an HTML version)<b><i> </i></b>of
| |
| − | the wiki topics and post that as the official documentation for a certain release.
| |
| − | Updates may continue to be made on the wiki, but the PDF/HTML will not be
| |
| − | regenerated until the next release.</p>
| |
| − |
| |
| − | <p class=MsoNormal style='margin-left:.5in'>Details about how to accomplish
| |
| − | this are not yet resolved.</p>
| |
| − |
| |
| − | <ul style='margin-top:0in' type=disc>
| |
| − | <li class=MsoNormal>Metadata to improve searching</li>
| |
| − | </ul>
| |
| − |
| |
| − | </div>
| |
| − |
| |
| − | </body>
| |
| − |
| |
| − | </html>
| |
