Author: kwright
Date: Thu Jun 20 00:07:01 2013
New Revision: 1494815
URL: http://svn.apache.org/r1494815
Log:
Add documentation
Added:
manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-configuration-save.PNG
(with props)
manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-configuration.PNG
(with props)
manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-job-jira-seed-query.PNG
(with props)
Modified:
manifoldcf/branches/CONNECTORS-723/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
manifoldcf/branches/CONNECTORS-723/site/src/documentation/skinconf.xml
Modified:
manifoldcf/branches/CONNECTORS-723/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-723/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml?rev=1494815&r1=1494814&r2=1494815&view=diff
==============================================================================
---
manifoldcf/branches/CONNECTORS-723/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
(original)
+++
manifoldcf/branches/CONNECTORS-723/site/src/documentation/content/xdocs/en_US/end-user-documentation.xml
Thu Jun 20 00:07:01 2013
@@ -1762,11 +1762,35 @@ curl -XGET http://localhost:9200/index/_
<figure
src="images/en_US/googledrive-repository-connection-job-googledrive-seed-query.PNG"
alt="googledrive Repository Connection, seed query" width="80%"/>
<br/><br/>
<p>This tab allows you to specify the query which will be used
to seed documents for the indexing process. The query language is
- specified on the <a
href="https://developers.google.com/drive/search-parameters">Drive Search
Paramters</a> site. Directories
+ specified on the <a
href="https://developers.google.com/drive/search-parameters">Drive Search
Parameters</a> site. Directories
which meet the seed query are fully crawled as the query on
applies to seeds. The default query indexes the entire drive. Lastly, native
Google
documents such as spreadsheets and word documents are exported
to PDF and then ingested.</p>
</section>
+ <section id="jirarepository">
+ <title>Jira Repository Connection</title>
+ <p>The Jira Repository Connection type allows you to index
tickets from <a href="http://www.atlassian.com/â">Atlassian</a>'s <a
href="http://www.atlassian.com/software/jira">Jira</a>.</p>
+ <p>A Jira connection has the following configuration parameters
on the repository connection editing screen:</p>
+ <br/><br/>
+ <figure
src="images/en_US/jira-repository-connection-configuration.PNG" alt="jira
Repository Connection, configuration parameters" width="80%"/>
+ <br/><br/>
+ <p>As we can see there are 3 pieces of information which are
needed to create a successful connection. The Client ID and Client Secret
+ are the username and password of a Jira account. The JiraUrl
is the base endpoint of the particular Jira Instance, for example:
+ https://searchbox.atlassian.net is the Jira version for
searchbox which is hosted at Atlassian.</p>
+ <br/><br/>
+ <p>After you click the "Save" button, you will see a connection
summary screen, which might look something like this:</p>
+ <br/><br/>
+ <figure
src="images/en_US/jira-repository-connection-configuration-save.PNG" alt="jira
Repository Connection, saving configuration" width="80%"/>
+ <br/><br/>
+ <p>When you configure a job to use the Jira repository
connection an additional tab is presented. This is the "Seed Query" tab:</p>
+ <br/><br/>
+ <figure
src="images/en_US/jira-repository-connection-job-jira-seed-query.PNG" alt="jira
Repository Connection, seed query" width="80%"/>
+ <br/><br/>
+ <p>This tab allows you to specify the query which will be used
to find documents for the indexing process. The query language is
+ specified on the <a
href="https://confluence.atlassian.com/display/JIRA/Advanced+Searching">Jira
Advanced Searching</a> site. Directories
+ which meet the seed query are fully crawled as the query on
applies to seeds.</p>
+ </section>
+
<section id="livelinkrepository">
<title>OpenText LiveLink Repository Connection</title>
<p>The LiveLink connection type allows you to index content
from LiveLink repositories. LiveLink has a rich variety of different document
types and metadata,
Added:
manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-configuration-save.PNG
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-configuration-save.PNG?rev=1494815&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-configuration-save.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-configuration.PNG
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-configuration.PNG?rev=1494815&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-configuration.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-job-jira-seed-query.PNG
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-job-jira-seed-query.PNG?rev=1494815&view=auto
==============================================================================
Binary file - no diff available.
Propchange:
manifoldcf/branches/CONNECTORS-723/site/src/documentation/resources/images/en_US/jira-repository-connection-job-jira-seed-query.PNG
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: manifoldcf/branches/CONNECTORS-723/site/src/documentation/skinconf.xml
URL:
http://svn.apache.org/viewvc/manifoldcf/branches/CONNECTORS-723/site/src/documentation/skinconf.xml?rev=1494815&r1=1494814&r2=1494815&view=diff
==============================================================================
--- manifoldcf/branches/CONNECTORS-723/site/src/documentation/skinconf.xml
(original)
+++ manifoldcf/branches/CONNECTORS-723/site/src/documentation/skinconf.xml Thu
Jun 20 00:07:01 2013
@@ -104,6 +104,7 @@ which will be used to configure the chos
QBase, MetaCarta, and GTS are trademarks of QBase, Inc.
Meridio and Autonomy are trademarks of Hewlett Packard, Inc.
Alfresco is a trademark of Alfresco Software, Inc.
+ Jira is a trademark of Atlassian, Inc.
</trademark-statement>
<!-- Some skins use this to form a 'breadcrumb trail' of links.