Skip to content

Commit

Permalink
Ref Guide: Miscellaneous cleanups (apache#258)
Browse files Browse the repository at this point in the history
  • Loading branch information
ctargett authored Aug 11, 2021
1 parent 361fa39 commit de96857
Show file tree
Hide file tree
Showing 30 changed files with 78 additions and 89 deletions.
4 changes: 2 additions & 2 deletions solr/solr-ref-guide/src/about-this-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ The URL would then become:

Path information is given relative to `solr.home`, which is the location under the main Solr installation where Solr's collections and their `conf` and `data` directories are stored.

In many cases, this is is in the `server/solr` directory of your installation.
In many cases, this is in the `server/solr` directory of your installation.
However, there can be exceptions, particularly if your installation has customized this.

In several cases of this Guide, our examples are built from the the "techproducts" example (i.e., you have started Solr with the command `bin/solr -e techproducts`).
In several cases of this Guide, our examples are built from the "techproducts" example (i.e., you have started Solr with the command `bin/solr -e techproducts`).
In this case, `solr.home` will be a sub-directory of the `example/` directory created for you automatically.

See also the section <<configuration-files.adoc#solr-home,Solr Home>> for further details on what is contained in this directory.
Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/analytics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ An Analytics request is passed to Solr with the parameter `analytics` in a reque
<<requesthandlers-searchcomponents.adoc#search-handlers,Search Handler>>.
Since the analytics request is sent inside of a search handler request, it will compute results based on the result set determined by the search handler.

For example, this curl command encodes and POSTs a simple analytics request to the the search handler:
For example, this curl command encodes and POSTs a simple analytics request to the search handler:

[source,bash]
----
Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/collapse-and-expand-results.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ For example: searching for "grand child" documents and collapsing on a field tha
====
Specifing `hint=block` when collapsing on a field that is not unique per contiguous block of documents is not supported and may fail in unexpected ways; including the possibility of silently returning incorrect results.
The implementation does not offer any safeguards against misuse on an unsupported field, since doing so would require the the same group level tracking as the non-Block collapsing implementation -- defeating the purpose of this optimization.
The implementation does not offer any safeguards against misuse on an unsupported field, since doing so would require the same group level tracking as the non-Block collapsing implementation -- defeating the purpose of this optimization.
====

== Expand Component
Expand Down
6 changes: 3 additions & 3 deletions solr/solr-ref-guide/src/collection-management.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ curl -X POST http://localhost:8983/api/collections/techproducts_v2 -H 'Content-T
'
----
Additional parameters can be passed in via the the `reload` key:
Additional parameters can be passed in via the `reload` key:
[source,bash]
----
Expand Down Expand Up @@ -1195,7 +1195,7 @@ Data types shown in the response can be roughly divided into the following group
For example, for UTF-8 strings this represents the aggregated sum of the number of bytes in the strings' UTF-8 representation, for long numbers this is 8 bytes per value, etc.

* `terms_terms` - represents the aggregated size of the term dictionary.
The size of this data is affected by the the number and length of unique terms, which in turn depends on the field size and the analysis chain.
The size of this data is affected by the number and length of unique terms, which in turn depends on the field size and the analysis chain.

* `terms_postings` - represents the aggregated size of all term position and offset information, if present.
This information may be absent if position-based searching, such as phrase queries, is not needed.
Expand Down Expand Up @@ -1933,7 +1933,7 @@ See the parameter descriptions below for more information.

*Input*

The following API command deletes the the first backup (`backupId=0`) at the specified repository location.
The following API command deletes the first backup (`backupId=0`) at the specified repository location.

[.dynamic-tabs]
--
Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/commits-transaction-logs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ In the event of un-graceful shutdown, it can take up to the time specified in `a
The time chosen for `autoSoftCommit` determines the maximum time after a document is sent to Solr before it becomes searchable and does not affect the transaction log.

Choose as long an interval as your application can tolerate for this value, often 15-60 seconds is reasonable, or even longer depending on the requirements.
In situations where the the time is set to a very short interval (say 1 second), consider disabling your caches (queryResultCache and filterCache especially) as they will have little utility.
In situations where the time is set to a very short interval (say 1 second), consider disabling your caches (queryResultCache and filterCache especially) as they will have little utility.

TIP: For extremely high bulk indexing, especially for the initial load if there is no searching, consider turning off `autoSoftCommit` by specifying a value of `-1` for the maxTime parameter.

Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/common-query-parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Solr can sort query responses according to:
* A SortableTextField which implicitly uses `docValues="true"` by default to allow sorting on the original input string regardless of the analyzers used for Searching.
* A single-valued TextField that uses an analyzer (such as the KeywordTokenizer) that produces only a single term per document.
TextField does not support `docValues="true"`, but a DocValue-like structure will be built on the fly at runtime.
** *NOTE:* If you want to be able to sort on a field whose contents you want to tokenize to facilitate searching, <<copy-fields.adoc#,use a `copyField` directive>> in the the Schema to clone the field.
** *NOTE:* If you want to be able to sort on a field whose contents you want to tokenize to facilitate searching, <<copy-fields.adoc#,use a `copyField` directive>> in the Schema to clone the field.
Then search on the field and sort on its clone.

In the case of primitive fields, or SortableTextFields, that are `multiValued="true"` the representative value used for each doc when sorting depends on the sort direction: The minimum value in each document is used for ascending (`asc`) sorting, while the maximal value in each document is used for descending (`desc`) sorting.
Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/date-formatting-math.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Note that while date math is most commonly used relative to `NOW` it can be appl
==== NOW

The `NOW` parameter is used internally by Solr to ensure consistent date math expression parsing across multiple nodes in a distributed request.
But it can be specified to instruct Solr to use an arbitrary moment in time (past or future) to override for all situations where the the special value of "```NOW```" would impact date math expressions.
But it can be specified to instruct Solr to use an arbitrary moment in time (past or future) to override for all situations where the special value of `NOW` would impact date math expressions.

It must be specified as a (long valued) milliseconds since epoch.

Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/dsp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Notice that the `conv` function is simply correlating the sine wave with itself.

The plot has a very distinct structure to it.
As the sine wave is slid across a copy of itself the correlation moves up and down in increasing intensity until it reaches a peak.
This peak is directly in the center and is the the point where the sine waves are directly lined up.
This peak is directly in the center and is the point where the sine waves are directly lined up.
Following the peak the correlation moves up and down in decreasing intensity as the sine wave slides farther away from being directly lined up.

This is the autocorrelation plot of a pure signal.
Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/fields.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ If this property is not specified, there is no default.
== Optional Field Type Override Properties

Fields can have many of the same properties as field types.
Properties from the table below which are specified on an individual field will override any explicit value for that property specified on the the `fieldType` of the field, or any implicit default property value provided by the underlying `fieldType` implementation.
Properties from the table below which are specified on an individual field will override any explicit value for that property specified on the `fieldType` of the field, or any implicit default property value provided by the underlying `fieldType` implementation.
The table below is reproduced from <<field-type-definitions-and-properties.adoc#,Field Type Definitions and Properties>>, which has more details:

--
Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/index-segments-merging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ Many <<Merging Index Segments,Merge Policy>> implementations support `noCFSRatio
== Segments Info Screen

The Segments Info screen in the Admin UI lets you see a visualization of the various segments in the underlying Lucene index for this core, with information about the size of each segment – both bytes and in number of documents – as well as other basic metadata about those segments.
Most visible is the the number of deleted documents, but you can hover your mouse over the segments to see additional numeric details.
Most visible is the number of deleted documents, but you can hover your mouse over the segments to see additional numeric details.

image::images/segments-info/segments_info.png[image,width=486,height=250]

Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/logs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ In the example below the `random` function is run with one parameter which is th

image::images/math-expressions/logs-sample.png[]

The sample contains 500 random records with the their full field list.
The sample contains 500 random records with their full field list.
By looking at this sample we can quickly learn about the *fields* available in the `logs` collection.

=== Time Period
Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/major-changes-in-solr-6.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Please review the <<schema-factory.adoc#,Schema Factory Definition in SolrConfig

Solr's default behavior when a Schema does not explicitly define a global <<schema-elements.adoc#similarity,`<similarity/>`>> is now dependent on the `luceneMatchVersion` specified in the `solrconfig.xml`. When `luceneMatchVersion < 6.0`, an instance of `ClassicSimilarityFactory` will be used, otherwise an instance of `SchemaSimilarityFactory` will be used. Most notably this change means that users can take advantage of per Field Type similarity declarations, without needing to also explicitly declare a global usage of `SchemaSimilarityFactory`.

Regardless of whether it is explicitly declared, or used as an implicit global default, `SchemaSimilarityFactory` 's implicit behavior when a Field Types do not declare an explicit `<similarity />` has also been changed to depend on the the `luceneMatchVersion`. When `luceneMatchVersion < 6.0`, an instance of `ClassicSimilarity` will be used, otherwise an instance of `BM25Similarity` will be used. A `defaultSimFromFieldType` init option may be specified on the `SchemaSimilarityFactory` declaration to change this behavior. Please review the `SchemaSimilarityFactory` javadocs for more details.
Regardless of whether it is explicitly declared, or used as an implicit global default, `SchemaSimilarityFactory` 's implicit behavior when a Field Types do not declare an explicit `<similarity />` has also been changed to depend on the `luceneMatchVersion`. When `luceneMatchVersion < 6.0`, an instance of `ClassicSimilarity` will be used, otherwise an instance of `BM25Similarity` will be used. A `defaultSimFromFieldType` init option may be specified on the `SchemaSimilarityFactory` declaration to change this behavior. Please review the `SchemaSimilarityFactory` javadocs for more details.

== Replica & Shard Delete Command Changes

Expand Down
2 changes: 1 addition & 1 deletion solr/solr-ref-guide/src/query-elevation-component.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ For example, in the request below documents 3007WFP and 9885A004 will be elevate
[source,text]
http://localhost:8983/solr/techproducts/elevate?q=cable&df=text&excludeIds=IW-02&elevateIds=3007WFP,9885A004

If either one of these parameters is specified at request time, the the entire elevation configuration for the query is ignored.
If either one of these parameters is specified at request time, the entire elevation configuration for the query is ignored.

For example, in the request below documents IW-02 and F8V7067-APL-KIT will be elevated, and no documents will be excluded – regardless of what elevations or exclusions are configured for the query "ipod" in elevate.xml:

Expand Down
Loading

0 comments on commit de96857

Please sign in to comment.