maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jtolent...@apache.org
Subject svn commit: r486989 - in /maven/sandbox/plugins/maven-swizzle-plugin: ./ src/site/ src/site/apt/ src/site/apt/examples/
Date Thu, 14 Dec 2006 06:23:29 GMT
Author: jtolentino
Date: Wed Dec 13 22:23:29 2006
New Revision: 486989

URL: http://svn.apache.org/viewvc?view=rev&rev=486989
Log:
Moved index and usage apts to its correct location. Updated examples documentation to match
changes to plugin's expected parameter and behavior.

Added:
    maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/index.apt
    maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/usage.apt
Removed:
    maven/sandbox/plugins/maven-swizzle-plugin/src/site/index.apt
    maven/sandbox/plugins/maven-swizzle-plugin/src/site/usage.apt
Modified:
    maven/sandbox/plugins/maven-swizzle-plugin/pom.xml
    maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
    maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt

Modified: maven/sandbox/plugins/maven-swizzle-plugin/pom.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/pom.xml?view=diff&rev=486989&r1=486988&r2=486989
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/pom.xml (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/pom.xml Wed Dec 13 22:23:29 2006
@@ -33,6 +33,17 @@
   <version>1.0-SNAPSHOT</version>
   <name>maven-swizzle-plugin Maven Mojo</name>
   <url>http://maven.apache.org</url>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-site-plugin</artifactId>
+        <configuration>
+          <excludeModules>org/codehaus/plexus/swizzle/**/*.vm</excludeModules>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
   <dependencies>
     <dependency>
       <groupId>org.apache.maven</groupId>

Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt?view=diff&rev=486989&r1=486988&r2=486989
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
(original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
Wed Dec 13 22:23:29 2006
@@ -25,7 +25,7 @@
 Generating Resolved Issues Report
 
  You can use the supplied velocity template of plexus-swizzle by specifying
- <<<org/codehaus/plexus/swizzle/ResolvedIssues.vm>>> as your template.
Generated
+ <<<RESOLVED_ISSUES_TEMPLATE>>> as your template. Generated
  report will be in xdoc format. See {{{http://maven.apache.org/maven-1.x/plugins/xdoc/}Maven
1.x XDoc Plug-in}}
  for more details on xdoc.
 
@@ -45,7 +45,7 @@
             <jiraServerUrl>http://jira.codehaus.org</jiraServerUrl>
             <projectKey>SWIZZLE</projectKey>
             <projectVersion>*</projectVersion>
-            <template>org/codehaus/plexus/swizzle/ResolvedIssues.vm</template>
+            <template>RESOLVED_ISSUES_TEMPLATE</template>
           </reportConfiguration>
           <result>my-output/ResolvedIssuesActualResult.txt</result>
         </configuration>

Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt?view=diff&rev=486989&r1=486988&r2=486989
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
(original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
Wed Dec 13 22:23:29 2006
@@ -25,7 +25,7 @@
 Generating Votes Report
 
  You can use the supplied velocity template of plexus-swizzle by specifying
- <<<org/codehaus/plexus/swizzle/Votes.vm>>> as your template. This report's
main
+ <<<VOTES_TEMPLATE>>> as your template. This report's main
  use is to identify issues that is of high priority to the community. Generated
  report will be in xdoc format. See {{{http://maven.apache.org/maven-1.x/plugins/xdoc/}Maven
1.x XDoc Plug-in}}
  for more details on xdoc.
@@ -46,7 +46,7 @@
             <jiraServerUrl>http://jira.codehaus.org</jiraServerUrl>
             <projectKey>SWIZZLE</projectKey>
             <projectVersion>*</projectVersion>
-            <template>org/codehaus/plexus/swizzle/Votes.vm</template>
+            <template>VOTES_TEMPLATE</template>
           </reportConfiguration>
           <result>my-output/Votes.txt</result>
         </configuration>

Added: maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/index.apt?view=auto&rev=486989
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/index.apt (added)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/index.apt Wed Dec 13 22:23:29
2006
@@ -0,0 +1,56 @@
+ ------
+ Introduction
+ ------
+ John Tolentino
+ ------
+ 09 December 2006
+
+~~ Copyright 2006 The Apache Software Foundation.
+~~
+~~ Licensed under the Apache License, Version 2.0 (the "License");
+~~ you may not use this file except in compliance with the License.
+~~ You may obtain a copy of the License at
+~~
+~~      http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+Maven Swizzle Plugin
+
+ The Swizzle plugin is an adoptation of David Blevin's {{{http://swizzle.codehaus.org/Home}Swizzle}}
+ project to generate reports from an issue tracking system (JIRA). The default templates
from the
+ swizzle-plexus component can be used to generate two reports:
+
+ * {{{examples/generating-votes-report.html}Votes Report}}
+ 
+ * {{{examples/generating-resolved-issues-report.html}Resolved Issues Report}}
+
+ The plugin's aim is to help developers check their project's health (through resolved issues
report) and
+ identify which issues to prioritize (through votes report). Using both reports could help
the project
+ perform a release more often as well as answer users' needs.
+
+* Goal Overview
+
+ * {{{generate-mojo.html}swizzle:generate}} is the default goal. This goal isn't bound to
any phase.
+
+* Usage
+
+  Instructions on how to use the Maven WAR Plugin can be found {{{usage.html}here}}.
+
+* Examples
+
+ To provide you with better understanding on some usages of the Maven WAR Plugin,
+ you can take a look into the following examples:
+
+ * {{{examples/adding-filtering-webresources.html}Adding and Filtering External Web Resources}}
+
+ * {{{examples/war-overlay.html}Manipulating WAR Overlays}}
+
+

Added: maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/usage.apt?view=auto&rev=486989
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/usage.apt (added)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/usage.apt Wed Dec 13 22:23:29
2006
@@ -0,0 +1,29 @@
+ ------
+ Usage
+ ------
+ John Tolentino
+ ------
+ 09 December 2006
+
+~~ Copyright 2006 The Apache Software Foundation.
+~~
+~~ Licensed under the Apache License, Version 2.0 (the "License");
+~~ you may not use this file except in compliance with the License.
+~~ You may obtain a copy of the License at
+~~
+~~      http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing, software
+~~ distributed under the License is distributed on an "AS IS" BASIS,
+~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+~~ See the License for the specific language governing permissions and
+~~ limitations under the License.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+Usage
+
+ There's only one goal for the swizzle-maven-plugin:
+ * <<<swizzle:generate>>>
+



Mime
View raw message