Author: jtolentino
Date: Fri Dec 8 13:52:10 2006
New Revision: 484810
URL: http://svn.apache.org/viewvc?view=rev&rev=484810
Log:
Updated documentation.
Added:
maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
Modified:
maven/sandbox/plugins/maven-swizzle-plugin/src/main/java/org/apache/maven/plugin/swizzle/ReportMojo.java
maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
maven/sandbox/plugins/maven-swizzle-plugin/src/site/fml/faq.fml
maven/sandbox/plugins/maven-swizzle-plugin/src/site/index.apt
maven/sandbox/plugins/maven-swizzle-plugin/src/site/site.xml
maven/sandbox/plugins/maven-swizzle-plugin/src/site/usage.apt
Modified:
maven/sandbox/plugins/maven-swizzle-plugin/src/main/java/org/apache/maven/plugin/swizzle/ReportMojo.java
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/main/java/org/apache/maven/plugin/swizzle/ReportMojo.java?view=diff&rev=484810&r1=484809&r2=484810
==============================================================================
---
maven/sandbox/plugins/maven-swizzle-plugin/src/main/java/org/apache/maven/plugin/swizzle/ReportMojo.java
(original)
+++
maven/sandbox/plugins/maven-swizzle-plugin/src/main/java/org/apache/maven/plugin/swizzle/ReportMojo.java
Fri Dec 8 13:52:10 2006
@@ -42,12 +42,22 @@
private JiraReport report;
/**
+ * Configuration for the reports. Four values are expected. jiraServerUrl
is the base url of the JIRA where the
+ * data of the report will be retrieved. projectKey is the code used to
uniquely identify your project.
+ * projectVersion is a filter for the project's version number (you may
use wild cards). template is the velocity
+ * macro template to use to generate the report. There are currently two
templates supplied by plexus-swizzle,
+ * org/codehaus/plexus/swizzle/ResolvedIssues.vm and
org/codehaus/plexus/swizzle/Votes.vm
+ *
* @parameter
+ * @required
*/
private ReportConfiguration reportConfiguration;
/**
+ * Name of the file to write the result of the report.
+ *
* @parameter
+ * @required
*/
private String result;
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=484810&r1=484809&r2=484810
==============================================================================
---
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
Fri Dec 8 13:52:10 2006
@@ -1 +1,57 @@
-just a template. will fill this up later.
\ No newline at end of file
+ ------
+ Generating Resolved Issues Report
+ ------
+ 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
+
+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
+ 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.
+
+*POM configuration
+
++-------+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-swizzle-plugin</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <configuration>
+ <reportConfiguration>
+ <jiraServerUrl>http://jira.codehaus.org</jiraServerUrl>
+ <projectKey>SWIZZLE</projectKey>
+ <projectVersion>*</projectVersion>
+ <template>org/codehaus/plexus/swizzle/ResolvedIssues.vm</template>
+ </reportConfiguration>
+ <result>my-output/ResolvedIssuesActualResult.txt</result>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++-------+
Added:
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=auto&rev=484810
==============================================================================
---
maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
(added)
+++
maven/sandbox/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
Fri Dec 8 13:52:10 2006
@@ -0,0 +1,58 @@
+ ------
+ Generating Votes Report
+ ------
+ 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
+
+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
+ 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.
+
+*POM configuration
+
++-------+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-swizzle-plugin</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <configuration>
+ <reportConfiguration>
+ <jiraServerUrl>http://jira.codehaus.org</jiraServerUrl>
+ <projectKey>SWIZZLE</projectKey>
+ <projectVersion>*</projectVersion>
+ <template>org/codehaus/plexus/swizzle/Votes.vm</template>
+ </reportConfiguration>
+ <result>my-output/Votes.txt</result>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++-------+
Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/fml/faq.fml?view=diff&rev=484810&r1=484809&r2=484810
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/fml/faq.fml (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/fml/faq.fml Fri Dec 8
13:52:10 2006
@@ -1 +1,32 @@
-This is a new plugin. No FAQs yet.
\ No newline at end of file
+<?xml version="1.0"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you 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.
+-->
+
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="availableTemplates">
+ <question>What templates can I use to generate reports?</question>
+ <answer>
+ <p>There are currently two templates available. <a
href="examples/generating-votes-report.html">Votes</a>
+ and <a href="examples/generating-resolved-issues.html">Resolved
Issues.</a></p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/index.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/index.apt?view=diff&rev=484810&r1=484809&r2=484810
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/index.apt (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/index.apt Fri Dec 8
13:52:10 2006
@@ -1 +1,55 @@
-just a template. will fill this up later.
\ No newline at end of file
+ ------
+ 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:
+
+ * {{{usage/generating-votes-report.html}Votes Report}}
+ * {{{usage/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}}
+
+
Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/site.xml?view=diff&rev=484810&r1=484809&r2=484810
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/site.xml (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/site.xml Fri Dec 8
13:52:10 2006
@@ -30,6 +30,7 @@
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Examples">
+ <item name="Generating Votes Report"
href="examples/generating-votes-report.html"/>
<item name="Generating Resolved Issues Report"
href="examples/generating-resolved-issues-report.html"/>
</menu>
</body>
Modified: maven/sandbox/plugins/maven-swizzle-plugin/src/site/usage.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/plugins/maven-swizzle-plugin/src/site/usage.apt?view=diff&rev=484810&r1=484809&r2=484810
==============================================================================
--- maven/sandbox/plugins/maven-swizzle-plugin/src/site/usage.apt (original)
+++ maven/sandbox/plugins/maven-swizzle-plugin/src/site/usage.apt Fri Dec 8
13:52:10 2006
@@ -1 +1,29 @@
-just a template. will fill this up later.
\ No newline at end of file
+ ------
+ 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>>>
+
