incubator-connectors-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1183630 - in /incubator/lcf/trunk: CHANGES.txt site/src/documentation/content/xdocs/end-user-documentation.xml site/src/documentation/resources/images/wiki-configure-server.PNG
Date Sat, 15 Oct 2011 12:44:54 GMT
Author: kwright
Date: Sat Oct 15 12:44:53 2011
New Revision: 1183630

Fix for CONNECTORS-271.  Add end user documentation for wiki connector.

  (with props)

Modified: incubator/lcf/trunk/CHANGES.txt
--- incubator/lcf/trunk/CHANGES.txt (original)
+++ incubator/lcf/trunk/CHANGES.txt Sat Oct 15 12:44:53 2011
@@ -3,6 +3,9 @@ $Id$
 ======================= 0.4-dev =====================
+CONNECTORS-271: Wiki connector now has end-user documentation.
+(Karl Wright)
 CONNECTORS-263: Long-running tests should all be moved to Maven's integration-test phase
 (Piergiorgio Lucidi)

Modified: incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml
--- incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml (original)
+++ incubator/lcf/trunk/site/src/documentation/content/xdocs/end-user-documentation.xml Sat
Oct 15 12:44:53 2011
@@ -1227,7 +1227,15 @@
             <section id="wikirepository">
                 <title>Wiki Repository Connection</title>
-                <p>COMING SOON</p>
+                <p>The Wiki repository connection type allows you to index content
from the main space of a Wiki or MediaWiki site.  The connection type uses the Wiki API
+                  in order to fetch content.  Only publicly visible documents will be indexed,
and there is thus no need of an authority for Wiki content.</p>
+                <p>A Wiki connection has only one special tab on the repository connection
editing screen: the "Server" tab.  The "Server" tab looks like this:</p>
+                <br/><br/>
+                <figure src="images/wiki-configure-server.PNG" alt="Wiki Connection, Server
tab" width="80%"/>
+                <br/><br/>
+                <p>The protocol must be selected in the "Protocol" field.  At the moment
only the "http" protocol is supported.  The server name must be provided in the "Server name"
+                      The server port must be provided in the "Port" field.  Finally, the
path part of the Wiki URL must be provided in the "Path name" field and must start with a
"/" character.</p>
+                <p>When you configure a job to use a repository connection of the Wiki
type, no additional tabs are currently presented.</p>
             <section id="jdbcrepository">

Added: incubator/lcf/trunk/site/src/documentation/resources/images/wiki-configure-server.PNG
Binary file - no diff available.

Propchange: incubator/lcf/trunk/site/src/documentation/resources/images/wiki-configure-server.PNG
    svn:mime-type = application/octet-stream

View raw message