LUCENE-4006: Add system requirements page (markdown)

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1398564 13f79535-47bb-0310-9956-ffa450edef68

lucene/SYSTEM_REQUIREMENTS.txt

@@ -0,0 +1,16 @@
+# System Requirements 
+
+Apache Solr runs of Java 6 or greater. When using Java 7, be sure to 
+install at least Update 1! With all Java versions it is strongly 
+recommended to not use experimental `-XX` JVM options. It is also 
+recommended to always use the latest update version of your Java VM, 
+because bugs may affect Solr. An overview of known JVM bugs can be 
+found on http://wiki.apache.org/lucene-java/SunJavaBugs. 
+
+CPU, disk and memory requirements are based on the many choices made in 
+implementing Solr (document size, number of documents, and number of 
+hits retrieved to name a few). The benchmarks page has some information 
+related to performance on particular platforms. 
+
+*To build Apache Solr from source, refer to the `BUILD.txt` file in 
+the distribution directory.* 

lucene/build.xml

@@ -33,6 +33,7 @@
   <patternset id="binary.root.dist.patterns"
               includes="LICENSE.txt,NOTICE.txt,README.txt,
                         MIGRATE.txt,JRE_VERSION_MIGRATION.txt,
+                        SYSTEM_REQUIREMENTS.txt,
                         CHANGES.txt,
                         **/lib/*.jar,
                         licenses/**,
@@ -297,7 +298,7 @@
     </xslt>
     
     <pegdown todir="${javadoc.dir}">
-      <fileset dir="." includes="MIGRATE.txt,JRE_VERSION_MIGRATION.txt"/>
+      <fileset dir="." includes="MIGRATE.txt,JRE_VERSION_MIGRATION.txt,SYSTEM_REQUIREMENTS.txt"/>
       <globmapper from="*.txt" to="*.html"/>
     </pegdown>
 

lucene/site/xsl/index.xsl

@@ -63,6 +63,7 @@
         <h2>Reference Documents</h2>
           <ul>
             <li><a href="changes/Changes.html">Changes</a>: List of changes in this release.</li>
+            <li><a href="SYSTEM_REQUIREMENTS.html">System Requirements</a>: Minimum and supported Java versions.</li>
             <li><a href="MIGRATE.html">Migration Guide</a>: What changed in Lucene 4; how to migrate code from Lucene 3.x.</li>
             <li><a href="JRE_VERSION_MIGRATION.html">JRE Version Migration</a>: Information about upgrading between major JRE versions.</li>
             <li><a href="core/org/apache/lucene/codecs/lucene41/package-summary.html#package_description">File Formats</a>: Guide to the supported index format used by Lucene.  This can be customized by using <a href="core/org/apache/lucene/codecs/package-summary.html#package_description">an alternate codec</a>.</li>

solr/SYSTEM_REQUIREMENTS.txt

@@ -0,0 +1,16 @@
+# System Requirements 
+
+Apache Lucene runs of Java 6 or greater. When using Java 7, be sure to 
+install at least Update 1! With all Java versions it is strongly 
+recommended to not use experimental `-XX` JVM options. It is also 
+recommended to always use the latest update version of your Java VM, 
+because bugs may affect Lucene. An overview of known JVM bugs can be 
+found on http://wiki.apache.org/lucene-java/SunJavaBugs. 
+
+CPU, disk and memory requirements are based on the many choices made in 
+implementing Lucene (document size, number of documents, and number of 
+hits retrieved to name a few). The benchmarks page has some information 
+related to performance on particular platforms. 
+
+*To build Apache Lucene from source, refer to the `BUILD.txt` file in 
+the distribution directory.*

solr/build.xml

@@ -144,7 +144,7 @@
     depends="javadocs,changes-to-html,process-webpages"/>
   <target name="compile-core" depends="compile-solr-core" unless="solr.core.compiled"/>
   
-  <target name="process-webpages" depends="define-lucene-javadoc-url"><!--depends="resolve-groovy,resolve-pegdown">-->
+  <target name="process-webpages" depends="define-lucene-javadoc-url,resolve-groovy,resolve-pegdown">
     <makeurl property="process-webpages.buildfiles" separator="|">
       <fileset dir="." includes="core/build.xml,test-framework/build.xml,solrj/build.xml,contrib/**/build.xml"/>
     </makeurl>
@@ -163,12 +163,10 @@
       <param name="luceneJavadocUrl" expression="${lucene.javadoc.url}"/>
     </xslt>
     
-    <!--nothing at the moment:
     <pegdown todir="${javadoc.dir}">
-      <fileset dir="." includes="MIGRATE.txt,JRE_VERSION_MIGRATION.txt"/>
+      <fileset dir="." includes="SYSTEM_REQUIREMENTS.txt"/>
       <globmapper from="*.txt" to="*.html"/>
     </pegdown>
-    -->
 
     <copy todir="${javadoc.dir}">
       <fileset dir="site/html" includes="**/*"/>
@@ -439,8 +437,8 @@
     <tar destfile="${package.dir}/${fullnamever}.tgz" compression="gzip" longfile="gnu">
       <tarfileset dir="."
                   prefix="${fullnamever}"
-                  includes="LICENSE.txt NOTICE.txt CHANGES.txt README.txt example/**
-                            client/README.txt client/ruby/solr-ruby/** 
+                  includes="LICENSE.txt NOTICE.txt CHANGES.txt README.txt SYSTEM_REQUIREMENTS.txt
+                            example/** client/README.txt client/ruby/solr-ruby/** 
                             contrib/**/lib/** contrib/**/README.txt 
                             licenses/**"
                   excludes="lib/README.committers.txt **/data/ **/logs/* 

solr/site/xsl/index.xsl

@@ -56,6 +56,7 @@
         <h2>Reference Documents</h2>
           <ul>
             <li><a href="changes/Changes.html">Changes</a>: List of changes in this release.</li>
+            <li><a href="SYSTEM_REQUIREMENTS.html">System Requirements</a>: Minimum and supported Java versions.</li>
             <li><a href="tutorial.html">Solr Tutorial</a>: This document covers the basics of running Solr using an example schema, and some sample data.</li>
             <li><a href="{$luceneJavadocUrl}index.html">Lucene Documentation</a></li>
           </ul>