Author: vsiveton
Date: Sat Jul 29 05:05:36 2006
New Revision: 426783
URL: http://svn.apache.org/viewvc?rev=426783&view=rev
Log:
PR: MPIR-50: review plugin documentation
Submitted by: Marvin King
Reviewed by: Vincent Siveton
o Added documentation
o Removed <mailingLists/> in pom (now inherited)
Added:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/individual-reports.apt
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/selective-project-info-reports.apt
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt
Removed:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/howto.apt
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/introduction.apt
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/pom.xml
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-project-info-reports-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/pom.xml?rev=426783&r1=426782&r2=426783&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/pom.xml Sat Jul 29
05:05:36 2006
@@ -20,7 +20,7 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>1</version>
+ <version>2-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-project-info-reports-plugin</artifactId>
@@ -32,56 +32,6 @@
<system>JIRA</system>
<url>http://jira.codehaus.org/browse/MPIR</url>
</issueManagement>
- <mailingLists>
- <!-- duplication from maven-plugins pom - temporary until they inherit
properly -->
- <mailingList>
- <name>Maven User List</name>
- <subscribe>[EMAIL PROTECTED]</subscribe>
- <unsubscribe>[EMAIL PROTECTED]</unsubscribe>
- <post>[email protected]</post>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-users</archive>
- <otherArchives>
-
<otherArchive>http://www.mail-archive.com/[email protected]/</otherArchive>
-
<otherArchive>http://www.nabble.com/Maven---Users-f178.html</otherArchive>
- </otherArchives>
- </mailingList>
- <mailingList>
- <name>Maven Developer List</name>
- <subscribe>[EMAIL PROTECTED]</subscribe>
- <unsubscribe>[EMAIL PROTECTED]</unsubscribe>
- <post>[email protected]</post>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-dev</archive>
- </mailingList>
- <mailingList>
- <name>Maven Commits List</name>
- <subscribe>[EMAIL PROTECTED]</subscribe>
- <unsubscribe>[EMAIL PROTECTED]</unsubscribe>
- <post>[email protected]</post>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-dev</archive>
- </mailingList>
- <!-- duplication from maven-parent pom - temporary until they inherit
properly -->
- <mailingList>
- <name>Maven Announcements List</name>
- <post>[email protected]</post>
- <subscribe>[EMAIL PROTECTED]</subscribe>
- <unsubscribe>[EMAIL PROTECTED]</unsubscribe>
-
<archive>http://mail-archives.apache.org/mod_mbox/maven-announce/</archive>
- </mailingList>
- <mailingList>
- <name>Maven Issues List</name>
- <post>[email protected]</post>
- <subscribe>[EMAIL PROTECTED]</subscribe>
- <unsubscribe>[EMAIL PROTECTED]</unsubscribe>
- <archive>http://mail-archives.apache.org/mod_mbox/maven-issues/</archive>
- </mailingList>
- <mailingList>
- <name>Maven Notifications List</name>
- <post>[email protected]</post>
- <subscribe>[EMAIL PROTECTED]</subscribe>
- <unsubscribe>[EMAIL PROTECTED]</unsubscribe>
-
<archive>http://mail-archives.apache.org/mod_mbox/maven-notifications/</archive>
- </mailingList>
- </mailingLists>
<contributors>
<contributor>
<name>Johnny R. Ruiz III</name>
Added:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/individual-reports.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/individual-reports.apt?rev=426783&view=auto
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/individual-reports.apt
(added)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/individual-reports.apt
Sat Jul 29 05:05:36 2006
@@ -0,0 +1,35 @@
+ ------
+ Maven 2 Project Info Report Plugin - running selective reports
+ ------
+ Johnny R. Ruiz III
+ <[EMAIL PROTECTED]>
+ Pete Marvin King
+ ------
+ 28 July 2006
+
+Run Individual Report
+
+ Each Individual reports can be generated without configuring anything in the
<<<pom.xml>>>, check the table below
+ for the command line of each project information reports.
+
+ <<The generated reports using this method does not contain any navigational
links.>>
+
+*---------------------------------+----------------------------------------------+
+|<<Report Name>> | <<Command Line>>
|
+| |
|
+*---------------------------------+----------------------------------------------+
+|Dependencies Report | mvn project-info-reports:dependencies
|
+*---------------------------------+----------------------------------------------+
+|Mailing Lists | mvn project-info-reports:mailing-list
|
+*---------------------------------+----------------------------------------------+
+|Continous Integration | mvn project-info-reports:cim
|
+*---------------------------------+----------------------------------------------+
+|Source Repository | mvn project-info-reports:scm
|
+*---------------------------------+----------------------------------------------+
+|Issue Tracking | mvn project-info-reports:issue-tracking
|
+*---------------------------------+----------------------------------------------+
+|Project Team | mvn project-info-reports:project-team
|
+*---------------------------------+----------------------------------------------+
+|License | mvn project-info-reports:license
|
+*---------------------------------+----------------------------------------------+
+
Added:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/selective-project-info-reports.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/selective-project-info-reports.apt?rev=426783&view=auto
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/selective-project-info-reports.apt
(added)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/selective-project-info-reports.apt
Sat Jul 29 05:05:36 2006
@@ -0,0 +1,43 @@
+ ------
+ Maven 2 Project Info Report Plugin - running selective reports
+ ------
+ Johnny R. Ruiz III
+ <[EMAIL PROTECTED]>
+ Pete Marvin King
+ ------
+ 26 July 2006
+
+Run Selective Reports
+
+ To run the reports selectively, you can configure it to include only the
reports that you prefer.
+ Use "mvn site:site" to generate the selected reports.
+
++-----------------+
+ <project>
+ [...]
+ <reporting>
+ [...]
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>dependencies</report>
+ <report>project-team</report>
+ <report>mailing-list</report>
+ <report>cim</report>
+ <report>issue-tracking</report>
+ <report>license</report>
+ <report>scm</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ [...]
+ <reporting>
+ [...]
+ </project>
++-----------------+
Added:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt?rev=426783&view=auto
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt
(added)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt
Sat Jul 29 05:05:36 2006
@@ -0,0 +1,61 @@
+ ------
+ Maven 2 Project Info Reports Plugin
+ ------
+ Johnny R. Ruiz III
+ <[EMAIL PROTECTED]>
+ ------
+ September 22, 2005
+
+Maven Project Info Reports Plugin
+
+ This is a plugin that generates reports information about the project. The
reports being generated are as follows:
+
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|<<Report Name>> |
<<Description>> |
+| |
|
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|{{{dependencies-mojo.html}Dependencies Report}} | Project
Dependencies and Transitive Dependencies Report |
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|{{{mailing-list-mojo.html}Mailing Lists}} | Project
Mailing List |
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|{{{cim-mojo.html}Continous Integration}} | Continous
Integration used by the Project (System Name, URL, Notifiers) |
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|{{{scm-mojo.html}Source Repository}} | Source
Code Manager used by the Project. This report shows how to access|
+| | the
source code (Anonymous access, Dev access, Web access, etc.) |
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|{{{issue-tracking-mojo.html}Issue Tracking}} | Issue
Tracking System used by the Project. (URL) |
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|{{{project-team-mojo.html}Project Team}} |
Project Team Members, Developers, and Contributors |
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|{{{license-mojo.html}License}} | License
of the project |
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|{{{dependency-convergence-mojo.html}Dependency Convergence}} |
Dependency Convergence for reactor builds |
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|{{{index-mojo.html}Index}} | Project
index |
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+|{{{summary-mojo.html}Summary}} | Project
information reports summary |
+*------------------------------------------------------------------+-------------------------------------------------------------------------+
+
+* Goals Overview
+
+ General Information about the goals. check the links on the table above.
+
+* Usage
+
+ Instructions on how to use the Plugin Name can be found {{{usage.html}here}}.
+
+* Examples
+
+ To provide you with better understanding on some usages of the Maven Project
Info Reports Plugin,
+ you can take a look into the following examples:
+
+ {{{examples/selective-project-info-reports.html}Running selective project
info reports}}
+
+ {{{examples/individual-reports.html}Running Individual Reports}}
+
+Related Links
+
+
{{{http://maven.apache.org/plugins/maven-site-plugin/i18n.html}Internationalization}}
+
+
{{{http://maven.apache.org/plugins/maven-site-plugin/examples/creatingskins.html}Skinning}}
+
Added:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt?rev=426783&view=auto
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt
(added)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt
Sat Jul 29 05:05:36 2006
@@ -0,0 +1,27 @@
+ ------
+ Maven 2 Project Info Report Plugin
+ ------
+ Johnny R. Ruiz III
+ <[EMAIL PROTECTED]>
+ Pete Marvin King
+ ------
+ September 20, 2005
+
+Introduction
+
+ Maven has been configured to run the project info reports by default. There's
no need to configure anything in
+ your <<<pom.xml>>> to generate all the project information reports.
+
+ Simply running
+
++------------+
+ mvn site:site
++------------+
+
+ would generate the project information documentation. For more information on
how to customize the project information
+ plugin, check the examples on the {{{index.html}Introduction}} page.
+
+
+
+
+
Modified:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml?rev=426783&r1=426782&r2=426783&view=diff
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml
(original)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml Sat
Jul 29 05:05:36 2006
@@ -31,8 +31,14 @@
</links>
<menu name="Overview">
- <item name="Introduction" href="introduction.html"/>
- <item name="How to Use" href="howto.html"/>
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
+ <item name="Usage" href="usage.html"/>
+ <!-- item name="FAQ" href="faq.html" -->
+ </menu>
+ <menu name="Examples">
+ <item name="Selective Reports"
href="examples/selective-project-info-reports.html"/>
+ <item name="Individual Reports"
href="examples/individual-reports.html"/>
</menu>
<menu name="Sample Reports">
<item name="Dependencies" href="sample-dependencies.html"/>
