Update documentation

Resolves: https://jira.duraspace.org/browse/FCREPO-1566
fcrepo-exts · Jun 4, 2015 · 446d9d6 · 446d9d6
1 parent df820d5
commit 446d9d6
Show file tree

Hide file tree

Showing 5 changed files with 77 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ with [Fedora4](http://fcrepo.org). These applications use
 
 [![Build Status](https://travis-ci.org/fcrepo4-labs/fcrepo-camel-toolbox.png?branch=master)](https://travis-ci.org/fcrepo4-labs/fcrepo-camel-toolbox)
 
+Additional background information is available on the Fedora Wiki on the
+[Integration Services page](https://wiki.duraspace.org/display/FEDORA4x/Integration+Services).
 
 ## Applications
 
@@ -73,3 +75,11 @@ Then, you can add any combination of the following applications:
     $> feature:install fcrepo-indexing-triplestore
     $> feature:install fcrepo-audit-triplestore
     $> feature:install fcrepo-reindexer
+
+##Deploying in Tomcat/Jetty
+
+If you intend to deploy this application in a web container such as Tomcat or Jetty,
+please refer to the documentation in the
+[fcrepo-camel-webapp](https://github.com/fcrepo4-labs/fcrepo-camel-toolbox/tree/master/fcrepo-camel-webapp)
+project.
+
diff --git a/fcrepo-camel-webapp/README.md b/fcrepo-camel-webapp/README.md
@@ -1,26 +1,36 @@
 #Web-Deployable Fedora/Camel integration components
 
-##Fedora Audit Service (Triplestore)
+##Building
 
-This application implements a bridge to an external, triplestore-based
-[Audit Service](https://wiki.duraspace.org/display/FF/Design+-+Audit+Service)
-for [Fedora4](http://fcrepo.org).
+This project can be built with all of the services enabled or with only
+selected services enabled.
+
+To build this with all services enabled, use
+
+    MAVEN_OPTS="-Xmx1024m" mvn install -Pis -Pit -Pat -Prs
 
-###Building
+Note: The following syntax is also valid: `mvn install -Pis,it,at,rs`
 
-To build this project with the audit service, use
+To build only the audit service, use
 
     MAVEN_OPTS="-Xmx1024m" mvn install -Pat
 
-To build this project with the solr and triplestore indexers, use
+Or, to build only the Solr indexing and reindexing service, use
 
-    MAVEN_OPTS="-Xmx1024m" mvn install -Pis -Pit
+    MAVEN_OPTS="-Xmx1024m" mvn install -Pis,rs
 
-To build this project with all four applications, use
+Any combination of services is possible, where the profile codes the following meanings:
 
-    MAVEN_OPTS="-Xmx1024m" mvn install -Pis -Pit -Pat -Prs
+* at: Audit Service (Triplestore)
+* is: Indexing Service (Solr)
+* it: Indexing Service (Triplestore)
+* rs: Reindexing Service
 
-Note: The following syntax is also valid: `mvn install -Pis,it,at,rs`
+##Fedora Audit Service (Triplestore)
+
+This application implements a bridge to an external, triplestore-based
+[Audit Service](https://wiki.duraspace.org/display/FF/Design+-+Audit+Service)
+for [Fedora4](http://fcrepo.org).
 
 ###Configuration
 
@@ -61,12 +71,6 @@ This application implements a bridge to an external triplestore,
 such as Sesame or Fuseki
 for [Fedora4](http://fcrepo.org).
 
-###Building
-
-To build this project use
-
-    MAVEN_OPTS="-Xmx1024m" mvn install -Pis
-
 ###Configuration
 
 The application can be configured by updating the following configuration
@@ -115,12 +119,6 @@ not left blank, should be a valid URI.
 This application implements a bridge to an external, solr index
 for [Fedora4](http://fcrepo.org).
 
-###Building
-
-To build this project use
-
-    MAVEN_OPTS="-Xmx1024m" mvn install -Pis
-
 ###Configuration
 
 The application can be configured by updating the following configuration
@@ -178,12 +176,6 @@ The timeframe (in milliseconds) within which new items should be committed to th
 This application implements a reindexing service for other components,
 such as fcrepo-indexing-solr or fcrepo-indexing-triplestore.
 
-###Building
-
-To build this project use
-
-    MAVEN_OPTS="-Xmx1024m" mvn install -Prs
-
 ###Configuration
 
 A number of application values can be configured externally, through

diff --git a/fcrepo-indexing-solr/README.md b/fcrepo-indexing-solr/README.md
@@ -3,6 +3,24 @@
 This application implements a bridge to an external, solr index
 for [Fedora4](http://fcrepo.org).
 
+The application relies on LDPath-based transformations to convert a resource
+from RDF into JSON. More information on the LDPath language is available on the
+[Marmotta website](http://marmotta.apache.org/ldpath/language.html). It may also
+be helpful to read about Fedora's
+[transformation API](https://wiki.duraspace.org/display/FEDORA4x/RESTful+HTTP+API+-+Transform),
+which describes how to install special purpose LDPath programs in Fedora.
+
+Additional background information is available on the Fedora Wiki on the
+[Integration Services page](https://wiki.duraspace.org/display/FEDORA4x/Integration+Services).
+
+Please also note that in order to push data into Solr, your Solr schema must
+be configured to accept the data you intend to send. This is typically accomplished
+by updating Solr's `[schema.xml](https://wiki.apache.org/solr/SchemaXml)` file,
+found in `$SOLR_HOME/<core name>/conf/` (for Solr 4.x). Starting with 5.2, Solr provides a
+[schema API](https://cwiki.apache.org/confluence/display/solr/Schema+API),
+which allows runtime (re-)configuration of Solr. Further information on using Solr
+can be found at the [Solr website](http://lucene.apache.org/solr/)
+
 ##Building
 
 To build this project use
@@ -25,6 +43,13 @@ command from its shell:
     feature:repo-add mvn:org.fcrepo.camel/fcrepo-camel-toolbox/LATEST/xml/features
     feature:install fcrepo-indexing-solr
 
+##Deploying in Tomcat/Jetty
+
+If you intend to deploy this application in a web container such as Tomcat or Jetty,
+please refer to the documentation in the
+[fcrepo-camel-webapp](https://github.com/fcrepo4-labs/fcrepo-camel-toolbox/tree/master/fcrepo-camel-webapp)
+project.
+
 ##Configuration
 
 The application can be configured by creating a file in

diff --git a/fcrepo-indexing-triplestore/README.md b/fcrepo-indexing-triplestore/README.md
@@ -1,8 +1,10 @@
 #Fedora Indexing Service (Triplestore)
 
 This application implements a bridge to an external triplestore,
-such as Sesame or Fuseki
-for [Fedora4](http://fcrepo.org).
+such as Sesame or Fuseki for [Fedora4](http://fcrepo.org).
+
+Additional background information on this service is available on the Fedora Wiki on the
+[Integration Services page](https://wiki.duraspace.org/display/FEDORA4x/Integration+Services).
 
 ##Building
 
@@ -26,6 +28,13 @@ command from its shell:
     feature:repo-add mvn:org.fcrepo.camel/fcrepo-camel-toolbox/LATEST/xml/features
     feature:install fcrepo-indexing-triplestore
 
+##Deploying in Tomcat/Jetty
+
+If you intend to deploy this application in a web container such as Tomcat or Jetty,
+please refer to the documentation in the
+[fcrepo-camel-webapp](https://github.com/fcrepo4-labs/fcrepo-camel-toolbox/tree/master/fcrepo-camel-webapp)
+project.
+
 ##Configuration
 
 The application can be configured by creating a file in

diff --git a/fcrepo-reindexing/README.md b/fcrepo-reindexing/README.md
@@ -5,6 +5,9 @@ any node hierarchy in fedora (e.g. the entire repository
 or some subset thereof) can be reindexed by a set of external
 services.
 
+Additional background information on this service is available on the Fedora Wiki on the
+[Integration Services page](https://wiki.duraspace.org/display/FEDORA4x/Integration+Services).
+
 ##Building
 
 To build this project use
@@ -27,6 +30,13 @@ command from its shell:
     feature:repo-add mvn:org.fcrepo.camel/fcrepo-camel-toolbox/LATEST/xml/features
     feature:install fcrepo-reindexing
 
+##Deploying in Tomcat/Jetty
+
+If you intend to deploy this application in a web container such as Tomcat or Jetty,
+please refer to the documentation in the
+[fcrepo-camel-webapp](https://github.com/fcrepo4-labs/fcrepo-camel-toolbox/tree/master/fcrepo-camel-webapp)
+project.
+
 ##Configuration
 
 The application can be configured by creating a file in