dsmiley commented on a change in pull request #324:
URL: https://github.com/apache/solr/pull/324#discussion_r730319754
##########
File path: solr/contrib/README.md
##########
@@ -0,0 +1,31 @@
+Apache Solr HDFS Contrib module
+===============================
+
+Introduction
+------------
+This contrib module implements the support for Hadoop Distributed File System
in Apache Solr.
+
+
+Building
+--------
+The HDFS contrib module uses the same Gradle build as the core Solr
components.
+
+To build the module, you can use
+
+./gradlew :solr:contrib:hdfs:assemble
+
+The resulting module will be placed to the libs directory, for example:
+solr/contrib/hdfs/build/libs/solr-hdfs-9.0.0-SNAPSHOT.jar
+
+
+To execute the module tests:
+
+./gradlew :solr:contrib:hdfs:test
+
+
+
+Usage
+-----
+To use the module, it needs to be placed to the Solr web application classpath
(for example by symlinking it to the WEB-INF/lib directory.)
Review comment:
I suggest we don't recommend people putting libs into WEB-INF/lib unless
it has to go there. solr-home's /lib is the ideal spot for plugins.
Any way, you can just refer to the Solr Ref Guide Page on installing plugins.
For configuration, we can refer to the Solr Ref Guide again. This way we're
not repeating ourselves.
I think it would be useful in this doc to list the handful of primary
plugins offered here: HdfsDirectoryFactory, HdfsUpdateLog, and
HdfsBackupRepository. Everything else is in servitude to those.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
