evenisse 2004/03/28 05:57:46
Modified: jira project.xml
jira/xdocs navigation.xml
Added: jira/xdocs faq.fml
Log:
Add some faqs
Revision Changes Path
1.6 +4 -1 maven-plugins/jira/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/maven-plugins/jira/project.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- project.xml 26 Mar 2004 05:57:59 -0000 1.5
+++ project.xml 28 Mar 2004 13:57:46 -0000 1.6
@@ -24,9 +24,12 @@
<id>maven-jira-plugin</id>
<name>Maven JIRA Plug-in</name>
<currentVersion>1.1-SNAPSHOT</currentVersion>
- <description/>
+ <description>
+ This plugin download issues from Jira and create a report.
+ </description>
<shortDescription>Download issue from Jira</shortDescription>
<url>http://maven.apache.org/reference/plugins/jira/</url>
+
<issueTrackingUrl>http://jira.codehaus.org/secure/BrowseProject.jspa?id=10450</issueTrackingUrl>
<siteDirectory>/www/maven.apache.org/reference/plugins/jira/</siteDirectory>
<repository>
<connection>scm:cvs:pserver:[EMAIL
PROTECTED]:/home/cvspublic:maven-plugins/jira/</connection>
1.2 +4 -6 maven-plugins/jira/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven-plugins/jira/xdocs/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- navigation.xml 27 Mar 2004 11:28:10 -0000 1.1
+++ navigation.xml 28 Mar 2004 13:57:46 -0000 1.2
@@ -4,14 +4,12 @@
<title>Maven JIRA Plug-in</title>
<body>
<links>
- <item href="http://maven.apache.org/"; name="Maven">
- </item>
+ <item href="http://maven.apache.org/"; name="Maven"/>
</links>
<menu name="Overview">
- <item href="/goals.html" name="Goals">
- </item>
- <item href="/properties.html" name="Properties">
- </item>
+ <item href="/goals.html" name="Goals"/>
+ <item href="/properties.html" name="Properties"/>
+ <item href="/faq.html" name="FAQs"/>
</menu>
</body>
</project>
1.1 maven-plugins/jira/xdocs/faq.fml
Index: faq.fml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-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="how-use-it">
<question>
How to use this plugin?
</question>
<answer>
<p>
1. modify/double check that your project.xml has issue tracking url in the
following format :
</p>
<source><issueTrackingUrl>[JIRA URL]/BrowseProject.jspa?id=[JIRA
PROJECT ID]</issueTrackingUrl></source>
<p>Example :</p>
<source><issueTrackingUrl>http://jira.codehaus.org/secure/BrowseProject.jspa?id=10450</issueTrackingUrl></source>
<p>
2. make sure that your project allows group Anyone to view jira issues
(you may or may not need to also set your jira installation type to
public - this is in General Configuration under administration).
</p>
<p>
3. log out of jira (if you are using Remember me feature) and test your
setup
by going to url like this one:
</p>
<source>[JIRA URL]/secure/IssueNavigator.jspa?view=rss&pid=[JIRA PROJECT
ID]&sorter/field=issuekey&sorter/order=DESC&sorter/field=status&sorter/order=DESC&tempMax=1000&reset=true</source>
<p>Example :</p>
<source>http://jira.codehaus.org/secure/IssueNavigator.jspa?view=rss&pid=10450&sorter/field=issuekey&sorter/order=DESC&sorter/field=status&sorter/order=DESC&tempMax=1000&reset=true</source>
<p>
4. add this to your project.xml in reports section
</p>
<source><report>maven-jira-plugin</report></source>
<p>
5. run site:generate and you should have jira.html in your
${basedir}/target/docs directory
</p>
</answer>
</faq>
</part>
</faqs>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
