glennm 2002/06/03 15:04:34
Modified: xdocs/ref dirlayout.xml project-descriptor.xml
Log:
Glenn McAllister - 2002/05/03
- Added documentation for <developer> and <contributor> <roles> to
project-descriptor.xml
- Finally fixed up the docs for the directory layout to reflect the fact that
pretty much *everything* is generated under target/, including docs and the
junit reports.
Revision Changes Path
1.6 +12 -12 jakarta-turbine-maven/xdocs/ref/dirlayout.xml
Index: dirlayout.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/dirlayout.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- dirlayout.xml 3 Jun 2002 17:15:54 -0000 1.5
+++ dirlayout.xml 3 Jun 2002 22:04:34 -0000 1.6
@@ -248,7 +248,7 @@
</td>
</tr>
<tr>
- <td>test-reports</td>
+ <td>target/test-reports</td>
<td>Contains the individual unit test results.</td>
<td>
The test-reports/ directory contains individual unit test
@@ -258,7 +258,7 @@
</td>
</tr>
<tr>
- <td>docs/</td>
+ <td>target/docs</td>
<td>Documentation files intended for the website publication.</td>
<td>
The docs/ directory contains only generated documentation
@@ -272,7 +272,7 @@
</td>
</tr>
<tr>
- <td>docs/index.html</td>
+ <td>target/docs/index.html</td>
<td>Starting point for browsing the documentation.</td>
<td>
Browsing the documentation locally should yield the same
@@ -285,7 +285,7 @@
</td>
</tr>
<tr>
- <td>docs/apidocs</td>
+ <td>target/docs/apidocs</td>
<td>API documentation.</td>
<td>
Maven automatically generates JavaDocs for projects using
@@ -296,7 +296,7 @@
</td>
</tr>
<tr>
- <td>docs/xref</td>
+ <td>target/docs/xref</td>
<td>Cross-referenced source code.</td>
<td>
Maven automatically generates cross-referenced source code
@@ -307,7 +307,7 @@
</td>
</tr>
<tr>
- <td>docs/mail-lists.html</td>
+ <td>target/docs/mail-lists.html</td>
<td>Mailing list documentation.</td>
<td>
Maven automatically generates a list of mailing lists based
@@ -317,7 +317,7 @@
</td>
</tr>
<tr>
- <td>docs/team-list.html</td>
+ <td>target/docs/team-list.html</td>
<td>The list of project team members.</td>
<td>
Maven automatically generates a list of project team members based
@@ -327,7 +327,7 @@
</td>
</tr>
<tr>
- <td>docs/dependencies.html</td>
+ <td>target/docs/dependencies.html</td>
<td>The list of dependencies.</td>
<td>
Maven automatically generates a list of dependencies based
@@ -337,7 +337,7 @@
</td>
</tr>
<tr>
- <td>docs/changelog.html</td>
+ <td>target/docs/changelog.html</td>
<td>The CVS change log.</td>
<td>
Maven automatically generates a change log from CVS log
@@ -346,7 +346,7 @@
</td>
</tr>
<tr>
- <td>docs/jdepend-report.html</td>
+ <td>target/docs/jdepend-report.html</td>
<td>Metric report.</td>
<td>
Maven automatically generates a report on various <a
@@ -355,7 +355,7 @@
</td>
</tr>
<tr>
- <td>docs/junit-report.html</td>
+ <td>target/docs/junit-report.html</td>
<td>Unit test report.</td>
<td>
Maven automatically generates a report on the results of
@@ -364,7 +364,7 @@
</td>
</tr>
<tr>
- <td>docs/checkstyle-report.html</td>
+ <td>target/docs/checkstyle-report.html</td>
<td>Checkstyle report.</td>
<td>
Maven automatically generates a report on the results of
1.11 +54 -3 jakarta-turbine-maven/xdocs/ref/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/project-descriptor.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- project-descriptor.xml 2 Jun 2002 15:59:06 -0000 1.10
+++ project-descriptor.xml 3 Jun 2002 22:04:34 -0000 1.11
@@ -189,9 +189,17 @@
<tr>
<td><a href="#developers">developers</a></td>
<td>
- Describes the contributors to a project. This is used to
- generate the <a href="build-file.html#maven:docs">front page</a>
- of the site's web site.
+ Describes the committers to a project. This is used to
+ generate the <a href="build-file.html#maven:docs">Project Team</a>
+ page of the project's web site.
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#contributors">contributors</a></td>
+ <td>
+ Describes the contributors to a project. This is used to generate
+ the <a href="build-file.html#maven:docs">Project Team</a> page of
+ the project's web site.
</td>
</tr>
<tr>
@@ -377,8 +385,51 @@
<td>organization</td>
<td>The organization to which the developer belongs.</td>
</tr>
+ <tr>
+ <td>roles</td>
+ <td>
+ The roles the developer plays in the project. Each role is
+ describe by a <code>role</code> element, the body of which is a
+ role name.
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ </section>
+ <section name="contributors">
+ <p>
+ This element describes all of the contributors associated with a
+ project who are not developers. Each contributor is described by a
+ <code>contributor</code> element, which is then describe by additional
+ elements (described below). The auto-generated site documentation
+ references this information.
+ </p>
+ <subsection name="contributor">
+ <table>
+ <tr><th>Element</th><th>Description</th></tr>
+ <tr>
+ <td>name</td>
+ <td>The full name of the contributor.</td>
+ </tr>
+ <tr>
+ <td>email</td>
+ <td>The email address of the contributor.</td>
+ </tr>
+ <tr>
+ <td>organization</td>
+ <td>The organization to which the contributor belongs.</td>
+ </tr>
+ <tr>
+ <td>roles</td>
+ <td>
+ The roles the contributor plays in the project. Each role is
+ describe by a <code>role</code> element, the body of which is a
+ role name.
+ </td>
+ </tr>
</table>
</subsection>
+
</section>
<section name="dependencies">
<p>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
