You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by th...@apache.org on 2020/09/14 16:38:36 UTC

[lucene-solr] 18/39: LUCENE-9475: Enhance the Gradle build as necessary after removing Ant support, some minor text changes to solr/README.md and help.gradle

This is an automated email from the ASF dual-hosted git repository.

thelabdude pushed a commit to branch reference_impl_gradle_updates
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git

commit 568b0061a8310dc91bf85f3fe9a6b3d194ee416a
Author: Erick Erickson <Er...@gmail.com>
AuthorDate: Sun Sep 6 17:15:56 2020 -0400

    LUCENE-9475: Enhance the Gradle build as necessary after removing Ant support, some minor text changes to solr/README.md and help.gradle
---
 gradle/help.gradle |  3 +++
 solr/README.md     | 31 +++++++++++++++++++------------
 2 files changed, 22 insertions(+), 12 deletions(-)

diff --git a/gradle/help.gradle b/gradle/help.gradle
index 51435e1..e03d724 100644
--- a/gradle/help.gradle
+++ b/gradle/help.gradle
@@ -46,10 +46,13 @@ configure(rootProject) {
       println ""
       println "This is an experimental Lucene/Solr gradle build. See some"
       println "guidelines, ant-equivalent commands etc. under help/*; or type:"
+      println ""
       helpFiles.each { section, path, sectionInfo ->
         println String.format(Locale.ROOT,
             "  gradlew :help%-16s # %s", section, sectionInfo)
       }
+      println ""
+      println "For the impatient, build the project with 'gradlew assemble' or 'gradlew dev' "
     }
   }
 
diff --git a/solr/README.md b/solr/README.md
index 176e007..2401e2b 100644
--- a/solr/README.md
+++ b/solr/README.md
@@ -29,7 +29,9 @@ https://lucene.apache.org/solr
 Getting Started
 ---------------
 
-To start Solr for the first time after installation, simply do:
+All the following commands are entered from the "solr" directory which should be just below the install directory
+
+To start Solr for the first time after installation, simply enter:
 
 ```
   bin/solr start
@@ -38,20 +40,20 @@ To start Solr for the first time after installation, simply do:
 This will launch a standalone Solr server in the background of your shell,
 listening on port 8983. Alternatively, you can launch Solr in "cloud" mode,
 which allows you to scale out using sharding and replication. To launch Solr
-in cloud mode, do:
+in cloud mode, enter:
 
 ```
   bin/solr start -cloud
 ```
 
-To see all available options for starting Solr, please do:
+To see all available options for starting Solr, please enter:
 
 ```
   bin/solr start -help
 ```
 
 After starting Solr, create either a core or collection depending on whether
-Solr is running in standalone (core) or SolrCloud mode (collection) by doing:
+Solr is running in standalone (core) or SolrCloud mode (collection) by entering:
 
 ```
   bin/solr create -c <name>
@@ -59,7 +61,7 @@ Solr is running in standalone (core) or SolrCloud mode (collection) by doing:
 
 This will create a collection that uses a data-driven schema which tries to guess
 the correct field type when you add documents to the index. To see all available
-options for creating a new collection, execute:
+options for creating a new collection, enter:
 
 ```
   bin/solr create -help
@@ -84,21 +86,20 @@ where more than one Solr is running on the machine.
 Solr Examples
 ---------------
 
-Solr includes a few examples to help you get started. To run a specific example, do:
+Solr includes a few examples to help you get started. To run a specific example, enter:
 
 ```
   bin/solr -e <EXAMPLE> where <EXAMPLE> is one of:
 
     cloud        : SolrCloud example
-    dih          : Data Import Handler (rdbms, mail, atom, tika)
     schemaless   : Schema-less example (schema is inferred from data during indexing)
     techproducts : Kitchen sink example providing comprehensive examples of Solr features
 ```
 
-For instance, if you want to run the Solr Data Import Handler example, do:
+For instance, if you want to run the SolrCloud example, enter:
 
 ```
-  bin/solr -e dih
+  bin/solr -e cloud
 ```
 
 Indexing Documents
@@ -142,8 +143,7 @@ server/
 
 example/
   Contains example documents and an alternative Solr home
-  directory containing examples of how to use the Data Import Handler,
-  see example/example-DIH/README.md for more information.
+  directory containing various examples.
 
 dist/solr-<component>-XX.jar
   The Apache Solr libraries.  To compile Apache Solr Plugins,
@@ -177,8 +177,15 @@ Instructions for Building Apache Solr from Source
    cd to "./solr/packaging/build/solr-9.0.0-SNAPSHOT" and run the bin/solr script
    to start Solr.
    
-   NOTE: `gradlew` is the "Gradle Wrapper" and will automaticaly download and
+   NOTE: `gradlew` is the "Gradle Wrapper" and will automatically download and
    start using the correct version of Gradle.
+   
+   NOTE: `./gradlew help` will print a list of high-level tasks. There are also a 
+   number of plain-text files in <source folder root>/help.
+   
+   NOTE: This CWiki page describes getting/building/testing Solr
+   in more detail:
+   `https://cwiki.apache.org/confluence/display/solr/HowToContribute` 
 
 Export control
 -------------------------------------------------