Added FAQ for the dashboard plugin's website

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@124888 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
vmassol
2005-01-11 05:50:21 +00:00
parent c935ff204f
commit 418d3ced0c
4 changed files with 56 additions and 1 deletions

View File

@@ -23,7 +23,7 @@
<pomVersion>3</pomVersion>
<id>maven-dashboard-plugin</id>
<name>Maven Dashboard Plugin</name>
<currentVersion>1.6</currentVersion>
<currentVersion>1.7-SNAPSHOT</currentVersion>
<description>Generate a dashboard containing global statistics about other maven reports</description>
<shortDescription>Generate a statistic dashboard</shortDescription>
<url>http://maven.apache.org/reference/plugins/dashboard/</url>

View File

@@ -24,6 +24,11 @@
<author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>
<release version="1.7-SNAPSHOT" date="in CVS">
<action dev="vmassol" type="update">
Added a FAQ on the website.
</action>
</release>
<release version="1.6" date="2004-11-26">
<action dev="pkernevez" type="add" issue="MPDASHBOARD-16">Added Maven Change Log aggregators.</action>
<action dev="pkernevez" type="add" issue="MPDASHBOARD-16">Added Maven Tasks List aggregators.</action>

49
dashboard/xdocs/faq.fml Normal file
View File

@@ -0,0 +1,49 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2004 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 title="Frequently Asked Questions">
<part id="general">
<title>General</title>
<faq id="master-project-location">
<question>
Why don't any data in the generated report?
</question>
<answer>
<p>
One of the possible reason is that your master project and its subprojects are not
located in the default location the dashboard plugin expects them. by default the
plugin expects the subprojects to be located one directory below the master project.
In other words, it is looking for subprojecs using the <code>*/project.xml</code>
pattern.
</p>
<p>
This can be controlled using the following properties (shown here with their default
values:
</p>
<source><![CDATA[
maven.dashboard.basedir=${basedir}
maven.dashboard.includes=*/project.xml
maven.dashboard.excludes=**/target/**/project.xml]]></source>
</answer>
</faq>
</part>
</faqs>

View File

@@ -31,6 +31,7 @@
<item name="Properties" href="/properties.html"/>
<item name="Aggregators" href="/aggregators.html"/>
<item name="Authoring" href="/authoring.html"/>
<item name="FAQ" href="/faq.html"/>
</menu>
</body>
</project>