From 32443cf8e32d1b9da7046bb654aac01b6fdf041d Mon Sep 17 00:00:00 2001 From: Cassandra Targett Date: Fri, 8 Feb 2019 13:09:22 -0600 Subject: [PATCH] Ref Guide: fix typos & abbreviated words --- solr/solr-ref-guide/src/collections-api.adoc | 14 +++++++------- solr/solr-ref-guide/src/config-sets.adoc | 2 +- solr/solr-ref-guide/src/configsets-api.adoc | 2 +- .../src/configuring-solrconfig-xml.adoc | 4 ++-- solr/solr-ref-guide/src/coreadmin-api.adoc | 2 +- ...datadir-and-directoryfactory-in-solrconfig.adoc | 2 +- solr/solr-ref-guide/src/docvalues.adoc | 2 +- solr/solr-ref-guide/src/function-queries.adoc | 2 +- .../src/implicit-requesthandlers.adoc | 2 +- solr/solr-ref-guide/src/json-facet-api.adoc | 2 +- solr/solr-ref-guide/src/language-analysis.adoc | 4 ++-- .../src/major-changes-in-solr-7.adoc | 2 +- .../src/making-and-restoring-backups.adoc | 2 +- .../src/query-settings-in-solrconfig.adoc | 2 +- .../solr-ref-guide/src/request-parameters-api.adoc | 4 ++-- solr/solr-ref-guide/src/response-writers.adoc | 2 +- solr/solr-ref-guide/src/schemaless-mode.adoc | 4 ++-- .../src/solr-control-script-reference.adoc | 2 +- solr/solr-ref-guide/src/solr-tutorial.adoc | 4 ++-- .../src/solrcloud-autoscaling-listeners.adoc | 2 +- .../src/solrcloud-autoscaling-triggers.adoc | 2 +- .../src/stream-decorator-reference.adoc | 2 +- .../src/stream-source-reference.adoc | 4 ++-- .../src/the-extended-dismax-query-parser.adoc | 2 +- .../src/uploading-data-with-index-handlers.adoc | 2 +- solr/solr-ref-guide/src/v2-api.adoc | 4 ++-- solr/solr-ref-guide/src/velocity-search-ui.adoc | 2 +- .../src/zookeeper-access-control.adoc | 2 +- 28 files changed, 41 insertions(+), 41 deletions(-) diff --git a/solr/solr-ref-guide/src/collections-api.adoc b/solr/solr-ref-guide/src/collections-api.adoc index 640e8f04a3e..c78db6d9b87 100644 --- a/solr/solr-ref-guide/src/collections-api.adoc +++ b/solr/solr-ref-guide/src/collections-api.adoc @@ -712,13 +712,12 @@ http://localhost:8983/solr/admin/collections?action=CREATEALIAS&name=testalias&c ---- -Create an alias named "myTimeData" for data begining on `2018-01-15` in the UTC time zone and partitioning daily -based on the `evt_dt` field in the incomming documents. Data more than an hour beyond the latest (most recent) -partiton is to be rejected and collections are created using a config set named myConfig and - - *Input* +Create an alias named "myTimeData" for data beginning on `2018-01-15` in the UTC time zone and partitioning daily +based on the `evt_dt` field in the incoming documents. Data more than one hour beyond the latest (most recent) +partition is to be rejected and collections are created using a configset named "myConfig". + [source,text] ---- http://localhost:8983/solr/admin/collections?action=CREATEALIAS&name=myTimeData&router.start=NOW/DAY&router.field=evt_dt&router.name=time&router.interval=%2B1DAY&router.maxFutureMs=3600000&create-collection.collection.configName=myConfig&create-collection.numShards=2 @@ -736,11 +735,12 @@ http://localhost:8983/solr/admin/collections?action=CREATEALIAS&name=myTimeData& ---- -A somewhat contrived example demonstrating the <> usage and additional collection creation options. -Notice that the collection creation parameters follow the v2 API naming convention, not the v1 naming conventions. *Input* +A somewhat contrived example demonstrating the <> usage and additional collection creation options. +Notice that the collection creation parameters follow the v2 API naming convention, not the v1 naming conventions. + [source,json] ---- POST /api/c diff --git a/solr/solr-ref-guide/src/config-sets.adoc b/solr/solr-ref-guide/src/config-sets.adoc index b61be18260c..7bb8a25035c 100644 --- a/solr/solr-ref-guide/src/config-sets.adoc +++ b/solr/solr-ref-guide/src/config-sets.adoc @@ -26,7 +26,7 @@ Solr ships with two example configsets located in `server/solr/configsets`, whic If you are using Solr in standalone mode, configsets are created on the filesystem. -To create a configset, add a new directory under the configset base directory. The configset will be identified by the name of this directory. Then into this copy the config directory you want to share. The structure should look something like this: +To create a configset, add a new directory under the configset base directory. The configset will be identified by the name of this directory. Then into this copy the configuration directory you want to share. The structure should look something like this: [source,bash] ---- diff --git a/solr/solr-ref-guide/src/configsets-api.adoc b/solr/solr-ref-guide/src/configsets-api.adoc index 1fbab30a0f2..8e2eb2e25b3 100644 --- a/solr/solr-ref-guide/src/configsets-api.adoc +++ b/solr/solr-ref-guide/src/configsets-api.adoc @@ -99,7 +99,7 @@ The configset to be created when the upload is complete. This parameter is requi The body of the request should be a zip file that contains the configset. The zip file must be created from within the `conf` directory (i.e., `solrconfig.xml` must be the top level entry in the zip file). -Here is an example on how to create the zip file named "myconfig.zip" and upload it as a config set named "myConfigSet": +Here is an example on how to create the zip file named "myconfig.zip" and upload it as a configset named "myConfigSet": [source,bash] ---- diff --git a/solr/solr-ref-guide/src/configuring-solrconfig-xml.adoc b/solr/solr-ref-guide/src/configuring-solrconfig-xml.adoc index d2570faedd9..aaeb31b3740 100644 --- a/solr/solr-ref-guide/src/configuring-solrconfig-xml.adoc +++ b/solr/solr-ref-guide/src/configuring-solrconfig-xml.adoc @@ -51,9 +51,9 @@ We've covered the options in the following sections: == Substituting Properties in Solr Config Files -Solr supports variable substitution of property values in config files, which allows runtime specification of various configuration options in `solrconfig.xml`. The syntax is `${propertyname[:option default value]`}. This allows defining a default that can be overridden when Solr is launched. If a default value is not specified, then the property _must_ be specified at runtime or the configuration file will generate an error when parsed. +Solr supports variable substitution of property values in configuration files, which allows runtime specification of various configuration options in `solrconfig.xml`. The syntax is `${propertyname[:option default value]`}. This allows defining a default that can be overridden when Solr is launched. If a default value is not specified, then the property _must_ be specified at runtime or the configuration file will generate an error when parsed. -There are multiple methods for specifying properties that can be used in configuration files. Of those below, strongly consider "config overlay" as the preferred approach, as it stays local to the config set and because it's easy to modify. +There are multiple methods for specifying properties that can be used in configuration files. Of those below, strongly consider "config overlay" as the preferred approach, as it stays local to the configset and is easy to modify. === JVM System Properties diff --git a/solr/solr-ref-guide/src/coreadmin-api.adoc b/solr/solr-ref-guide/src/coreadmin-api.adoc index 46904485763..3b2059c6c58 100644 --- a/solr/solr-ref-guide/src/coreadmin-api.adoc +++ b/solr/solr-ref-guide/src/coreadmin-api.adoc @@ -60,7 +60,7 @@ Your CREATE call must be able to find a configuration, or it will not succeed. When you are running SolrCloud and create a new core for a collection, the configuration will be inherited from the collection. Each collection is linked to a configName, which is stored in ZooKeeper. This satisfies the config requirement. There is something to note, though – if you're running SolrCloud, you should *NOT* be using the CoreAdmin API at all. Use the <>. -When you are not running SolrCloud, if you have <> defined, you can use the configSet parameter as documented below. If there are no config sets, then the `instanceDir` specified in the CREATE call must already exist, and it must contain a `conf` directory which in turn must contain `solrconfig.xml`, your schema (usually named either `managed-schema` or `schema.xml`), and any files referenced by those configs. +When you are not running SolrCloud, if you have <> defined, you can use the configSet parameter as documented below. If there are no configsets, then the `instanceDir` specified in the CREATE call must already exist, and it must contain a `conf` directory which in turn must contain `solrconfig.xml`, your schema (usually named either `managed-schema` or `schema.xml`), and any files referenced by those configs. The config and schema filenames can be specified with the `config` and `schema` parameters, but these are expert options. One thing you could do to avoid creating the `conf` directory is use `config` and `schema` parameters that point at absolute paths, but this can lead to confusing configurations unless you fully understand what you are doing. ==== diff --git a/solr/solr-ref-guide/src/datadir-and-directoryfactory-in-solrconfig.adoc b/solr/solr-ref-guide/src/datadir-and-directoryfactory-in-solrconfig.adoc index d58b7a95efa..0af9374de25 100644 --- a/solr/solr-ref-guide/src/datadir-and-directoryfactory-in-solrconfig.adoc +++ b/solr/solr-ref-guide/src/datadir-and-directoryfactory-in-solrconfig.adoc @@ -36,7 +36,7 @@ element `` then the location of data directory will be `>: +Enabling a field for docValues only requires adding `docValues="true"` to the field (or field type) definition, as in this example from the `schema.xml` of Solr's `sample_techproducts_configs` <>: [source,xml] ---- diff --git a/solr/solr-ref-guide/src/function-queries.adoc b/solr/solr-ref-guide/src/function-queries.adoc index e9e63de2e72..ac276d103e0 100644 --- a/solr/solr-ref-guide/src/function-queries.adoc +++ b/solr/solr-ref-guide/src/function-queries.adoc @@ -58,7 +58,7 @@ the output would be: 0.343 ... ---- -* Use in a parameter that is explicitly for specifying functions, such as the eDisMax query parser's <> param, or DisMax query parser's <>. (Note that the `bf` parameter actually takes a list of function queries separated by white space and each with an optional boost. Make sure you eliminate any internal white space in single function queries when using `bf`). For example: +* Use in a parameter that is explicitly for specifying functions, such as the eDisMax query parser's <>, or the DisMax query parser's <>. (Note that the `bf` parameter actually takes a list of function queries separated by white space and each with an optional boost. Make sure you eliminate any internal white space in single function queries when using `bf`). For example: + [source,text] ---- diff --git a/solr/solr-ref-guide/src/implicit-requesthandlers.adoc b/solr/solr-ref-guide/src/implicit-requesthandlers.adoc index 6a1c0a34192..6a3d1d90cd3 100644 --- a/solr/solr-ref-guide/src/implicit-requesthandlers.adoc +++ b/solr/solr-ref-guide/src/implicit-requesthandlers.adoc @@ -314,7 +314,7 @@ Custom JSON Updates:: Add and update custom JSON-formatted documents. You can see configuration for all request handlers, including the implicit request handlers, via the <>. -To include the expanded paramset in the response, as well as the effective parameters from merging the paramset parameters with the built-in parameters, use the `expandParams` request param. For the `/export` request handler, you can make a request like this: +To include the expanded paramset in the response, as well as the effective parameters from merging the paramset parameters with the built-in parameters, use the `expandParams` request parameter. For the `/export` request handler, you can make a request like this: [.dynamic-tabs] diff --git a/solr/solr-ref-guide/src/json-facet-api.adoc b/solr/solr-ref-guide/src/json-facet-api.adoc index 76555763af9..fbccf9112a8 100644 --- a/solr/solr-ref-guide/src/json-facet-api.adoc +++ b/solr/solr-ref-guide/src/json-facet-api.adoc @@ -227,7 +227,7 @@ This parameter indicates the facet algorithm to use: * "stream" Presently equivalent to "enum" * "smart" Pick the best method for the field type (this is the default) -|prelim_sort |An optional parameter for specifying an approximation of the final `sort` to use during initial collection of top buckets when the <>. +|prelim_sort |An optional parameter for specifying an approximation of the final `sort` to use during initial collection of top buckets when the <>. |=== === Query Facet diff --git a/solr/solr-ref-guide/src/language-analysis.adoc b/solr/solr-ref-guide/src/language-analysis.adoc index 758c7f640c7..06c27c47e52 100644 --- a/solr/solr-ref-guide/src/language-analysis.adoc +++ b/solr/solr-ref-guide/src/language-analysis.adoc @@ -29,7 +29,7 @@ For information about language detection at index time, see <> directory: +A sample Solr `protwords.txt` with comments can be found in the `sample_techproducts_configs` <> directory: [source,xml] ---- @@ -1267,7 +1267,7 @@ Removes terms with one of the configured parts-of-speech. `JapaneseTokenizer` an *Arguments:* -`tags`:: filename for a list of parts-of-speech for which to remove terms; see `conf/lang/stoptags_ja.txt` in the `sample_techproducts_config` <> for an example. +`tags`:: filename for a list of parts-of-speech for which to remove terms; see `conf/lang/stoptags_ja.txt` in the `sample_techproducts_config` <> for an example. `enablePositionIncrements`:: if `luceneMatchVersion` is `4.3` or earlier and `enablePositionIncrements="false"`, no position holes will be left by this filter when it removes tokens. *This argument is invalid if `luceneMatchVersion` is `5.0` or later.* diff --git a/solr/solr-ref-guide/src/major-changes-in-solr-7.adoc b/solr/solr-ref-guide/src/major-changes-in-solr-7.adoc index 9689d276d01..5efa39928f7 100644 --- a/solr/solr-ref-guide/src/major-changes-in-solr-7.adoc +++ b/solr/solr-ref-guide/src/major-changes-in-solr-7.adoc @@ -167,7 +167,7 @@ The following changes were made in SolrJ. * `HttpClientInterceptorPlugin` is now `HttpClientBuilderPlugin` and must work with a `SolrHttpClientBuilder` rather than an `HttpClientConfigurer`. * `HttpClientUtil` now allows configuring `HttpClient` instances via `SolrHttpClientBuilder` rather than an `HttpClientConfigurer`. Use of env variable `SOLR_AUTHENTICATION_CLIENT_CONFIGURER` no longer works, please use `SOLR_AUTHENTICATION_CLIENT_BUILDER` * `SolrClient` implementations now use their own internal configuration for socket timeouts, connect timeouts, and allowing redirects rather than what is set as the default when building the `HttpClient` instance. Use the appropriate setters on the `SolrClient` instance. -* `HttpSolrClient#setAllowCompression` has been removed and compression must be enabled as a constructor param. +* `HttpSolrClient#setAllowCompression` has been removed and compression must be enabled as a constructor parameter. * `HttpSolrClient#setDefaultMaxConnectionsPerHost` and `HttpSolrClient#setMaxTotalConnections` have been removed. These now default very high and can only be changed via parameter when creating an HttpClient instance. === Other Deprecations and Removals diff --git a/solr/solr-ref-guide/src/making-and-restoring-backups.adoc b/solr/solr-ref-guide/src/making-and-restoring-backups.adoc index fc17ebb6066..b6039293bfc 100644 --- a/solr/solr-ref-guide/src/making-and-restoring-backups.adoc +++ b/solr/solr-ref-guide/src/making-and-restoring-backups.adoc @@ -231,4 +231,4 @@ Example `solr.xml` section to configure a repository like < ---- -Better throughput might be achieved by increasing buffer size with `262144`. Buffer size is specified in bytes, by default it's 4KB. \ No newline at end of file +Better throughput might be achieved by increasing buffer size with `262144`. Buffer size is specified in bytes, by default it's 4096 bytes (4KB). diff --git a/solr/solr-ref-guide/src/query-settings-in-solrconfig.adoc b/solr/solr-ref-guide/src/query-settings-in-solrconfig.adoc index 39710f6b4aa..1e3a199fcac 100644 --- a/solr/solr-ref-guide/src/query-settings-in-solrconfig.adoc +++ b/solr/solr-ref-guide/src/query-settings-in-solrconfig.adoc @@ -200,7 +200,7 @@ Good query selection is key with this type of listener. It's best to choose your There are two types of events that can trigger a listener. A `firstSearcher` event occurs when a new searcher is being prepared but there is no current registered searcher to handle requests or to gain auto-warming data from (i.e., on Solr startup). A `newSearcher` event is fired whenever a new searcher is being prepared and there is a current searcher handling requests. -The (commented out) examples below can be found in the `solrconfig.xml` file of the `sample_techproducts_configs` <>included with Solr, and demonstrate using the `solr.QuerySenderListener` class to warm a set of explicit queries: +The (commented out) examples below can be found in the `solrconfig.xml` file of the `sample_techproducts_configs` <> included with Solr, and demonstrate using the `solr.QuerySenderListener` class to warm a set of explicit queries: [source,xml] ---- diff --git a/solr/solr-ref-guide/src/request-parameters-api.adoc b/solr/solr-ref-guide/src/request-parameters-api.adoc index 4a3dd546908..f76b2d82ea1 100644 --- a/solr/solr-ref-guide/src/request-parameters-api.adoc +++ b/solr/solr-ref-guide/src/request-parameters-api.adoc @@ -118,7 +118,7 @@ Solr ships with many out-of-the-box request handlers that may only be configured === Viewing Expanded Paramsets and Effective Parameters with RequestHandlers -To see the expanded paramset and the resulting effective parameters for a RequestHandler defined with `useParams`, use the `expandParams` request param. As an example, for the `/export` request handler: +To see the expanded paramset and the resulting effective parameters for a RequestHandler defined with `useParams`, use the `expandParams` request parameter. As an example, for the `/export` request handler: [source,bash] ---- @@ -155,7 +155,7 @@ It is possible to pass more than one parameter set in the same request. For exam http://localhost/solr/techproducts/select?useParams=myFacets,myQueries ---- -In the above example the param set 'myQueries' is applied on top of 'myFacets'. So, values in 'myQueries' take precedence over values in 'myFacets'. Additionally, any values passed in the request take precedence over `useParams` parameters. This acts like the "defaults" specified in the `` definition in `solrconfig.xml`. +In the above example the parameter set 'myQueries' is applied on top of 'myFacets'. So, values in 'myQueries' take precedence over values in 'myFacets'. Additionally, any values passed in the request take precedence over `useParams` parameters. This acts like the "defaults" specified in the `` definition in `solrconfig.xml`. The parameter sets can be used directly in a request handler definition as follows. Please note that the `useParams` specified is always applied even if the request contains `useParams`. diff --git a/solr/solr-ref-guide/src/response-writers.adoc b/solr/solr-ref-guide/src/response-writers.adoc index 15d11547fb9..919f7d7038c 100644 --- a/solr/solr-ref-guide/src/response-writers.adoc +++ b/solr/solr-ref-guide/src/response-writers.adoc @@ -167,7 +167,7 @@ The Content-Type of the response is set according to the `` statemen === XSLT Configuration -The example below, from the `sample_techproducts_configs` <> in the Solr distribution, shows how the XSLT Response Writer is configured. +The example below, from the `sample_techproducts_configs` <> in the Solr distribution, shows how the XSLT Response Writer is configured. [source,xml] ---- diff --git a/solr/solr-ref-guide/src/schemaless-mode.adoc b/solr/solr-ref-guide/src/schemaless-mode.adoc index dd8e8dc1fa6..b900424c61f 100644 --- a/solr/solr-ref-guide/src/schemaless-mode.adoc +++ b/solr/solr-ref-guide/src/schemaless-mode.adoc @@ -26,7 +26,7 @@ These Solr features, all controlled via `solrconfig.xml`, are: == Using the Schemaless Example -The three features of schemaless mode are pre-configured in the `_default` <> in the Solr distribution. To start an example instance of Solr using these configs, run the following command: +The three features of schemaless mode are pre-configured in the `_default` <> in the Solr distribution. To start an example instance of Solr using these configs, run the following command: [source,bash] ---- @@ -66,7 +66,7 @@ You can use the `/schema/fields` <> to co == Configuring Schemaless Mode -As described above, there are three configuration elements that need to be in place to use Solr in schemaless mode. In the `_default` config set included with Solr these are already configured. If, however, you would like to implement schemaless on your own, you should make the following changes. +As described above, there are three configuration elements that need to be in place to use Solr in schemaless mode. In the `_default` configset included with Solr these are already configured. If, however, you would like to implement schemaless on your own, you should make the following changes. === Enable Managed Schema 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 67100191f90..a6f52e796a1 100644 --- a/solr/solr-ref-guide/src/solr-control-script-reference.adoc +++ b/solr/solr-ref-guide/src/solr-control-script-reference.adoc @@ -698,7 +698,7 @@ Use the `zk downconfig` command to download a configuration set from ZooKeeper t All parameters listed below are required. `-n `:: -Name of config set in ZooKeeper to download. The Admin UI Cloud \-> Tree \-> configs node lists all available configuration sets. +Name of the configset in ZooKeeper to download. The Admin UI Cloud \-> Tree \-> configs node lists all available configuration sets. + *Example*: `-n myconfig` diff --git a/solr/solr-ref-guide/src/solr-tutorial.adoc b/solr/solr-ref-guide/src/solr-tutorial.adoc index 99fee4b6192..5ce22ac30be 100644 --- a/solr/solr-ref-guide/src/solr-tutorial.adoc +++ b/solr/solr-ref-guide/src/solr-tutorial.adoc @@ -322,7 +322,7 @@ The response indicates that there are 4 hits (`"numFound":4`). We've only includ Note the `responseHeader` before the documents. This header will include the parameters you have set for the search. By default it shows only the parameters _you_ have set for this query, which in this case is only your query term. -The documents we got back include all the fields for each document that were indexed. This is, again, default behavior. If you want to restrict the fields in the response, you can use the `fl` param, which takes a comma-separated list of field names. This is one of the available fields on the query form in the Admin UI. +The documents we got back include all the fields for each document that were indexed. This is, again, default behavior. If you want to restrict the fields in the response, you can use the `fl` parameter, which takes a comma-separated list of field names. This is one of the available fields on the query form in the Admin UI. Put "id" (without quotes) in the "fl" box and hit btn:[Execute Query] again. Or, to specify it with curl: @@ -706,7 +706,7 @@ On the Admin UI Query tab, if you check the `facet` checkbox, you'll see a few f .Facet options in the Query screen image::images/solr-tutorial/tutorial-admin-ui-facet-options.png[Solr Quick Start: Query tab facet options] -To see facet counts from all documents (`q=\*:*`): turn on faceting (`facet=true`), and specify the field to facet on via the `facet.field` param. If you only want facets, and no document contents, specify `rows=0`. The `curl` command below will return facet counts for the `genre_str` field: +To see facet counts from all documents (`q=\*:*`): turn on faceting (`facet=true`), and specify the field to facet on via the `facet.field` parameter. If you only want facets, and no document contents, specify `rows=0`. The `curl` command below will return facet counts for the `genre_str` field: `curl "http://localhost:8983/solr/films/select?q=\*:*&rows=0&facet=true&facet.field=genre_str"` diff --git a/solr/solr-ref-guide/src/solrcloud-autoscaling-listeners.adoc b/solr/solr-ref-guide/src/solrcloud-autoscaling-listeners.adoc index 0c87e64f724..f3cc02d3227 100644 --- a/solr/solr-ref-guide/src/solrcloud-autoscaling-listeners.adoc +++ b/solr/solr-ref-guide/src/solrcloud-autoscaling-listeners.adoc @@ -216,5 +216,5 @@ The following properties are available in context and can be referenced from tem ---- This configuration specifies that each time one of the listed stages is reached, or before and after each of the listed -actions is executed, the listener will send the templated payload to a URL that also depends on the config and the current event, +actions is executed, the listener will send the templated payload to a URL that also depends on the configuration and the current event, and with a custom header that indicates the trigger name. diff --git a/solr/solr-ref-guide/src/solrcloud-autoscaling-triggers.adoc b/solr/solr-ref-guide/src/solrcloud-autoscaling-triggers.adoc index 6d386c891aa..42cc6f51568 100644 --- a/solr/solr-ref-guide/src/solrcloud-autoscaling-triggers.adoc +++ b/solr/solr-ref-guide/src/solrcloud-autoscaling-triggers.adoc @@ -374,7 +374,7 @@ This trigger calculates node-level cumulative rates using per-replica rates repo replicas that are part of monitored collections / shards on each node. This means that it may report some nodes as "cold" (underutilized) because it ignores other, perhaps more active, replicas belonging to other collections. Also, nodes that don't host any of the monitored replicas or -those that are explicitly excluded by `node` config property won't be reported at all. +those that are explicitly excluded by `node` configuration property won't be reported at all. .Calculating `waitFor` [CAUTION] diff --git a/solr/solr-ref-guide/src/stream-decorator-reference.adoc b/solr/solr-ref-guide/src/stream-decorator-reference.adoc index 3d9f5697b33..1465b83b807 100644 --- a/solr/solr-ref-guide/src/stream-decorator-reference.adoc +++ b/solr/solr-ref-guide/src/stream-decorator-reference.adoc @@ -1163,7 +1163,7 @@ rollup( ) ---- -The example about shows the rollup function wrapping the search function. Notice that search function is using the `/export` handler to provide the entire result set to the rollup stream. Also notice that the search function's *sort param* matches up with the rollup's `over` parameter. This allows the rollup function to rollup the over the `a_s` field, one group at a time. +The example about shows the rollup function wrapping the search function. Notice that search function is using the `/export` handler to provide the entire result set to the rollup stream. Also notice that the search function's `sort` parameter matches up with the rollup's `over` parameter. This allows the rollup function to rollup the over the `a_s` field, one group at a time. == scoreNodes diff --git a/solr/solr-ref-guide/src/stream-source-reference.adoc b/solr/solr-ref-guide/src/stream-source-reference.adoc index c83991e521b..74aef0f3780 100644 --- a/solr/solr-ref-guide/src/stream-source-reference.adoc +++ b/solr/solr-ref-guide/src/stream-source-reference.adoc @@ -183,8 +183,8 @@ facet(collection1, count(*)) ---- -The example above shows a facet function with rollups over three buckets, where the buckets are returned in descending order by bucket value. -The rows param returns 10 rows and the offset param starts returning rows from the 20th row. +The example above shows a `facet` function with rollups over three buckets, where the buckets are returned in descending order by bucket value. +The `rows` parameter returns 10 rows and the `offset` parameter starts returning rows from the 20th row. == features diff --git a/solr/solr-ref-guide/src/the-extended-dismax-query-parser.adoc b/solr/solr-ref-guide/src/the-extended-dismax-query-parser.adoc index 1a514210570..70b8e7b73f1 100644 --- a/solr/solr-ref-guide/src/the-extended-dismax-query-parser.adoc +++ b/solr/solr-ref-guide/src/the-extended-dismax-query-parser.adoc @@ -131,7 +131,7 @@ You can boost results that have a field that matches a specific value: http://localhost:8983/solr/techproducts/select?q=video&defType=edismax&qf=features^20.0+text^0.3&bq=cat:electronics^5.0 ---- -Using the "mm" param, 1 and 2 word queries require that all of the optional clauses match, but for queries with three or more clauses one missing clause is allowed: +Using the `mm` parameter, 1 and 2 word queries require that all of the optional clauses match, but for queries with three or more clauses one missing clause is allowed: [source,text] ---- diff --git a/solr/solr-ref-guide/src/uploading-data-with-index-handlers.adoc b/solr/solr-ref-guide/src/uploading-data-with-index-handlers.adoc index 96ad2560686..3bf9b52a1d5 100644 --- a/solr/solr-ref-guide/src/uploading-data-with-index-handlers.adoc +++ b/solr/solr-ref-guide/src/uploading-data-with-index-handlers.adoc @@ -215,7 +215,7 @@ The status field will be non-zero in case of failure. === Using XSLT to Transform XML Index Updates -The UpdateRequestHandler allows you to index any arbitrary XML using the `` parameter to apply an https://en.wikipedia.org/wiki/XSLT[XSL transformation]. You must have an XSLT stylesheet in the `conf/xslt` directory of your <> that can transform the incoming data to the expected `` format, and use the `tr` parameter to specify the name of that stylesheet. +The UpdateRequestHandler allows you to index any arbitrary XML using the `` parameter to apply an https://en.wikipedia.org/wiki/XSLT[XSL transformation]. You must have an XSLT stylesheet in the `conf/xslt` directory of your <> that can transform the incoming data to the expected `` format, and use the `tr` parameter to specify the name of that stylesheet. Here is an example XSLT stylesheet: diff --git a/solr/solr-ref-guide/src/v2-api.adoc b/solr/solr-ref-guide/src/v2-api.adoc index 8541d9f4c91..5ca9459ae4a 100644 --- a/solr/solr-ref-guide/src/v2-api.adoc +++ b/solr/solr-ref-guide/src/v2-api.adoc @@ -55,11 +55,11 @@ Append `/_introspect` to any valid v2 API path and the API specification will be `\http://localhost:8983/api/c/_introspect` -To limit the introspect output to include just one particular HTTP method, add request param `method` with value `GET`, `POST`, or `DELETE`. +To limit the introspect output to include just one particular HTTP method, add the request parameter `method` with value `GET`, `POST`, or `DELETE`. `\http://localhost:8983/api/c/_introspect?method=POST` -Most endpoints support commands provided in a body sent via POST. To limit the introspect output to only one command, add request param `command=_command-name_`. +Most endpoints support commands provided in a body sent via POST. To limit the introspect output to only one command, add the request parameter `command=_command-name_`. `\http://localhost:8983/api/c/gettingstarted/_introspect?method=POST&command=modify` diff --git a/solr/solr-ref-guide/src/velocity-search-ui.adoc b/solr/solr-ref-guide/src/velocity-search-ui.adoc index 7777254e650..96d7f93c58e 100644 --- a/solr/solr-ref-guide/src/velocity-search-ui.adoc +++ b/solr/solr-ref-guide/src/velocity-search-ui.adoc @@ -18,7 +18,7 @@ Solr includes a sample search UI based on the <> (also known as Solritas) that demonstrates several useful features, such as searching, faceting, highlighting, autocomplete, and geospatial searching. -When using the `sample_techproducts_configs` config set, you can access the Velocity sample Search UI: `\http://localhost:8983/solr/techproducts/browse` +When using the `sample_techproducts_configs` configset, you can access the Velocity sample Search UI: `\http://localhost:8983/solr/techproducts/browse` .The Velocity Search UI image::images/velocity-search-ui/techproducts_browse.png[image,width=500] diff --git a/solr/solr-ref-guide/src/zookeeper-access-control.adoc b/solr/solr-ref-guide/src/zookeeper-access-control.adoc index 588c7860acd..55ada593c97 100644 --- a/solr/solr-ref-guide/src/zookeeper-access-control.adoc +++ b/solr/solr-ref-guide/src/zookeeper-access-control.adoc @@ -97,7 +97,7 @@ There are two scripts that impact ZooKeeper ACLs: * For *nix systems: `bin/solr` & `server/scripts/cloud-scripts/zkcli.sh` * For Windows systems: `bin/solr.cmd` & `server/scripts/cloud-scripts/zkcli.bat` -These Solr scripts can enable use of ZK ACLs by setting the appropriate system properties: uncomment the following and replace the passwords with ones you choose to enable the above-described VM parameters ACL and credentials providers in the following files: +These Solr scripts can enable use of ZooKeeper ACLs by setting the appropriate system properties: uncomment the following and replace the passwords with ones you choose to enable the above-described VM parameters ACL and credentials providers in the following files: .solr.in.sh [source,bash]