This is an automated email from the ASF dual-hosted git repository.
epugh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/main by this push:
new 32266a7 SOLR-13737 Moving SolrCloud up on the README (#630)
32266a7 is described below
commit 32266a7bd174f967dbed161e51199163bf095bff
Author: Marcus <[email protected]>
AuthorDate: Mon Feb 14 09:26:19 2022 -0800
SOLR-13737 Moving SolrCloud up on the README (#630)
* lead with SOLR Cloud
* tweak to use clustered terminology, which was discussed on mailing list
* use same clustered terminology in both README files. There is a
seperate PR to merge them
Co-authored-by: [email protected] <>
---
README.md | 18 +++++++++---------
solr/README.md | 36 ++++++++++++++++++------------------
2 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/README.md b/README.md
index cf1932f..567e9b2 100644
--- a/README.md
+++ b/README.md
@@ -53,15 +53,15 @@ The first time you run Gradle, it will create a file
"gradle.properties" that
contains machine-specific settings. Normally you can use this file as-is, but
it
can be modified if necessary.
-The command above packages a full distribution of Solr server; the
+The command above packages a full distribution of Solr server; the
package can be located at:
`solr/packaging/build/solr-*`
Note that the gradle build does not create or copy binaries throughout the
source repository so you need to switch to the packaging output folder above;
-the rest of the instructions below remain identical. The packaging directory
-is rewritten on each build.
+the rest of the instructions below remain identical. The packaging directory
+is rewritten on each build.
For development, especially when you have created test indexes etc, use
the `./gradlew dev` task which will copy binaries to
`./solr/packaging/build/dev`
@@ -73,14 +73,14 @@ If you want to build the documentation, type `./gradlew -p
solr documentation`.
After building Solr, the server can be started using
the `bin/solr` control scripts. Solr can be run in either standalone or
-distributed (SolrCloud mode).
+clustered (SolrCloud mode).
To run Solr in standalone mode, run the following command from the `solr/`
directory:
`bin/solr start`
-To run Solr in SolrCloud mode, run the following command from the `solr/`
+To run Solr in clustered mode, run the following command from the `solr/`
directory:
`bin/solr start -c`
@@ -98,7 +98,7 @@ To run Solr in a container and expose the Solr port, run:
`docker run -p 8983:8983 solr`
-In order to start Solr in cloud mode, run the following.
+In order to start Solr in clustered mode, run the following.
`docker run -p 8983:8983 solr solr-fg -c`
@@ -126,8 +126,8 @@ Please refer to the [Solr
Operator](https://solr.apache.org/operator) home for d
### Gradle build and IDE support
-- *IntelliJ* - IntelliJ idea can import the project out of the box.
- Code formatting conventions should be manually adjusted.
+- *IntelliJ* - IntelliJ idea can import the project out of the box.
+ Code formatting conventions should be manually adjusted.
- *Eclipse* - Not tested.
- *Netbeans* - Not tested.
@@ -154,4 +154,4 @@ contributing.
- [Mailing Lists](https://solr.apache.org/community.html#mailing-lists-chat)
- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
- IRC: `#solr` and `#solr-dev` on libera.chat
-- [Slack](https://solr.apache.org/community.html#slack)
+- [Slack](https://solr.apache.org/community.html#slack)
diff --git a/solr/README.md b/solr/README.md
index 24c53b2..944d486 100644
--- a/solr/README.md
+++ b/solr/README.md
@@ -34,16 +34,16 @@ All the following commands are entered from the "solr"
directory which should be
To start Solr for the first time after installation, simply enter:
```
- bin/solr start
+ bin/solr start -c
```
-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, enter:
+This will launch Solr in clustered (SolrCloud) mode, which allows you to scale
out using
+sharding and replication. Alternatively, you can launch a standalone Solr
server
+in the background of your shell, listening on port 8983. To launch Solr
+in standalone mode, enter:
```
- bin/solr start -cloud
+ bin/solr start
```
To see all available options for starting Solr, please enter:
@@ -53,7 +53,7 @@ To see all available options for starting Solr, please enter:
```
After starting Solr, create either a core or collection depending on whether
-Solr is running in standalone (core) or SolrCloud mode (collection) by
entering:
+Solr is running in standalone or clustered (SolrCloud) mode by entering:
```
bin/solr create -c <name>
@@ -114,13 +114,13 @@ To add documents to the index, use bin/post. For example:
For more information about Solr examples please read...
* [example/README.md](example/README.md)
-
+
For more information about the "Solr Home" and Solr specific configuration
-
+
* https://solr.apache.org/guide/solr-tutorial.html
-
+
For a Solr tutorial
-
+
* https://solr.apache.org/resources.html
For a list of other tutorials and introductory articles.
@@ -182,22 +182,22 @@ Instructions for Building Apache Solr from Source
https://solr.apache.org/community.html#version-control
-3. Navigate to the root of your source tree folder and issue the `./gradlew
tasks`
+3. Navigate to the root of your source tree folder and issue the `./gradlew
tasks`
command to see the available options for building, testing, and packaging
Solr.
- `./gradlew assemble` will create a Solr executable.
+ `./gradlew assemble` will create a Solr executable.
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 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
+
+ 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`
+ `https://cwiki.apache.org/confluence/display/solr/HowToContribute`
Export control
-------------------------------------------------
