Author: vsiveton
Date: Wed Aug 9 13:42:59 2006
New Revision: 430140
URL: http://svn.apache.org/viewvc?rev=430140&view=rev
Log:
MPIR-50: review plugin documentation
o add a faq
o general correction: layout, links, tips...
o removed samples reports
o samples point to the maven generated ones as suggested in MPIR-46
Added:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/fml/
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/fml/faq.fml
(with props)
Removed:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/resources/
Modified:
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/index.apt
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/site.xml
Modified:
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=430140&r1=430139&r2=430140&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/individual-reports.apt
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/examples/individual-reports.apt
Wed Aug 9 13:42:59 2006
@@ -9,27 +9,7 @@
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.
+ Each Individual reports can be generated without configuring anything in the
<<<pom.xml>>>, check the table in
+ {{{../plugin-info.html}Goals}} for the complete goals list.
<<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
|
-*---------------------------------+----------------------------------------------+
-
Modified:
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=430140&r1=430139&r2=430140&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/index.apt
Wed Aug 9 13:42:59 2006
@@ -8,54 +8,56 @@
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 |
-*------------------------------------------------------------------+-------------------------------------------------------------------------+
+ The Maven Project Info Reports plugin is used to generate reports information
about the project.
* Goals Overview
- General Information about the goals. check the links on the table above.
+ The Project Info Reports Plugin has ten goals:
+
+ * {{{cim-mojo.html}project-info-reports:cim}} is used to generate the
Project Continuous Integration
+ System report.
+
+ * {{{dependencies-mojo.html}project-info-reports:dependencies}} is used to
generate the Project Dependencies
+ report.
+
+ *
{{{dependency-convergence-mojo.html}project-info-reports:dependency-convergence}}
is used to generate the
+ Project Dependency Convergence report for reactor builds.
+
+ * {{{issue-tracking-mojo.html}project-info-reports:issue-tracking}} is used
to generate the Project Issue
+ Tracking report.
+
+ * {{{license-mojo.html}project-info-reports:license}} is used to generate
the Project License report.
+
+ * {{{mailing-list-mojo.html}project-info-reports:mailing-list}} is used to
generate the Project Mailing
+ List report.
+
+ * {{{index-mojo.html}project-info-reports:index}} is used to generate the
Project index page.
+
+ * {{{summary-mojo.html}project-info-reports:summary}} is used to generate
the Project information reports
+ summary.
+
+ * {{{scm-mojo.html}project-info-reports:scm}} is used to generate the
Project Source Code Management report.
+
+ * {{{project-team-mojo.html}project-info-reports:project-team}} is used to
generate the Project Team report.
* Usage
- Instructions on how to use the Plugin Name can be found {{{usage.html}here}}.
+ Instructions on how to use the Maven Project Info Reports Plugin 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}}
+ * {{{examples/selective-project-info-reports.html}Running selective project
info reports}}
+
+ * {{{examples/individual-reports.html}Running Individual Reports}}
+
+ * {{{project-info.html}Overview of the reports generated for this plugin}}
-Related Links
+* Related Links
-
{{{http://maven.apache.org/plugins/maven-site-plugin/i18n.html}Internationalization}}
+ *
{{{http://maven.apache.org/plugins/maven-site-plugin/i18n.html}Internationalization}}
-
{{{http://maven.apache.org/plugins/maven-site-plugin/examples/creatingskins.html}Skinning}}
+ *
{{{http://maven.apache.org/plugins/maven-site-plugin/examples/creatingskins.html}Skinning}}
Modified:
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=430140&r1=430139&r2=430140&view=diff
==============================================================================
---
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt
(original)
+++
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/apt/usage.apt
Wed Aug 9 13:42:59 2006
@@ -15,7 +15,7 @@
Simply running
+------------+
- mvn site:site
+ mvn site
+------------+
would generate the project information documentation. For more information on
how to customize the project information
Added:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-project-info-reports-plugin/src/site/fml/faq.fml?rev=430140&view=auto
==============================================================================
--- maven/plugins/trunk/maven-project-info-reports-plugin/src/site/fml/faq.fml
(added)
+++ maven/plugins/trunk/maven-project-info-reports-plugin/src/site/fml/faq.fml
Wed Aug 9 13:42:59 2006
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+
+<!--
+ ~ 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.
+ -->
+
+<faqs id="FAQ" title="Frequently Asked Questions">
+ <part id="General">
+ <faq id="Is it possible to customize the labels of the Project Reports
Menu">
+ <question>Is it possible to customize the labels of the Project Reports
Menu?</question>
+ <answer>
+ <p>
+ Not yet. See the related issue: <a
href="http://jira.codehaus.org/browse/MPIR-35";>MPIR-35</a>
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
Propchange:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/fml/faq.fml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/plugins/trunk/maven-project-info-reports-plugin/src/site/fml/faq.fml
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
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=430140&r1=430139&r2=430140&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 Wed
Aug 9 13:42:59 2006
@@ -34,20 +34,11 @@
<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" -->
+ <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"/>
- <item name="Mailing Lists" href="sample-mail-lists.html"/>
- <item name="Continous Integration" href="sample-integration.html"/>
- <item name="Source Repository" href="sample-source-repository.html"/>
- <item name="Issue Tracking" href="sample-issue-tracking.html"/>
- <item name="Project Team" href="sample-team-list.html"/>
- <item name="License" href="sample-license.html"/>
</menu>
${reports}
</body>
