Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add some faqs

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114944 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
evenisse 2004-03-28 13:57:46 +00:00
parent 0e8a1630b6
commit 41f14e1189
3 changed files with 68 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
jira/project.xml
View File

@ -24,9 +24,12 @@
<id>maven-jira-plugin</id> <id>maven-jira-plugin</id>
<name>Maven JIRA Plug-in</name> <name>Maven JIRA Plug-in</name>
<currentVersion>1.1-SNAPSHOT</currentVersion> <currentVersion>1.1-SNAPSHOT</currentVersion>
<description/> <description>
This plugin download issues from Jira and create a report.
</description>
<shortDescription>Download issue from Jira</shortDescription> <shortDescription>Download issue from Jira</shortDescription>
<url>http://maven.apache.org/reference/plugins/jira/</url> <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> <siteDirectory>/www/maven.apache.org/reference/plugins/jira/</siteDirectory>
<repository> <repository>
<connection>scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:maven-plugins/jira/</connection> <connection>scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:maven-plugins/jira/</connection>

60
jira/xdocs/faq.fml Normal file
View File

@ -0,0 +1,60 @@
<?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>&lt;issueTrackingUrl&gt;[JIRA URL]/BrowseProject.jspa?id=[JIRA PROJECT ID]&lt;/issueTrackingUrl&gt;</source>
<p>Example :</p>
<source>&lt;issueTrackingUrl&gt;http://jira.codehaus.org/secure/BrowseProject.jspa?id=10450&lt;/issueTrackingUrl&gt;</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&amp;pid=[JIRA PROJECT ID]&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;sorter/field=status&amp;sorter/order=DESC&amp;tempMax=1000&amp;reset=true</source>
<p>Example :</p>
<source>http://jira.codehaus.org/secure/IssueNavigator.jspa?view=rss&amp;pid=10450&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;sorter/field=status&amp;sorter/order=DESC&amp;tempMax=1000&amp;reset=true</source>
<p>
4. add this to your project.xml in reports section
</p>
<source>&lt;report&gt;maven-jira-plugin&lt;/report&gt;</source>
<p>
5. run site:generate and you should have jira.html in your ${basedir}/target/docs directory
</p>
</answer>
</faq>
</part>
</faqs>

10
jira/xdocs/navigation.xml
View File

@ -4,14 +4,12 @@
<title>Maven JIRA Plug-in</title> <title>Maven JIRA Plug-in</title>
<body> <body>
<links> <links>
<item href="http://maven.apache.org/" name="Maven"> <item href="http://maven.apache.org/" name="Maven"/>
</item>
</links> </links>
<menu name="Overview"> <menu name="Overview">
<item href="/goals.html" name="Goals"> <item href="/goals.html" name="Goals"/>
</item> <item href="/properties.html" name="Properties"/>
<item href="/properties.html" name="Properties"> <item href="/faq.html" name="FAQs"/>
</item>
</menu> </menu>
</body> </body>
</project> </project>