You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by sh...@apache.org on 2017/08/19 12:31:22 UTC
[11/37] lucene-solr:feature/autoscaling_72: SOLR-10842: Move Tutorial
to Ref Guide Squashed commit of the following:
SOLR-10842: Move Tutorial to Ref Guide
Squashed commit of the following:
commit 1cc4de5c4506c757746eac1809f9a7f3d3a55d00
Author: Cassandra Targett <ct...@apache.org>
Date: Tue Aug 15 13:23:40 2017 -0500
SOLR-10842: add Field UI images; rename image paths; minor cleanups
commit 39c7c2f87c54eaaa3341dd119ecd4f0675244a38
Author: Cassandra Targett <ct...@apache.org>
Date: Thu Aug 3 15:49:21 2017 -0500
SOLR-10842: remove running-solr.adoc; move starting solr content to installing-solr; move pages to improve flow; final readthrough
commit 70bea0e73159557f991572ad680a251a0791faec
Author: Cassandra Targett <ct...@apache.org>
Date: Wed Aug 2 19:31:57 2017 -0500
SOLR-10842: rename upgrading-solr.adoc; fix links
commit 0d0cbe7980bf0868ea5d36093aad6101201de82b
Author: Cassandra Targett <ct...@apache.org>
Date: Tue Aug 1 09:46:42 2017 -0500
SOLR-10842: page re-org cleanup; copy edits on tutorial; rename "quick-start" to "tutorial"
commit 4a2635638b214b1480d3b7055afa219ae7bb6a36
Author: Cassandra Targett <ct...@apache.org>
Date: Fri Jul 28 13:45:39 2017 -0500
SOLR-10842: Overhaul of tutorial; update query image
commit 1e1646223b29a0788597d3695b5d0e7ebdd28187
Author: Cassandra Targett <ct...@apache.org>
Date: Thu Jul 20 14:13:43 2017 -0500
little typos
commit e2cb85649dabfd7fd7df6f3d3cce2ca58a4c76a9
Author: Cassandra Targett <ct...@apache.org>
Date: Wed Jul 19 09:32:25 2017 -0500
Change example to use Films
commit 49ad12ca58d5b3bbe60f3cb8f61469bfe321fcc3
Author: Cassandra Targett <ct...@apache.org>
Date: Tue Jul 18 09:31:03 2017 -0500
Further experiments with tabbed layout
commit 21e4dcb38f802f9d2aed795d5c6ba3701b0178ae
Author: Cassandra Targett <ct...@apache.org>
Date: Mon Jul 17 16:58:33 2017 -0500
Fix page links; add experiment with tabs for different data formats
commit c24a9385361d22d7cb51051152b9e1f834c25d45
Author: Cassandra Targett <ct...@apache.org>
Date: Thu Jun 29 14:36:01 2017 -0500
SOLR-10842: minor changes to a few files
commit 819f160423d17dbb647935c5bbfd8a16d4b7b57c
Author: Cassandra Targett <ct...@apache.org>
Date: Fri Jun 23 13:49:32 2017 -0500
SOLR-10842: major page reorg; new content for install and config files
commit 4be7b61ba46f440accdf96757566c3d854e09328
Author: Cassandra Targett <ct...@apache.org>
Date: Tue Jun 13 15:34:49 2017 -0500
SOLR-10842: installation docs
commit c83a9ba91d96d5b75df2191404a3482ca81f8505
Author: Cassandra Targett <ct...@apache.org>
Date: Tue Jun 13 13:56:47 2017 -0500
SOLR-10842: little fixes for quick start
commit 10c1a462338aa16c0435c01eba0506fe09277174
Author: Cassandra Targett <ct...@apache.org>
Date: Fri Jun 9 13:47:04 2017 -0500
SOLR-10842: add quickstart.html from CMS; convert to asciidoc style
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/0b353b67
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/0b353b67
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/0b353b67
Branch: refs/heads/feature/autoscaling_72
Commit: 0b353b6741a88cb85cb92d21cf825e7d412ece97
Parents: 9ebdd84
Author: Cassandra Targett <ct...@apache.org>
Authored: Tue Aug 15 14:03:37 2017 -0500
Committer: Cassandra Targett <ct...@apache.org>
Committed: Tue Aug 15 14:06:54 2017 -0500
----------------------------------------------------------------------
solr/solr-ref-guide/src/a-quick-overview.adoc | 11 +-
solr/solr-ref-guide/src/a-step-closer.adoc | 70 --
solr/solr-ref-guide/src/getting-started.adoc | 24 +-
.../solr-tutorial/tutorial-add-copy-field.png | Bin 0 -> 123194 bytes
.../images/solr-tutorial/tutorial-add-field.png | Bin 0 -> 212142 bytes
.../tutorial-admin-ui-facet-options.png | Bin 0 -> 10646 bytes
.../solr-tutorial/tutorial-query-screen.png | Bin 0 -> 256538 bytes
.../solr-tutorial/tutorial-range-facet.png | Bin 0 -> 21592 bytes
.../images/solr-tutorial/tutorial-solrcloud.png | Bin 0 -> 50418 bytes
.../images/solr-tutorial/tutorial-spatial.png | Bin 0 -> 229121 bytes
solr/solr-ref-guide/src/index.adoc | 11 +-
solr/solr-ref-guide/src/installing-solr.adoc | 176 +++-
.../major-changes-from-solr-5-to-solr-6.adoc | 4 +-
solr/solr-ref-guide/src/managing-solr.adoc | 4 +-
solr/solr-ref-guide/src/running-solr.adoc | 289 ------
.../src/solr-configuration-files.adoc | 80 ++
.../src/solr-control-script-reference.adoc | 2 +-
.../src/solr-system-requirements.adoc | 48 +
solr/solr-ref-guide/src/solr-tutorial.adoc | 980 +++++++++++++++++++
solr/solr-ref-guide/src/solr-upgrade-notes.adoc | 84 ++
.../src/upgrading-a-solr-cluster.adoc | 21 +-
solr/solr-ref-guide/src/upgrading-solr.adoc | 78 --
22 files changed, 1385 insertions(+), 497 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/a-quick-overview.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/a-quick-overview.adoc b/solr/solr-ref-guide/src/a-quick-overview.adoc
index bcacb07..a88e1a0 100644
--- a/solr/solr-ref-guide/src/a-quick-overview.adoc
+++ b/solr/solr-ref-guide/src/a-quick-overview.adoc
@@ -18,7 +18,7 @@
// specific language governing permissions and limitations
// under the License.
-Having had some fun with Solr, you will now learn about all the cool things it can do.
+Solr is a search server built on top of Apache Lucene, an open source, Java-based, information retrieval library. It is designed to drive powerful document retrieval applications - wherever you need to serve data to users based on their queries, Solr can work for you.
Here is a example of how Solr might be integrated into an application:
@@ -30,13 +30,12 @@ In the scenario above, Solr runs along side other server applications. For examp
Solr makes it easy to add the capability to search through the online store through the following steps:
. Define a _schema_. The schema tells Solr about the contents of documents it will be indexing. In the online store example, the schema would define fields for the product name, description, price, manufacturer, and so on. Solr's schema is powerful and flexible and allows you to tailor Solr's behavior to your application. See <<documents-fields-and-schema-design.adoc#documents-fields-and-schema-design,Documents, Fields, and Schema Design>> for all the details.
-. Deploy Solr.
. Feed Solr documents for which your users will search.
. Expose search functionality in your application.
-Because Solr is based on open standards, it is highly extensible. Solr queries are RESTful, which means, in essence, that a query is a simple HTTP request URL and the response is a structured document: mainly XML, but it could also be JSON, CSV, or some other format. This means that a wide variety of clients will be able to use Solr, from other web applications to browser clients, rich client applications, and mobile devices. Any platform capable of HTTP can talk to Solr. See <<client-apis.adoc#client-apis,Client APIs>> for details on client APIs.
+Because Solr is based on open standards, it is highly extensible. Solr queries are simple HTTP request URLs and the response is a structured document: mainly JSON, but it could also be XML, CSV, or other formats. This means that a wide variety of clients will be able to use Solr, from other web applications to browser clients, rich client applications, and mobile devices. Any platform capable of HTTP can talk to Solr. See <<client-apis.adoc#client-apis,Client APIs>> for details on client APIs.
-Solr is based on the Apache Lucene project, a high-performance, full-featured search engine. Solr offers support for the simplest keyword searching through to complex queries on multiple fields and faceted search results. <<searching.adoc#searching,Searching>> has more information about searching and queries.
+Solr offers support for the simplest keyword searching through to complex queries on multiple fields and faceted search results. <<searching.adoc#searching,Searching>> has more information about searching and queries.
If Solr's capabilities are not impressive enough, its ability to handle very high-volume applications should do the trick.
@@ -44,6 +43,4 @@ A relatively common scenario is that you have so much data, or so many queries,
For example: "Sharding" is a scaling technique in which a collection is split into multiple logical pieces called "shards" in order to scale up the number of documents in a collection beyond what could physically fit on a single server. Incoming queries are distributed to every shard in the collection, which respond with merged results. Another technique available is to increase the "Replication Factor" of your collection, which allows you to add servers with additional copies of your collection to handle higher concurrent query load by spreading the requests around to multiple machines. Sharding and Replication are not mutually exclusive, and together make Solr an extremely powerful and scalable platform.
-Best of all, this talk about high-volume applications is not just hypothetical: some of the famous Internet sites that use Solr today are Macy's, EBay, and Zappo's.
-
-For more information, take a look at https://wiki.apache.org/solr/PublicServers.
+Best of all, this talk about high-volume applications is not just hypothetical: some of the famous Internet sites that use Solr today are Macy's, EBay, and Zappo's. For more examples, take a look at https://wiki.apache.org/solr/PublicServers.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/a-step-closer.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/a-step-closer.adoc b/solr/solr-ref-guide/src/a-step-closer.adoc
deleted file mode 100644
index c75c6b9..0000000
--- a/solr/solr-ref-guide/src/a-step-closer.adoc
+++ /dev/null
@@ -1,70 +0,0 @@
-= A Step Closer
-:page-shortname: a-step-closer
-:page-permalink: a-step-closer.html
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-
-You already have some idea of Solr's schema. This section describes Solr's home directory and other configuration options.
-
-When Solr runs in an application server, it needs access to a home directory. The home directory contains important configuration information and is the place where Solr will store its index. The layout of the home directory will look a little different when you are running Solr in standalone mode vs when you are running in SolrCloud mode.
-
-The crucial parts of the Solr home directory are shown in these examples:
-
-.Standalone Mode
-[source,plain]
-----
-<solr-home-directory>/
- solr.xml
- core_name1/
- core.properties
- conf/
- solrconfig.xml
- managed-schema
- data/
- core_name2/
- core.properties
- conf/
- solrconfig.xml
- managed-schema
- data/
-----
-
-.SolrCloud Mode
-[source,plain]
-----
-<solr-home-directory>/
- solr.xml
- core_name1/
- core.properties
- data/
- core_name2/
- core.properties
- data/
-----
-
-You may see other files, but the main ones you need to know are:
-
-* `solr.xml` specifies configuration options for your Solr server instance. For more information on `solr.xml` see <<solr-cores-and-solr-xml.adoc#solr-cores-and-solr-xml,Solr Cores and solr.xml>>.
-* Per Solr Core:
-** `core.properties` defines specific properties for each core such as its name, the collection the core belongs to, the location of the schema, and other parameters. For more details on `core.properties`, see the section <<defining-core-properties.adoc#defining-core-properties,Defining core.properties>>.
-** `solrconfig.xml` controls high-level behavior. You can, for example, specify an alternate location for the data directory. For more information on `solrconfig.xml`, see <<configuring-solrconfig-xml.adoc#configuring-solrconfig-xml,Configuring solrconfig.xml>>.
-** `managed-schema` (or `schema.xml` instead) describes the documents you will ask Solr to index. The Schema define a document as a collection of fields. You get to define both the field types and the fields themselves. Field type definitions are powerful and include information about how Solr processes incoming field values and query values. For more information on Solr Schemas, see <<documents-fields-and-schema-design.adoc#documents-fields-and-schema-design,Documents, Fields, and Schema Design>> and the <<schema-api.adoc#schema-api,Schema API>>.
-** `data/` The directory containing the low level index files.
-
-Note that the SolrCloud example does not include a `conf` directory for each Solr Core (so there is no `solrconfig.xml` or Schema file). This is because the configuration files usually found in the `conf` directory are stored in ZooKeeper so they can be propagated across the cluster.
-
-If you are using SolrCloud with the embedded ZooKeeper instance, you may also see `zoo.cfg` and `zoo.data` which are ZooKeeper configuration and data files. However, if you are running your own ZooKeeper ensemble, you would supply your own ZooKeeper configuration file when you start it and the copies in Solr would be unused. For more information about ZooKeeper and SolrCloud, see the section <<solrcloud.adoc#solrcloud,SolrCloud>>.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/getting-started.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/getting-started.adoc b/solr/solr-ref-guide/src/getting-started.adoc
index 733fa91..4369864 100644
--- a/solr/solr-ref-guide/src/getting-started.adoc
+++ b/solr/solr-ref-guide/src/getting-started.adoc
@@ -1,7 +1,7 @@
= Getting Started
:page-shortname: getting-started
:page-permalink: getting-started.html
-:page-children: installing-solr, running-solr, a-quick-overview, a-step-closer, solr-control-script-reference
+:page-children: a-quick-overview, solr-system-requirements, installing-solr, solr-configuration-files, solr-upgrade-notes, taking-solr-to-production, upgrading-a-solr-cluster
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
@@ -19,25 +19,21 @@
// specific language governing permissions and limitations
// under the License.
-Solr makes it easy for programmers to develop sophisticated, high-performance search applications with advanced features such as faceting (arranging search results in columns with numerical counts of key terms).
+[.lead]
+Solr makes it easy for programmers to develop sophisticated, high-performance search applications with advanced features.
-Solr builds on another open source search technology: Lucene, a Java library that provides indexing and search technology, as well as spellchecking, hit highlighting and advanced analysis/tokenization capabilities. Both Solr and Lucene are managed by the Apache Software Foundation (http://www.apache.org/[www.apache.org)].
+This section introduces you to the basic Solr architecture and features to help you get up and running quickly. It covers the following topics:
-The Lucene search library currently ranks among the top 15 open source projects and is one of the top 5 Apache projects, with installations at over 4,000 companies. Lucene/Solr downloads have grown nearly ten times over the past three years, with a current run-rate of over 6,000 downloads a day. The Solr search server, which provides application builders a ready-to-use search platform on top of the Lucene search library, is the fastest growing Lucene sub-project. Apache Lucene/Solr offers an attractive alternative to the proprietary licensed search and discovery software vendors.
-
-This section helps you get Solr up and running quickly, and introduces you to the basic Solr architecture and features. It covers the following topics:
+<<a-quick-overview.adoc#a-quick-overview,A Quick Overview>>: A high-level overview of how Solr works.
<<installing-solr.adoc#installing-solr,Installing Solr>>: A walkthrough of the Solr installation process.
-<<running-solr.adoc#running-solr,Running Solr>>: An introduction to running Solr. Includes information on starting up the servers, adding documents, and running queries.
+<<solr-configuration-files.adoc#solr-configuration-files,Solr Configuration Files>>: Overview of the installation layout and major configuration files.
-<<a-quick-overview.adoc#a-quick-overview,A Quick Overview>>: A high-level overview of how Solr works.
+<<solr-upgrade-notes.adoc#solr-upgrade-notes,Solr Upgrade Notes>>: Information about changes made in Solr releases.
-<<a-step-closer.adoc#a-step-closer,A Step Closer>>: An introduction to Solr's home directory and configuration options.
+<<taking-solr-to-production.adoc#taking-solr-to-production,Taking Solr to Production>>: Detailed steps to help you install Solr as a service and take your application to production.
-<<solr-control-script-reference.adoc#solr-control-script-reference,Solr Control Script Reference>>: a complete reference of all of the commands and options available with the bin/solr script.
+<<upgrading-a-solr-cluster.adoc#upgrading-a-solr-cluster,Upgrading a Solr Cluster>>: Information for upgrading a production SolrCloud cluster.
-[TIP]
-====
-Solr includes a Quick Start tutorial which will be helpful if you are just starting out with Solr. You can find it online at http://lucene.apache.org/solr/quickstart.html.
-====
+TIP: Solr includes a Quick Start tutorial which will be helpful if you are just starting out with Solr. You can find it in this Guide at <<solr-tutorial.adoc#solr-tutorial,Solr Tutorial>>.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-add-copy-field.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-add-copy-field.png b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-add-copy-field.png
new file mode 100644
index 0000000..6a21a99
Binary files /dev/null and b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-add-copy-field.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-add-field.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-add-field.png b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-add-field.png
new file mode 100644
index 0000000..1884ba4
Binary files /dev/null and b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-add-field.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-admin-ui-facet-options.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-admin-ui-facet-options.png b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-admin-ui-facet-options.png
new file mode 100644
index 0000000..ccc24e6
Binary files /dev/null and b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-admin-ui-facet-options.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-query-screen.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-query-screen.png b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-query-screen.png
new file mode 100644
index 0000000..7e009d2
Binary files /dev/null and b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-query-screen.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-range-facet.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-range-facet.png b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-range-facet.png
new file mode 100644
index 0000000..e441782
Binary files /dev/null and b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-range-facet.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-solrcloud.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-solrcloud.png b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-solrcloud.png
new file mode 100644
index 0000000..9b76456
Binary files /dev/null and b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-solrcloud.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-spatial.png
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-spatial.png b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-spatial.png
new file mode 100644
index 0000000..2a73d6a
Binary files /dev/null and b/solr/solr-ref-guide/src/images/solr-tutorial/tutorial-spatial.png differ
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/index.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/index.adoc b/solr/solr-ref-guide/src/index.adoc
index e9200d0..13cad02 100644
--- a/solr/solr-ref-guide/src/index.adoc
+++ b/solr/solr-ref-guide/src/index.adoc
@@ -1,7 +1,7 @@
= Apache Solr Reference Guide
:page-shortname: index
:page-permalink: index.html
-:page-children: about-this-guide, getting-started, upgrading-solr, using-the-solr-administration-user-interface, documents-fields-and-schema-design, understanding-analyzers-tokenizers-and-filters, indexing-and-basic-data-operations, searching, the-well-configured-solr-instance, managing-solr, solrcloud, legacy-scaling-and-distribution, client-apis, major-changes-from-solr-5-to-solr-6, upgrading-a-solr-cluster, further-assistance, solr-glossary, errata, how-to-contribute
+:page-children: about-this-guide, solr-tutorial, getting-started, solr-control-script-reference, using-the-solr-administration-user-interface, documents-fields-and-schema-design, understanding-analyzers-tokenizers-and-filters, indexing-and-basic-data-operations, searching, the-well-configured-solr-instance, managing-solr, solrcloud, legacy-scaling-and-distribution, client-apis, major-changes-from-solr-5-to-solr-6, further-assistance, solr-glossary, errata, how-to-contribute
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
@@ -19,12 +19,17 @@
// specific language governing permissions and limitations
// under the License.
-This reference guide describes Apache Solr, the open source solution for search. You can download Apache Solr from the Solr website at http://lucene.apache.org/solr/.
+[.lead]
+This reference guide describes Apache Solr, the open source solution for search.
-This Guide contains the following sections:
+Solr builds on Lucene, an open source Java library that provides indexing and search technology, as well as spellchecking, hit highlighting and advanced analysis/tokenization capabilities. Both Solr and Lucene are managed by the Apache Software Foundation (http://www.apache.org/[www.apache.org)]. You can download Apache Solr from the Solr website at http://lucene.apache.org/solr/.
+
+This Guide contains the following main sections:
*<<getting-started.adoc#getting-started,Getting Started>>*: This section guides you through the installation and setup of Solr.
+*<<solr-control-script-reference#solr-control-script-reference,Solr Control Script Reference>>*: This section provides information about all of the options available to the `bin/solr` / `bin\solr.cmd` scripts, which can start and stop Solr, configure authentication, and create or remove collections and cores.
+
*<<using-the-solr-administration-user-interface.adoc#using-the-solr-administration-user-interface,Using the Solr Administration User Interface>>*: This section introduces the Solr Web-based user interface. From your browser you can view configuration files, submit queries, view logfile settings and Java environment settings, and monitor and control distributed configurations.
*<<documents-fields-and-schema-design.adoc#documents-fields-and-schema-design,Documents, Fields, and Schema Design>>*: This section describes how Solr organizes its data for indexing. It explains how a Solr schema defines the fields and field types which Solr uses to organize data within the document files it indexes.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/installing-solr.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/installing-solr.adoc b/solr/solr-ref-guide/src/installing-solr.adoc
index 9e12bb6..ca3eed0 100644
--- a/solr/solr-ref-guide/src/installing-solr.adoc
+++ b/solr/solr-ref-guide/src/installing-solr.adoc
@@ -1,6 +1,7 @@
= Installing Solr
:page-shortname: installing-solr
:page-permalink: installing-solr.html
+:page-toclevels: 1
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
@@ -18,39 +19,178 @@
// specific language governing permissions and limitations
// under the License.
-This section describes how to install Solr.
+Installation of Solr on Unix-compatible or Windows servers generally requires simply extracting (or, unzipping) the download package.
-You can install Solr in any system where a suitable Java Runtime Environment (JRE) is available, as detailed below. Currently this includes Linux, OS X, and Microsoft Windows. The instructions in this section should work for any platform, with a few exceptions for Windows as noted.
+Please be sure to review the <<solr-system-requirements.adoc#solr-system-requirements,Solr System Requirements>> before starting Solr.
-== Got Java?
+== Available Solr Packages
-You will need the Java Runtime Environment (JRE) version 1.8 or higher. At a command line, check your Java version like this:
+Solr is available from the Solr website. Download the latest release https://lucene.apache.org/solr/mirrors-solr-latest-redir.html.
+
+There are three separate packages:
+
+* `solr-{solr-docs-version}.0.tgz` for Linux/Unix/OSX systems
+* `solr-{solr-docs-version}.0.zip` for Microsoft Windows systems
+* `solr-{solr-docs-version}.0-src.tgz` the package Solr source code. This is useful if you want to develop on Solr without using the official Git repository.
+
+== Preparing for Installation
+
+When getting started with Solr, all you need to do is extract the Solr distribution archive to a directory of your choosing. This will suffice as an initial development environment, but take care not to overtax this "toy" installation before setting up your true development and production environments.
+
+When you've progressed past initial evaluation of Solr, you'll want to take care to plan your implementation. You may need to reinstall Solr on another server or make a clustered SolrCloud environment.
+
+When you're ready to setup Solr for a production environment, please refer to the instructions provided on the <<taking-solr-to-production.adoc#taking-solr-to-production,Taking Solr to Production>> page.
+
+.What Size Server Do I Need?
+[NOTE]
+====
+How to size your Solr installation is a complex question that relies on a number of factors, including the number and structure of documents, how many fields you intend to store, the number of users, etc.
+
+It's highly recommended that you spend a bit of time thinking about the factors that will impact hardware sizing for your Solr implementation. A very good blog post that discusses the issues to consider is https://lucidworks.com/2012/07/23/sizing-hardware-in-the-abstract-why-we-dont-have-a-definitive-answer/[Sizing Hardware in the Abstract: Why We Don't have a Definitive Answer].
+
+====
+
+== Package Installation
+
+To keep things simple for now, extract the Solr distribution archive to your local home directory, for instance on Linux, do:
+
+[source,bash,subs="attributes"]
+----
+cd ~/
+tar zxf solr-{solr-docs-version}.0.tgz
+----
+
+Once extracted, you are now ready to run Solr using the instructions provided in the <<Starting Solr>> section below.
+
+== Directory Layout
+
+After installing Solr, you'll see the following directories and files within them:
+
+bin::
+This directory includes several important scripts that will make using Solr easier.
+
+solr and solr.cmd::: This is <<solr-control-script-reference.adoc#solr-control-script-reference,Solr's Control Script>>, also known as `bin/solr` (*nix) / `bin/solr.cmd` (Windows). This script is the preferred tool to start and stop Solr. You can also create collections or cores, configure authentication, and work with configuration files when running in SolrCloud mode.
+
+post::: The <<post-tool.adoc#post-tool,PostTool>>, which provides a simple command line interface for POSTing content to Solr.
+
+solr.in.sh and solr.in.cmd:::
+These are property files for *nix and Windows systems, respectively. System-level properties for Java, Jetty, and Solr are configured here. Many of these settings can be overridden when using `bin/solr` / `bin/solr.cmd`, but this allows you to set all the properties in one place.
+
+install_solr_services.sh:::
+This script is used on *nix systems to install Solr as a service. It is described in more detail in the section <<taking-solr-to-production.adoc#taking-solr-to-production,Taking Solr to Production>>.
+
+contrib::
+Solr's `contrib` directory includes add-on plugins for specialized features of Solr.
+
+dist::
+The `dist` directory contains the main Solr .jar files.
+
+docs::
+The `docs` directory includes a link to online Javadocs for Solr.
+
+example::
+The `example` directory includes several types of examples that demonstrate various Solr capabilities. See the section <<Solr Examples>> below for more details on what is in this directory.
+
+licenses::
+The `licenses` directory includes all of the licenses for 3rd party libraries used by Solr.
+
+server::
+This directory is where the heart of the Solr application resides. A README in this directory provides a detailed overview, but here are some highlights:
+* Solr's Admin UI (`server/solr-webapp`)
+* Jetty libraries (`server/lib`)
+* Log files (`server/logs`) and log configurations (`server/resources`). See the section <<configuring-logging.adoc#configuring-logging,Configuring Logging>> for more details on how to customize Solr's default logging.
+* Sample configsets (`server/solr/configsets`)
+
+== Solr Examples
+
+Solr includes a number of example documents and configurations to use when getting started. If you ran through the <<solr-tutorial.adoc#solr-tutorial,Solr Tutorial>>, you have already interacted with some of these files.
+
+Here are the examples included with Solr:
+
+exampledocs::
+This is a small set of simple CSV, XML, and JSON files that can be used with `bin/post` when first getting started with Solr. For more information about using `bin/post` with these files, see <<post-tool.adoc#post-tool,Post Tool>>.
+
+example-DIH::
+This directory includes a few example DataImport Handler (DIH) configurations to help you get started with importing structured content in a database, an email server, or even an Atom feed. Each example will index a different set of data; see the README there for more details about these examples.
+
+files::
+The `files` directory provides a basic search UI for documents such as Word or PDF that you may have stored locally. See the README there for details on how to use this example.
+
+films::
+The `films` directory includes a robust set of data about movies in three formats: CSV, XML, and JSON. See the README there for details on how to use this dataset.
+
+== Starting Solr
+
+Solr includes a command line interface tool called `bin/solr` (Linux/MacOS) or `bin\solr.cmd` (Windows). This tool allows you to start and stop Solr, create cores and collections, configure authentication, and check the status of your system.
+
+To use it to start Solr you can simply enter:
+
+[source,bash]
+----
+bin/solr start
+----
+
+If you are running Windows, you can start Solr by running `bin\solr.cmd` instead.
[source,plain]
----
-$ java -version
-java version "1.8.0_60"
-Java(TM) SE Runtime Environment (build 1.8.0_60-b27)
-Java HotSpot(TM) 64-Bit Server VM (build 25.60-b23, mixed mode)
+bin\solr.cmd start
----
-The exact output will vary, but you need to make sure you meet the minimum version requirement. We also recommend choosing a version that is not end-of-life from its vendor. If you don't have the required version, or if the java command is not found, download and install the latest version from Oracle at http://www.oracle.com/technetwork/java/javase/downloads/index.html.
+This will start Solr in the background, listening on port 8983.
-[[install-command]]
-== Installing Solr
+When you start Solr in the background, the script will wait to make sure Solr starts correctly before returning to the command line prompt.
-Solr is available from the Solr website at http://lucene.apache.org/solr/.
+TIP: All of the options for the Solr CLI are described in the section <<solr-control-script-reference.adoc#solr-control-script-reference,Solr Control Script Reference>>.
-For Linux/Unix/OSX systems, download the `.tgz` file. For Microsoft Windows systems, download the `.zip` file.
+=== Start Solr with a Specific Bundled Example
-When getting started, all you need to do is extract the Solr distribution archive to a directory of your choosing. When you're ready to setup Solr for a production environment, please refer to the instructions provided on the <<taking-solr-to-production.adoc#taking-solr-to-production,Taking Solr to Production>> page.
+Solr also provides a number of useful examples to help you learn about key features. You can launch the examples using the `-e` flag. For instance, to launch the "techproducts" example, you would do:
-To keep things simple for now, extract the Solr distribution archive to your local home directory, for instance on Linux, do:
+[source,bash]
+----
+bin/solr -e techproducts
+----
+
+Currently, the available examples you can run are: techproducts, dih, schemaless, and cloud. See the section <<solr-control-script-reference.adoc#running-with-example-configurations,Running with Example Configurations>> for details on each example.
+
+.Getting Started with SolrCloud
+NOTE: Running the `cloud` example starts Solr in <<solrcloud.adoc#solrcloud,SolrCloud>> mode. For more information on starting Solr in cloud mode, see the section <<getting-started-with-solrcloud.adoc#getting-started-with-solrcloud,Getting Started with SolrCloud>>.
+
+=== Check if Solr is Running
+
+If you're not sure if Solr is running locally, you can use the status command:
[source,bash]
----
-cd ~/
-tar zxf solr-x.y.z.tgz
+bin/solr status
----
-Once extracted, you are now ready to run Solr using the instructions provided in the <<running-solr.adoc#running-solr,Running Solr>> section.
+This will search for running Solr instances on your computer and then gather basic information about them, such as the version and memory usage.
+
+That's it! Solr is running. If you need convincing, use a Web browser to see the Admin Console.
+
+`\http://localhost:8983/solr/`
+
+.The Solr Admin interface.
+image::images/running-solr/SolrAdminDashboard.png[image,width=900,height=456]
+
+If Solr is not running, your browser will complain that it cannot connect to the server. Check your port number and try again.
+
+=== Create a Core
+
+If you did not start Solr with an example configuration, you would need to create a core in order to be able to index and search. You can do so by running:
+
+[source,bash]
+----
+bin/solr create -c <name>
+----
+
+This will create a core 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 core, execute:
+
+[source,bash]
+----
+bin/solr create -help
+----
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/major-changes-from-solr-5-to-solr-6.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/major-changes-from-solr-5-to-solr-6.adoc b/solr/solr-ref-guide/src/major-changes-from-solr-5-to-solr-6.adoc
index 9ec44d8..8b3798e 100644
--- a/solr/solr-ref-guide/src/major-changes-from-solr-5-to-solr-6.adoc
+++ b/solr/solr-ref-guide/src/major-changes-from-solr-5-to-solr-6.adoc
@@ -18,7 +18,9 @@
// specific language governing permissions and limitations
// under the License.
-There are some major changes in Solr 6 to consider before starting to migrate your configurations and indexes. There are many hundreds of changes, so a thorough review of the <<upgrading-solr.adoc#upgrading-solr,Upgrading Solr>> section as well as the {solr-javadocs}/changes/Changes.html[CHANGES.txt] file in your Solr instance will help you plan your migration to Solr 6. This section attempts to highlight some of the major changes you should be aware of.
+There are some major changes in Solr 6 to consider before starting to migrate your configurations and indexes.
+
+There are many hundreds of changes, so a thorough review of the <<solr-upgrade-notes.adoc#solr-upgrade-notes,Solr Upgrade Notes>> section as well as the {solr-javadocs}/changes/Changes.html[CHANGES.txt] file in your Solr instance will help you plan your migration to Solr 6. This section attempts to highlight some of the major changes you should be aware of.
== Highlights of New Features in Solr 6
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/managing-solr.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/managing-solr.adoc b/solr/solr-ref-guide/src/managing-solr.adoc
index abb2526..6644d62 100644
--- a/solr/solr-ref-guide/src/managing-solr.adoc
+++ b/solr/solr-ref-guide/src/managing-solr.adoc
@@ -1,7 +1,7 @@
= Managing Solr
:page-shortname: managing-solr
:page-permalink: managing-solr.html
-:page-children: taking-solr-to-production, securing-solr, running-solr-on-hdfs, making-and-restoring-backups, configuring-logging, using-jmx-with-solr, mbean-request-handler, performance-statistics-reference, metrics-reporting, v2-api
+:page-children: securing-solr, running-solr-on-hdfs, making-and-restoring-backups, configuring-logging, using-jmx-with-solr, mbean-request-handler, performance-statistics-reference, metrics-reporting, v2-api
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
@@ -21,8 +21,6 @@
This section describes how to run Solr and how to look at Solr when it is running. It contains the following sections:
-<<taking-solr-to-production.adoc#taking-solr-to-production,Taking Solr to Production>>: Describes how to install Solr as a service on Linux for production environments.
-
<<securing-solr.adoc#securing-solr,Securing Solr>>: How to use the Basic and Kerberos authentication and rule-based authorization plugins for Solr, and how to enable SSL.
<<running-solr-on-hdfs.adoc#running-solr-on-hdfs,Running Solr on HDFS>>: How to use HDFS to store your Solr indexes and transaction logs.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/running-solr.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/running-solr.adoc b/solr/solr-ref-guide/src/running-solr.adoc
deleted file mode 100644
index f18183e..0000000
--- a/solr/solr-ref-guide/src/running-solr.adoc
+++ /dev/null
@@ -1,289 +0,0 @@
-= Running Solr
-:page-shortname: running-solr
-:page-permalink: running-solr.html
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-
-This section describes how to run Solr with an example schema, how to add documents, and how to run queries.
-
-[[RunningSolr-StarttheServer]]
-== Start the Server
-
-If you didn't start Solr after installing it, you can start it by running `bin/solr` from the Solr directory.
-
-[source,bash]
-----
-bin/solr start
-----
-
-If you are running Windows, you can start Solr by running `bin\solr.cmd` instead.
-
-[source,plain]
-----
-bin\solr.cmd start
-----
-
-This will start Solr in the background, listening on port 8983.
-
-When you start Solr in the background, the script will wait to make sure Solr starts correctly before returning to the command line prompt.
-
-The `bin/solr` and `bin\solr.cmd` scripts allow you to customize how you start Solr. Let's work through a few examples of using the `bin/solr` script (if you're running Solr on Windows, the `bin\solr.cmd` works the same as what is shown in the examples below):
-
-[[RunningSolr-SolrScriptOptions]]
-=== Solr Script Options
-
-The `bin/solr` script has several options.
-
-[[RunningSolr-ScriptHelp]]
-==== Script Help
-
-To see how to use the `bin/solr` script, execute:
-
-[source,bash]
-----
-bin/solr -help
-----
-
-For specific usage instructions for the *start* command, do:
-
-[source,bash]
-----
-bin/solr start -help
-----
-
-[[RunningSolr-StartSolrintheForeground]]
-==== Start Solr in the Foreground
-
-Since Solr is a server, it is more common to run it in the background, especially on Unix/Linux. However, to start Solr in the foreground, simply do:
-
-[source,bash]
-----
-bin/solr start -f
-----
-
-If you are running Windows, you can run:
-
-[source,plain]
-----
-bin\solr.cmd start -f
-----
-
-[[RunningSolr-StartSolrwithaDifferentPort]]
-==== Start Solr with a Different Port
-
-To change the port Solr listens on, you can use the `-p` parameter when starting, such as:
-
-[source,bash]
-----
-bin/solr start -p 8984
-----
-
-[[RunningSolr-StopSolr]]
-==== Stop Solr
-
-When running Solr in the foreground (using -f), then you can stop it using `Ctrl-c`. However, when running in the background, you should use the *stop* command, such as:
-
-[source,bash]
-----
-bin/solr stop -p 8983
-----
-
-The stop command requires you to specify the port Solr is listening on or you can use the `-all` parameter to stop all running Solr instances.
-
-[[RunningSolr-StartSolrwithaSpecificBundledExample]]
-==== Start Solr with a Specific Bundled Example
-
-Solr also provides a number of useful examples to help you learn about key features. You can launch the examples using the `-e` flag. For instance, to launch the "techproducts" example, you would do:
-
-[source,bash]
-----
-bin/solr -e techproducts
-----
-
-Currently, the available examples you can run are: techproducts, dih, schemaless, and cloud. See the section <<solr-control-script-reference.adoc#running-with-example-configurations,Running with Example Configurations>> for details on each example.
-
-.Getting Started with SolrCloud
-[NOTE]
-====
-Running the `cloud` example starts Solr in <<solrcloud.adoc#solrcloud,SolrCloud>> mode. For more information on starting Solr in cloud mode, see the section <<getting-started-with-solrcloud.adoc#getting-started-with-solrcloud,Getting Started with SolrCloud>>.
-====
-
-[[RunningSolr-CheckifSolrisRunning]]
-==== Check if Solr is Running
-
-If you're not sure if Solr is running locally, you can use the status command:
-
-[source,bash]
-----
-bin/solr status
-----
-
-This will search for running Solr instances on your computer and then gather basic information about them, such as the version and memory usage.
-
-That's it! Solr is running. If you need convincing, use a Web browser to see the Admin Console.
-
-`\http://localhost:8983/solr/`
-
-.The Solr Admin interface.
-image::images/running-solr/SolrAdminDashboard.png[image,width=900,height=456]
-
-If Solr is not running, your browser will complain that it cannot connect to the server. Check your port number and try again.
-
-[[RunningSolr-CreateaCore]]
-== Create a Core
-
-If you did not start Solr with an example configuration, you would need to create a core in order to be able to index and search. You can do so by running:
-
-[source,bash]
-----
-bin/solr create -c <name>
-----
-
-This will create a core 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 core, execute:
-
-[source,bash]
-----
-bin/solr create -help
-----
-
-[[RunningSolr-AddDocuments]]
-== Add Documents
-
-Solr is built to find documents that match queries. Solr's schema provides an idea of how content is structured (more on the schema <<documents-fields-and-schema-design.adoc#documents-fields-and-schema-design,later>>), but without documents there is nothing to find. Solr needs input before it can do much.
-
-You may want to add a few sample documents before trying to index your own content. The Solr installation comes with different types of example documents located under the sub-directories of the `example/` directory of your installation.
-
-In the `bin/` directory is the post script, a command line tool which can be used to index different types of documents. Do not worry too much about the details for now. The <<indexing-and-basic-data-operations.adoc#indexing-and-basic-data-operations,Indexing and Basic Data Operations>> section has all the details on indexing.
-
-To see some information about the usage of `bin/post`, use the `-help` option. Windows users, see the section for <<post-tool.adoc#post-tool-windows-support,Post Tool on Windows>>.
-
-`bin/post` can post various types of content to Solr, including files in Solr's native XML and JSON formats, CSV files, a directory tree of rich documents, or even a simple short web crawl. See the examples at the end of `bin/post -help` for various commands to easily get started posting your content into Solr.
-
-Go ahead and add all the documents in some example XML files:
-
-[source,plain]
-----
-$ bin/post -c gettingstarted example/exampledocs/*.xml
-SimplePostTool version 5.0.0
-Posting files to [base] url http://localhost:8983/solr/gettingstarted/update...
-Entering auto mode. File endings considered are xml,json,csv,pdf,doc,docx,ppt,pptx,xls,xlsx,odt,odp,ods,ott,otp,ots,rtf,htm,html,txt,log
-POSTing file gb18030-example.xml (application/xml) to [base]
-POSTing file hd.xml (application/xml) to [base]
-POSTing file ipod_other.xml (application/xml) to [base]
-POSTing file ipod_video.xml (application/xml) to [base]
-POSTing file manufacturers.xml (application/xml) to [base]
-POSTing file mem.xml (application/xml) to [base]
-POSTing file money.xml (application/xml) to [base]
-POSTing file monitor.xml (application/xml) to [base]
-POSTing file monitor2.xml (application/xml) to [base]
-POSTing file mp500.xml (application/xml) to [base]
-POSTing file sd500.xml (application/xml) to [base]
-POSTing file solr.xml (application/xml) to [base]
-POSTing file utf8-example.xml (application/xml) to [base]
-POSTing file vidcard.xml (application/xml) to [base]
-14 files indexed.
-COMMITting Solr index changes to http://localhost:8983/solr/gettingstarted/update...
-Time spent: 0:00:00.153
-----
-
-That's it! Solr has indexed the documents contained in those files.
-
-[[RunningSolr-AskQuestions]]
-== Ask Questions
-
-Now that you have indexed documents, you can perform queries. The simplest way is by building a URL that includes the query parameters. This is exactly the same as building any other HTTP URL.
-
-For example, the following query searches all document fields for "video":
-
-`\http://localhost:8983/solr/gettingstarted/select?q=video`
-
-Notice how the URL includes the host name (`localhost`), the port number where the server is listening (`8983`), the application name (`solr`), the request handler for queries (`select`), and finally, the query itself (`q=video`).
-
-The results are contained in an XML document, which you can examine directly by clicking on the link above. The document contains two parts. The first part is the `responseHeader`, which contains information about the response itself. The main part of the reply is in the result tag, which contains one or more doc tags, each of which contains fields from documents that match the query. You can use standard XML transformation techniques to mold Solr's results into a form that is suitable for displaying to users. Alternatively, Solr can output the results in JSON, PHP, Ruby and even user-defined formats.
-
-Just in case you are not running Solr as you read, the following screen shot shows the result of a query (the next example, actually) as viewed in Mozilla Firefox. The top-level response contains a `lst` named `responseHeader` and a result named response. Inside result, you can see the three docs that represent the search results.
-
-.An XML response to a query.
-image::images/running-solr/solr34_responseHeader.png[image,width=600,height=634]
-
-Once you have mastered the basic idea of a query, it is easy to add enhancements to explore the query syntax. This one is the same as before but the results only contain the ID, name, and price for each returned document. If you don't specify which fields you want, all of them are returned.
-
-`\http://localhost:8983/solr/gettingstarted/select?q=video&fl=id,name,price`
-
-Here is another example which searches for "black" in the `name` field only. If you do not tell Solr which field to search, it will search default fields, as specified in the schema.
-
-`\http://localhost:8983/solr/gettingstarted/select?q=name:black`
-
-You can provide ranges for fields. The following query finds every document whose price is between $0 and $400.
-
-`\http://localhost:8983/solr/gettingstarted/select?q=price:[0%20TO%20400]&fl=id,name,price`
-
-<<faceting.adoc#faceting,Faceted browsing>> is one of Solr's key features. It allows users to narrow search results in ways that are meaningful to your application. For example, a shopping site could provide facets to narrow search results by manufacturer or price.
-
-Faceting information is returned as a third part of Solr's query response. To get a taste of this power, take a look at the following query. It adds `facet=true` and `facet.field=cat`.
-
-`\http://localhost:8983/solr/gettingstarted/select?q=price:[0%20TO%20400]&fl=id,name,price&facet=true&facet.field=cat`
-
-In addition to the familiar `responseHeader` and response from Solr, a `facet_counts` element is also present. Here is a view with the `responseHeader` and response collapsed so you can see the faceting information clearly.
-
-*An XML Response with faceting*
-
-[source,xml]
-----
-<response>
-<lst name="responseHeader">
-...
-</lst>
-<result name="response" numFound="9" start="0">
- <doc>
- <str name="id">SOLR1000</str>
- <str name="name">Solr, the Enterprise Search Server</str>
- <float name="price">0.0</float></doc>
-...
-</result>
-<lst name="facet_counts">
- <lst name="facet_queries"/>
- <lst name="facet_fields">
- <lst name="cat">
- <int name="electronics">6</int>
- <int name="memory">3</int>
- <int name="search">2</int>
- <int name="software">2</int>
- <int name="camera">1</int>
- <int name="copier">1</int>
- <int name="multifunction printer">1</int>
- <int name="music">1</int>
- <int name="printer">1</int>
- <int name="scanner">1</int>
- <int name="connector">0</int>
- <int name="currency">0</int>
- <int name="graphics card">0</int>
- <int name="hard drive">0</int>
- <int name="monitor">0</int>
- </lst>
- </lst>
- <lst name="facet_dates"/>
- <lst name="facet_ranges"/>
-</lst>
-</response>
-----
-
-The facet information shows how many of the query results have each possible value of the `cat` field. You could easily use this information to provide users with a quick way to narrow their query results. You can filter results by adding one or more filter queries to the Solr request. This request constrains documents with a category of "software".
-
-`\http://localhost:8983/solr/gettingstarted/select?q=price:0%20TO%20400&fl=id,name,price&facet=true&facet.field=cat&fq=cat:software`
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/solr-configuration-files.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/solr-configuration-files.adoc b/solr/solr-ref-guide/src/solr-configuration-files.adoc
new file mode 100644
index 0000000..98edb93
--- /dev/null
+++ b/solr/solr-ref-guide/src/solr-configuration-files.adoc
@@ -0,0 +1,80 @@
+= Solr Configuration Files
+:page-shortname: solr-configuration-files
+:page-permalink: solr-configuration-files.html
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+Solr has several configuration files that you will interact with during your implementation.
+
+Many of these files are in XML format, although APIs that interact with configuration settings tend to accept JSON for programmatic access as needed.
+
+== Solr Home
+When Solr runs, it needs access to a home directory.
+
+When you first install Solr, your home directory is `server/solr`. However, some examples may change this location (such as, if you run `bin/solr start -e cloud`, your home directory will be `example/cloud`).
+
+The home directory contains important configuration information and is the place where Solr will store its index. The layout of the home directory will look a little different when you are running Solr in standalone mode vs. when you are running in SolrCloud mode.
+
+The crucial parts of the Solr home directory are shown in these examples:
+
+.Standalone Mode
+[source,plain]
+----
+<solr-home-directory>/
+ solr.xml
+ core_name1/
+ core.properties
+ conf/
+ solrconfig.xml
+ managed-schema
+ data/
+ core_name2/
+ core.properties
+ conf/
+ solrconfig.xml
+ managed-schema
+ data/
+----
+
+.SolrCloud Mode
+[source,plain]
+----
+<solr-home-directory>/
+ solr.xml
+ core_name1/
+ core.properties
+ data/
+ core_name2/
+ core.properties
+ data/
+----
+
+You may see other files, but the main ones you need to know are discussed in the next section.
+
+== Configuration Files
+Inside Solr's Home, you'll find these files:
+
+* `solr.xml` specifies configuration options for your Solr server instance. For more information on `solr.xml` see <<solr-cores-and-solr-xml.adoc#solr-cores-and-solr-xml,Solr Cores and solr.xml>>.
+* Per Solr Core:
+** `core.properties` defines specific properties for each core such as its name, the collection the core belongs to, the location of the schema, and other parameters. For more details on `core.properties`, see the section <<defining-core-properties.adoc#defining-core-properties,Defining core.properties>>.
+** `solrconfig.xml` controls high-level behavior. You can, for example, specify an alternate location for the data directory. For more information on `solrconfig.xml`, see <<configuring-solrconfig-xml.adoc#configuring-solrconfig-xml,Configuring solrconfig.xml>>.
+** `managed-schema` (or `schema.xml` instead) describes the documents you will ask Solr to index. The Schema define a document as a collection of fields. You get to define both the field types and the fields themselves. Field type definitions are powerful and include information about how Solr processes incoming field values and query values. For more information on Solr Schemas, see <<documents-fields-and-schema-design.adoc#documents-fields-and-schema-design,Documents, Fields, and Schema Design>> and the <<schema-api.adoc#schema-api,Schema API>>.
+** `data/` The directory containing the low level index files.
+
+Note that the SolrCloud example does not include a `conf` directory for each Solr Core (so there is no `solrconfig.xml` or Schema file). This is because the configuration files usually found in the `conf` directory are stored in ZooKeeper so they can be propagated across the cluster.
+
+If you are using SolrCloud with the embedded ZooKeeper instance, you may also see `zoo.cfg` and `zoo.data` which are ZooKeeper configuration and data files. However, if you are running your own ZooKeeper ensemble, you would supply your own ZooKeeper configuration file when you start it and the copies in Solr would be unused. For more information about SolrCloud, see the section <<solrcloud.adoc#solrcloud,SolrCloud>>.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/solr-control-script-reference.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/solr-control-script-reference.adoc b/solr/solr-ref-guide/src/solr-control-script-reference.adoc
index 735d438..04d50f7 100644
--- a/solr/solr-ref-guide/src/solr-control-script-reference.adoc
+++ b/solr/solr-ref-guide/src/solr-control-script-reference.adoc
@@ -25,7 +25,7 @@ You can start and stop Solr, create and delete collections or cores, perform ope
You can find the script in the `bin/` directory of your Solr installation. The `bin/solr` script makes Solr easier to work with by providing simple commands and options to quickly accomplish common goals.
-More examples of `bin/solr` in use are available throughout the Solr Reference Guide, but particularly in the sections <<running-solr.adoc#running-solr,Running Solr>> and <<getting-started-with-solrcloud.adoc#getting-started-with-solrcloud,Getting Started with SolrCloud>>.
+More examples of `bin/solr` in use are available throughout the Solr Reference Guide, but particularly in the sections <<installing-solr.adoc#starting-solr,Starting Solr>> and <<getting-started-with-solrcloud.adoc#getting-started-with-solrcloud,Getting Started with SolrCloud>>.
== Starting and Stopping
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0b353b67/solr/solr-ref-guide/src/solr-system-requirements.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/solr-system-requirements.adoc b/solr/solr-ref-guide/src/solr-system-requirements.adoc
new file mode 100644
index 0000000..77230c7
--- /dev/null
+++ b/solr/solr-ref-guide/src/solr-system-requirements.adoc
@@ -0,0 +1,48 @@
+= Solr System Requirements
+:page-shortname: solr-system-requirements
+:page-permalink: solr-system-requirements.html
+:page-toc: false
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+You can install Solr in any system where a suitable Java Runtime Environment (JRE) is available, as detailed below.
+
+Currently this includes Linux, MacOS/OS X, and Microsoft Windows.
+
+== Installation Requirements
+
+=== Java Requirements
+
+You will need the Java Runtime Environment (JRE) version 1.8 or higher. At a command line, check your Java version like this:
+
+[source,bash]
+----
+$ java -version
+java version "1.8.0_60"
+Java(TM) SE Runtime Environment (build 1.8.0_60-b27)
+Java HotSpot(TM) 64-Bit Server VM (build 25.60-b23, mixed mode)
+----
+
+The exact output will vary, but you need to make sure you meet the minimum version requirement. We also recommend choosing a version that is not end-of-life from its vendor. Oracle or OpenJDK are the most tested JREs and are recommended. It's also recommended to use the latest available official release when possible.
+
+Some versions of Java VM have bugs that may impact your implementation. To be sure, check the page https://wiki.apache.org/lucene-java/JavaBugs[Lucene JavaBugs].
+
+If you don't have the required version, or if the `java` command is not found, download and install the latest version from Oracle at http://www.oracle.com/technetwork/java/javase/downloads/index.html.
+
+=== Supported Operating Systems
+
+Solr is tested on several versions of Linux, MacOS, and Windows.