Author: dennisl
Date: Sun Mar 4 15:15:49 2007
New Revision: 514494
URL: http://svn.apache.org/viewvc?view=rev&rev=514494
Log:
o Fix typos.
o Use consistent titles and headings.
Modified:
maven/sandbox/trunk/plugins/maven-swizzle-plugin/pom.xml
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-custom-report.apt
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-release-report.apt
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/index.apt
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/usage.apt
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/fml/faq.fml
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/site.xml
Modified: maven/sandbox/trunk/plugins/maven-swizzle-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/pom.xml?view=diff&rev=514494&r1=514493&r2=514494
==============================================================================
--- maven/sandbox/trunk/plugins/maven-swizzle-plugin/pom.xml (original)
+++ maven/sandbox/trunk/plugins/maven-swizzle-plugin/pom.xml Sun Mar 4
15:15:49 2007
@@ -31,7 +31,7 @@
<artifactId>maven-swizzle-plugin</artifactId>
<packaging>maven-plugin</packaging>
<version>1.0-SNAPSHOT</version>
- <name>maven-swizzle-plugin Maven Mojo</name>
+ <name>Maven Swizzle Plugin</name>
<url>http://maven.apache.org</url>
<build>
<plugins>
Modified:
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-custom-report.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-custom-report.apt?view=diff&rev=514494&r1=514493&r2=514494
==============================================================================
---
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-custom-report.apt
(original)
+++
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-custom-report.apt
Sun Mar 4 15:15:49 2007
@@ -1,9 +1,10 @@
------
- Generating Resolved Issues Report
+ Generating A Custom Report
------
John Tolentino
------
09 December 2006
+ ------
~~ Copyright 2006 The Apache Software Foundation.
~~
@@ -22,10 +23,10 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Generating Resolved Issues Report
+Generating A Custom Report
You can use the supply your own template by providing the path where you
placed your custom
- velocity template. Generated report will be in xdoc format. See
+ velocity template. The 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
@@ -46,7 +47,7 @@
<template>unit/MyResolvedIssuesTemplate.vm</template>
<result>my-output/ResolvedIssuesActualResult.txt</result>
</configuration>
- </plugin>
+ </plugin>
</plugins>
</build>
[...]
Modified:
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-release-report.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-release-report.apt?view=diff&rev=514494&r1=514493&r2=514494
==============================================================================
---
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-release-report.apt
(original)
+++
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-release-report.apt
Sun Mar 4 15:15:49 2007
@@ -1,9 +1,10 @@
------
- Generating Resolved Issues Report
+ Generating Release Report
------
John Tolentino
------
09 December 2006
+ ------
~~ Copyright 2006 The Apache Software Foundation.
~~
@@ -22,10 +23,10 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/guides/mini/guide-apt-format.html
-Generating Resolved Issues Report
+Generating Release Report
- You can use the supplied velocity template of plexus-swizzle by specifying
- <<<RELEASE>>> as your template. Generated report will be in xdoc format. See
+ You can use this supplied velocity template of plexus-swizzle by specifying
+ <<<RELEASE>>> as your template. The 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.
@@ -93,7 +94,7 @@
<licenseCheckPassed>false</licenseCheckPassed>
<licenseCheckResultDetails>target/test-classes/unit/license-failed.txt</licenseCheckResultDetails>
</configuration>
- </plugin>
+ </plugin>
</plugins>
</build>
<scm>
@@ -112,7 +113,7 @@
*Default Values example
We're using default values already found in this project's POM or provided
through default values in the parameters
- so the configuration will be shorter:
+ so the configuration can be made shorter:
+-------+
<project>
@@ -131,7 +132,7 @@
<docckPassed>true</docckPassed>
<licenseCheckPassed>false</licenseCheckPassed>
</configuration>
- </plugin>
+ </plugin>
</plugins>
</build>
<scm>
@@ -180,7 +181,7 @@
<licenseCheckResultDetails>mytestresults/license-failed.txt</licenseCheckResultDetails>
<dateFormat>MM/dd/yy hh:mm</dateFormat>
</configuration>
- </plugin>
+ </plugin>
</plugins>
</build>
[...]
Modified:
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt?view=diff&rev=514494&r1=514493&r2=514494
==============================================================================
---
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
(original)
+++
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-resolved-issues-report.apt
Sun Mar 4 15:15:49 2007
@@ -4,6 +4,7 @@
John Tolentino
------
09 December 2006
+ ------
~~ Copyright 2006 The Apache Software Foundation.
~~
@@ -24,8 +25,8 @@
Generating Resolved Issues Report
- You can use the supplied velocity template of plexus-swizzle by specifying
- <<<RESOLVED_ISSUES>>> as your template. Generated
+ You can use this supplied velocity template of plexus-swizzle by specifying
+ <<<RESOLVED_ISSUES>>> as your template. The 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.
@@ -47,7 +48,7 @@
<template>RESOLVED_ISSUES</template>
<result>my-output/ResolvedIssuesActualResult.txt</result>
</configuration>
- </plugin>
+ </plugin>
</plugins>
</build>
[...]
@@ -75,7 +76,7 @@
<template>RESOLVED_ISSUES</template>
<result>my-output/MavenWARPluginResolvedIssues.xml</result>
</configuration>
- </plugin>
+ </plugin>
</plugins>
</build>
[...]
@@ -101,7 +102,7 @@
<projectVersion>2.0.2</projectVersion>
<result>my-output/MavenWARPluginResolvedIssues.xml</result>
</configuration>
- </plugin>
+ </plugin>
</plugins>
</build>
[...]
Modified:
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt?view=diff&rev=514494&r1=514493&r2=514494
==============================================================================
---
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
(original)
+++
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/examples/generating-votes-report.apt
Sun Mar 4 15:15:49 2007
@@ -4,6 +4,7 @@
John Tolentino
------
09 December 2006
+ ------
~~ Copyright 2006 The Apache Software Foundation.
~~
@@ -24,9 +25,9 @@
Generating Votes Report
- You can use the supplied velocity template of plexus-swizzle by specifying
+ You can use this supplied velocity template of plexus-swizzle by specifying
<<<VOTES>>> as your template. This report's main
- use is to identify issues that is of high priority to the community. Generated
+ use is to identify issues that is of high priority to the community. The
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.
@@ -48,7 +49,7 @@
<template>VOTES</template>
<result>my-output/Votes.txt</result>
</configuration>
- </plugin>
+ </plugin>
</plugins>
</build>
[...]
@@ -57,7 +58,7 @@
*Maven WAR Plugin example
- Here's an example on how to generate a report on votes made on each open
maven-war-plugin issue:
+ Here's an example on how to generate a report on votes made on open
maven-war-plugin issues:
+-------+
<project>
@@ -75,7 +76,7 @@
<template>VOTES</template>
<result>my-output/MavenWARPluginVotes.xml</result>
</configuration>
- </plugin>
+ </plugin>
</plugins>
</build>
[...]
Modified:
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/index.apt?view=diff&rev=514494&r1=514493&r2=514494
==============================================================================
--- maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/index.apt
(original)
+++ maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/index.apt Sun
Mar 4 15:15:49 2007
@@ -4,6 +4,7 @@
John Tolentino
------
09 December 2006
+ ------
~~ Copyright 2006 The Apache Software Foundation.
~~
@@ -24,16 +25,16 @@
Maven Swizzle Plugin
- The Swizzle plugin is an adaptation of David Blevin's
{{{http://swizzle.codehaus.org/Home}Swizzle}}
+ The Swizzle Plugin is an adaptation 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:
+ swizzle-plexus component can be used to generate these reports:
* {{{examples/generating-release-report.html}Release Report}}
- * {{{examples/generating-votes-report.html}Votes Report}}
-
* {{{examples/generating-resolved-issues-report.html}Resolved Issues Report}}
+ * {{{examples/generating-votes-report.html}Votes 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 address users' needs.
@@ -51,12 +52,10 @@
To provide you with better understanding on some usages of the Maven Swizzle
Plugin,
you can take a look into the following examples:
- * {{{examples/generating-release-report.html}Release Report}}
+ * {{{examples/generating-custom-report.html}Custom Report}}
- * {{{examples/generating-votes-report.html}Votes Report}}
+ * {{{examples/generating-release-report.html}Release Report}}
* {{{examples/generating-resolved-issues-report.html}Resolved Issues Report}}
- * {{{examples/generating-custom-report.html}Using custom templates}}
-
-
+ * {{{examples/generating-votes-report.html}Votes Report}}
Modified:
maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/usage.apt?view=diff&rev=514494&r1=514493&r2=514494
==============================================================================
--- maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/usage.apt
(original)
+++ maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/apt/usage.apt Sun
Mar 4 15:15:49 2007
@@ -4,6 +4,7 @@
John Tolentino
------
09 December 2006
+ ------
~~ Copyright 2006 The Apache Software Foundation.
~~
@@ -25,7 +26,7 @@
Usage
The Maven Swizzle Plugin generate reports from a project's issue tracking
system (currently only JIRA is supported).
- It requires 5 parameters--4 parameters through the ReportConfiguration and 1
for the result output path.
+ It requires 5 parameters -- 4 parameters through the ReportConfiguration and
1 for the result output path.
Here's an example:
@@ -45,7 +46,7 @@
<template>RESOLVED_ISSUES</template>
<result>my-output/MavenWARPluginResolvedIssues.xml</result>
</configuration>
- </plugin>
+ </plugin>
</plugins>
</build>
[...]
Modified: maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/fml/faq.fml?view=diff&rev=514494&r1=514493&r2=514494
==============================================================================
--- maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/fml/faq.fml
(original)
+++ maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/fml/faq.fml Sun
Mar 4 15:15:49 2007
@@ -24,10 +24,16 @@
<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-report.html">Resolved
Issues.</a></p>
- <p>You can also provide <a
href="examples/generating-custom-report.html">your own template</a> by
specifying
- the path where it's located.</p>
+ <p>
+ There are currently three templates available.
+ <a href="examples/generating-release-report.html">Release</a>,
+ <a href="examples/generating-resolved-issues-report.html">Resolved
Issues.</a>
+ and <a href="examples/generating-votes-report.html">Votes</a>.
+ </p>
+ <p>
+ You can also create a <a
href="examples/generating-custom-report.html">custom report</a> by specifying
+ the path to your own template.
+ </p>
</answer>
</faq>
</part>
Modified: maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/site.xml?view=diff&rev=514494&r1=514493&r2=514494
==============================================================================
--- maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/site.xml
(original)
+++ maven/sandbox/trunk/plugins/maven-swizzle-plugin/src/site/site.xml Sun Mar
4 15:15:49 2007
@@ -30,9 +30,10 @@
<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"/>
<item name="Generating A Custom Report"
href="examples/generating-custom-report.html"/>
+ <item name="Generating Release Report"
href="examples/generating-release-report.html"/>
+ <item name="Generating Resolved Issues Report"
href="examples/generating-resolved-issues-report.html"/>
+ <item name="Generating Votes Report"
href="examples/generating-votes-report.html"/>
</menu>
</body>
</project>
