HoustonPutman commented on code in PR #889:
URL: https://github.com/apache/solr/pull/889#discussion_r888085612
##########
solr/solr-ref-guide/modules/configuration-guide/pages/configuring-solr-xml.adoc:
##########
@@ -183,9 +183,9 @@ Note that specifying `sharedLib` will not remove
`$SOLR_HOME/lib` from Solr's cl
|Optional |Default: none
|===
+
-Takes a list of bundled xref:solr-modules.adoc[solr modules] to add to Solr's
class path
+Takes a list of bundled xref:solr-modules.adoc[Solr Modules] to enable
Review Comment:
```suggestion
Takes a list of bundled xref:solr-modules.adoc[] to enable
```
This will take the name of the page as the default link text, which will be
"Solr Modules".
##########
solr/solr-ref-guide/modules/configuration-guide/pages/libs.adoc:
##########
@@ -29,19 +29,18 @@ If there is overlap or inter-dependencies between
libraries, then pay attention
There are several special places you can place Solr plugin `.jar` files:
* `<solr_home>/lib/`: The `.jar` files placed here are available to all Solr
cores running on the node, and to node level plugins referenced in `solr.xml`
-- so basically everything.
-This directory is not present by default so create it.
+This directory is not present by default so you willl need to create it.
Review Comment:
```suggestion
This directory is not present by default so you will need to create it.
```
##########
solr/solr-ref-guide/modules/configuration-guide/pages/script-update-processor.adoc:
##########
@@ -28,10 +28,15 @@ The script can be written in any scripting language
supported by your JVM (such
WARNING: Being able to run a script of your choice as part of the indexing
pipeline is a really powerful tool, that I sometimes call the _Get out of jail
free_ card because you can solve some problems this way that you can't in any
other way.
However, you are introducing some potential security vulnerabilities.
-== Installing the ScriptingUpdateProcessor and Scripting Engines
-This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be added to the classpath before use
-by adding it to the list of modules via `solr.modules=scripting`.
+== Module
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `scripting`.
Review Comment:
```suggestion
This is provided via the `scripting`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/configuration-guide/pages/solr-modules.adoc:
##########
@@ -17,32 +17,34 @@
// specific language governing permissions and limitations
// under the License.
-Solr modules are addon Solr plugins that are not part of solr-core, but
officially maintained
+Solr Modules are addon Solr plugins that are not part of solr-core, but
officially maintained
by the Solr project. They provide well-defined features such as the
"extracting" module which lets
users index rich text documents with Apache Tika. A single module can contain
multiple Plugins.
Modules were earlier known as "contribs".
-Each module produces a separate `.jar` file in the build, and additional
dependencies required by
-each module are also packaged with the module. This helps keep the main core
of Solr small and lean.
+Each module produces a separate `.jar` file in the build, and any additional
dependencies required
+are also packaged with the module and therefore included for you. This helps
keep the main core of Solr
+small and lean.
== Installing a module
The easiest way to enable a module is to list the modules you intend to use
either in the
system property `solr.modules` or in the environment variable `SOLR_MODULES`
(e.g. in `solr.in.sh`
or `solr.in.cmd`). You can also add a `<str name="modules">` tag to
Review Comment:
```suggestion
or `solr.in.cmd`). You can also add a `<str name="modules">` tag to your
```
##########
solr/solr-ref-guide/modules/configuration-guide/pages/solr-modules.adoc:
##########
@@ -17,32 +17,34 @@
// specific language governing permissions and limitations
// under the License.
-Solr modules are addon Solr plugins that are not part of solr-core, but
officially maintained
+Solr Modules are addon Solr plugins that are not part of solr-core, but
officially maintained
by the Solr project. They provide well-defined features such as the
"extracting" module which lets
users index rich text documents with Apache Tika. A single module can contain
multiple Plugins.
Modules were earlier known as "contribs".
-Each module produces a separate `.jar` file in the build, and additional
dependencies required by
-each module are also packaged with the module. This helps keep the main core
of Solr small and lean.
+Each module produces a separate `.jar` file in the build, and any additional
dependencies required
+are also packaged with the module and therefore included for you. This helps
keep the main core of Solr
+small and lean.
Review Comment:
```suggestion
Each module produces a separate `.jar` file in the build, packaged in the
module's `lib/` directory.
All additional dependencies required by the module, and not provided by Solr
core, are also packaged there.
This helps keep the main core of Solr small and lean.
```
##########
solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc:
##########
@@ -404,8 +404,10 @@ An example configuration using this property can be found
below.
=== HdfsBackupRepository
Stores and retrieves backup files from HDFS directories.
-This is provided in the `hdfs` xref:configuration-guide:solr-modules.adoc[Solr
Module].
-This plugin must first be
xref:configuration-guide:solr-plugins.adoc#installing-plugins[installed] before
using.
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `hdfs`.
Review Comment:
```suggestion
This is provided via the `hdfs`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/configuration-guide/pages/solr-modules.adoc:
##########
@@ -17,32 +17,34 @@
// specific language governing permissions and limitations
// under the License.
-Solr modules are addon Solr plugins that are not part of solr-core, but
officially maintained
+Solr Modules are addon Solr plugins that are not part of solr-core, but
officially maintained
by the Solr project. They provide well-defined features such as the
"extracting" module which lets
users index rich text documents with Apache Tika. A single module can contain
multiple Plugins.
Modules were earlier known as "contribs".
-Each module produces a separate `.jar` file in the build, and additional
dependencies required by
-each module are also packaged with the module. This helps keep the main core
of Solr small and lean.
+Each module produces a separate `.jar` file in the build, and any additional
dependencies required
+are also packaged with the module and therefore included for you. This helps
keep the main core of Solr
+small and lean.
== Installing a module
The easiest way to enable a module is to list the modules you intend to use
either in the
system property `solr.modules` or in the environment variable `SOLR_MODULES`
(e.g. in `solr.in.sh`
or `solr.in.cmd`). You can also add a `<str name="modules">` tag to
xref:configuration-guide:configuring-solr-xml.adoc[solr.xml]. The expected
value is a comma separated list
-of module names, e.g. `SOLR_MODULES=extracting,ltr`. This way of adding
modules will add
-them to the shared class loader, making them available for every collection in
Solr.
+of module names, e.g. `SOLR_MODULES=extracting,ltr`. This will add
+them to the shared class loader, making them available to every collection in
Solr.
-You can also specify the modules when using the Solr CLI to start Solr:
+You can also specify the modules to include when using the Solr CLI to start
Solr:
[source,bash]
----
bin/solr start -e techproducts -Dsolr.modules=scripting
----
-If you only wish to enable a module for a single collection, you may add
`<lib>` tags to `solrconfig.xml`
-as explained in xref:configuration-guide:libs.adoc[Lib Directories].
+NOTE: If you only wish to enable a module for a single collection, you may add
`<lib>` tags to `solrconfig.xml`
+as explained in xref:configuration-guide:libs.adoc[Lib Directories]. This
technically isn't considered enabling
+a module, as you are instead just loading all the jars in the module's `lib/`
folder, thus enabling all that module' plugins.
Review Comment:
Not really sure what this sentence means...
##########
solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc:
##########
@@ -664,8 +668,10 @@ An example configuration using the overall and GCS-client
properties can be seen
=== S3BackupRepository
Stores and retrieves backup files in an Amazon S3 bucket.
-This is provided in the `s3-repository`
xref:configuration-guide:solr-modules.adoc[Solr Module].
-This plugin must first be
xref:configuration-guide:solr-plugins.adoc#installing-plugins[installed] before
using.
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `s3-repository`.
Review Comment:
```suggestion
This is provided via the `s3-repository`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc:
##########
@@ -464,8 +466,10 @@ An example configuration using these properties can be
found below:
=== GCSBackupRepository
Stores and retrieves backup files in a Google Cloud Storage ("GCS") bucket.
-This is provided in the `gcs-repository`
xref:configuration-guide:solr-modules.adoc[Solr Module].
-This plugin must first be
xref:configuration-guide:solr-plugins.adoc#installing-plugins[installed] before
using.
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `gcs-repository`.
Review Comment:
```suggestion
This is provided via the `gcs-repository`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/deployment-guide/pages/solr-on-hdfs.adoc:
##########
@@ -33,6 +30,12 @@ These would need to be passed every time you start Solr with
`bin/solr`.
* Define the properties in `solrconfig.xml`.
These configuration changes would need to be repeated for every collection, so
is a good option if you only want some of your collections stored in HDFS.
+== Module
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `hdfs`.
Review Comment:
```suggestion
This is provided via the `hdfs`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/deployment-guide/pages/jwt-authentication-plugin.adoc:
##########
@@ -23,8 +23,9 @@ The typical use case is to integrate Solr with an
https://en.wikipedia.org/wiki/
== Module
-This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be added to the classpath before use. Since this is a node-level
-plugin it must go in `sharedLib`, see
xref:configuration-guide:configuring-solr-xml.adoc[] for details.
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `jwt-auth`.
Review Comment:
```suggestion
This is provided via the `jwt-auth`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-tika.adoc:
##########
@@ -49,8 +49,15 @@ By default it maps to the same name but several parameters
control how this is d
* When Solr Cell finishes creating the internal `SolrInputDocument`, the rest
of the indexing stack takes over.
The next step after any update handler is the
xref:configuration-guide:update-request-processors.adoc[Update Request
Processor] chain.
-Solr Cell is a module, which means it's not automatically included with Solr
but must be configured.
-The example configsets have Solr Cell configured, but if you are not using
those, you will want to pay attention to the section <<solrconfig.xml
Configuration>> below.
+
+== Module
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `extraction`.
Review Comment:
```suggestion
This is provided via the `extraction`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-tika.adoc:
##########
@@ -415,7 +422,7 @@ Also see the section <<Defining XPath Expressions>> for an
example.
If you have started Solr with one of the supplied
xref:configuration-guide:config-sets.adoc[example configsets], you may already
have the `ExtractingRequestHandler` configured by default.
-If it is not already configured, you will need to configure `solrconfig.xml`
to find the `ExtractingRequestHandler` and its dependencies:
+If it is not already configured, you will need to configure `solrconfig.xml`
to find the `ExtractingRequestHandler` and its dependencies, you must enable
the xref:#module[Module]:
Review Comment:
```suggestion
First, you must enable the xref:#module[Module].
If `solrconfig.xml` is not already configured, you will need to modify it to
find the `ExtractingRequestHandler` and its dependencies:
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc:
##########
@@ -692,16 +692,16 @@ On the other hand, it can reduce precision because
language-specific character d
== OpenNLP Integration
-The `lucene/analysis/opennlp` module provides OpenNLP integration via several
analysis components: a tokenizer, a part-of-speech tagging filter, a phrase
chunking filter, and a lemmatization filter.
+The Lucene module `lucene/analysis/opennlp` provides OpenNLP integration via
several analysis components: a tokenizer, a part-of-speech tagging filter, a
phrase chunking filter, and a lemmatization filter.
In addition to these analysis components, Solr also provides an update request
processor to extract named entities.
See also
xref:configuration-guide:update-request-processors.adoc#update-processor-factories-that-can-be-loaded-as-plugins[Update
Processor Factories That Can Be Loaded as Plugins].
NOTE: The <<OpenNLP Tokenizer>> must be used with all other OpenNLP analysis
components, for two reasons.
First, the OpenNLP Tokenizer detects and marks the sentence boundaries
required by all the OpenNLP filters.
Second, since the pre-trained OpenNLP models used by these filters were
trained using the corresponding language-specific
sentence-detection/tokenization models, the same tokenization using the same
models must be used at runtime for optimal performance.
-To use the OpenNLP components, you must add additional .jars to Solr's
classpath (as described in the section
xref:configuration-guide:solr-plugins.adoc#installing-plugins[Installing
Plugins]).
-See `solr/modules/analysis-extras/README.md` for instructions on which jars
you need to add.
+To use the OpenNLP components, you must enable the
xref:#analysis-extras-module[Analysis Extras] module.
Review Comment:
```suggestion
To use the OpenNLP components, you must enable the
xref:#analysis-extras-module[analysis-extras Module].
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc:
##########
@@ -268,8 +268,8 @@ Unicode Collation in Solr is fast, because all the work is
done at index time.
Rather than specifying an analyzer within `<fieldtype ...
class="solr.TextField">`, the `solr.CollationField` and
`solr.ICUCollationField` field type classes provide this functionality.
`solr.ICUCollationField`, which is backed by http://site.icu-project.org[the
ICU4J library], provides more flexible configuration, has more locales, is
significantly faster, and requires less memory and less index space, since its
keys are smaller than those produced by the JDK implementation that backs
`solr.CollationField`.
-To use `solr.ICUCollationField`, you must add additional .jars to Solr's
classpath (as described in the section
xref:configuration-guide:solr-plugins.adoc#installing-plugins[Installing
Plugins]).
-See `solr/modules/analysis-extras/README.md` for instructions on which jars
you need to add.
+To use `solr.ICUCollationField`, you must enable the
xref:#analysis-extras-module[Analysis Extras] module.
Review Comment:
```suggestion
To use `solr.ICUCollationField`, you must enable the
xref:#analysis-extras-module[analysis-extras Module].
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc:
##########
@@ -1441,13 +1440,11 @@ See the example under <<Traditional Chinese>>.
For Simplified Chinese, Solr provides support for Chinese sentence and word
segmentation with the <<HMM Chinese Tokenizer>>.
This component includes a large dictionary and segments Chinese text into
words with the Hidden Markov Model.
-To use this tokenizer, you must add additional .jars to Solr's classpath (as
described in the section
xref:configuration-guide:solr-plugins.adoc#installing-plugins[Installing
Plugins]).
-See the `solr/modules/analysis-extras/README.md` for information on which jars
you need to add.
+To use this tokenizer, you must enable the
xref:#analysis-extras-module[Analysis Extras] module.
Review Comment:
```suggestion
To use this tokenizer, you must enable the
xref:#analysis-extras-module[analysis-extras Module].
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc:
##########
@@ -1327,8 +1327,7 @@ The stemmer language, `Catalan` in this case.
The default configuration of the xref:tokenizers.adoc#icu-tokenizer[ICU
Tokenizer] is suitable for Traditional Chinese text.
It follows the Word Break rules from the Unicode Text Segmentation algorithm
for non-Chinese text, and uses a dictionary to segment Chinese words.
-To use this tokenizer, you must add additional .jars to Solr's classpath (as
described in the section
xref:configuration-guide:solr-plugins.adoc#installing-plugins[Installing
Plugins]).
-See the `solr/modules/analysis-extras/README.md` for information on which jars
you need to add.
+To use this tokenizer, you must enable the
xref:#analysis-extras-module[Analysis Extras] module.
Review Comment:
```suggestion
To use this tokenizer, you must enable the
xref:#analysis-extras-module[analysis-extras Module].
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc:
##########
@@ -1504,8 +1501,7 @@ Also useful for Chinese analysis:
For Simplified Chinese, Solr provides support for Chinese sentence and word
segmentation with the `solr.HMMChineseTokenizerFactory` in the
`analysis-extras` module.
This component includes a large dictionary and segments Chinese text into
words with the Hidden Markov Model.
-To use this tokenizer, you must add additional .jars to Solr's classpath (as
described in the section
<xref:configuration-guide:solr-plugins.adoc#installing-plugins[Installing
Plugins]).
-See `solr/modules/analysis-extras/README.md` for instructions on which jars
you need to add.
+To use this tokenizer, you must enable the
xref:#analysis-extras-module[Analysis Extras] module.
Review Comment:
```suggestion
To use this tokenizer, you must enable the
xref:#analysis-extras-module[analysis-extras Module].
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc:
##########
@@ -1441,13 +1440,11 @@ See the example under <<Traditional Chinese>>.
For Simplified Chinese, Solr provides support for Chinese sentence and word
segmentation with the <<HMM Chinese Tokenizer>>.
This component includes a large dictionary and segments Chinese text into
words with the Hidden Markov Model.
-To use this tokenizer, you must add additional .jars to Solr's classpath (as
described in the section
xref:configuration-guide:solr-plugins.adoc#installing-plugins[Installing
Plugins]).
-See the `solr/modules/analysis-extras/README.md` for information on which jars
you need to add.
+To use this tokenizer, you must enable the
xref:#analysis-extras-module[Analysis Extras] module.
The default configuration of the xref:tokenizers.adoc#icu-tokenizer[ICU
Tokenizer] is also suitable for Simplified Chinese text.
It follows the Word Break rules from the Unicode Text Segmentation algorithm
for non-Chinese text, and uses a dictionary to segment Chinese words.
-To use this tokenizer, you must add additional .jars to Solr's classpath (as
described in the section
xref:configuration-guide:solr-plugins.adoc#installing-plugins[Installing
Plugins]).
-See the `solr/modules/analysis-extras/README.md` for information on which jars
you need to add.
+To use this tokenizer, you must enable the
xref:#analysis-extras-module[Analysis Extras] module.
Review Comment:
```suggestion
To use this tokenizer, you must enable the
xref:#analysis-extras-module[analysis-extras Module].
```
##########
solr/solr-ref-guide/modules/deployment-guide/pages/solr-on-hdfs.adoc:
##########
@@ -17,11 +17,8 @@
// under the License.
-The Solr HDFS module has support for writing and reading its index and
transaction log files to the HDFS distributed filesystem.
-This plugin must first be
xref:configuration-guide:solr-plugins.adoc#installing-plugins[installed] before
using.
-This module needs to be installed as lib, it is planned to evolve to a Solr
package in a later release.
-
-This does not use Hadoop MapReduce to process Solr data, rather it only uses
the HDFS filesystem for index and transaction log file storage.
+The Solr HDFS module has support for writing and reading its index and
transaction log files to the HDFS distributed filesystem. This does
+not use Hadoop MapReduce to process Solr data, rather it only uses the HDFS
filesystem for index and transaction log file storage.
Review Comment:
```suggestion
The Solr HDFS Module has support for writing and reading Solr's index and
transaction log files to the HDFS distributed filesystem.
It does not use Hadoop MapReduce to process Solr data.
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc:
##########
@@ -2551,8 +2547,7 @@ This filter replaces term text with the Reading
Attribute, the Hangul transcript
=== Hebrew, Lao, Myanmar, Khmer
Lucene provides support, in addition to UAX#29 word break rules, for Hebrew's
use of the double and single quote characters, and for segmenting Lao, Myanmar,
and Khmer into syllables with the `solr.ICUTokenizerFactory` in the
`analysis-extras` module.
-To use this tokenizer, you must add additional .jars to Solr's classpath (as
described in the section
xref:configuration-guide:solr-plugins.adoc#installing-plugins[Installing
Plugins]).
-See `solr/modules/analysis-extras/README.md` for instructions on which jars
you need to add.
+To use this tokenizer, you must enable the
xref:#analysis-extras-module[Analysis Extras] module.
Review Comment:
```suggestion
To use this tokenizer, you must enable the
xref:#analysis-extras-module[analysis-extras Module].
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc:
##########
@@ -2826,8 +2821,7 @@ Solr includes support for normalizing Persian, and Lucene
includes an example st
Solr provides support for Polish stemming with the
`solr.StempelPolishStemFilterFactory`, and `solr.MorphologikFilterFactory` for
lemmatization, in the `analysis-extras` module.
The `solr.StempelPolishStemFilterFactory` component includes an algorithmic
stemmer with tables for Polish.
-To use either of these filters, you must add additional .jars to Solr's
classpath (as described in the section
xref:configuration-guide:solr-plugins.adoc#installing-plugins[Installing
Plugins]).
-See `solr/modules/analysis-extras/README.md` for instructions on which jars
you need to add.
+To use this tokenizer, you must enable the
xref:#analysis-extras-module[Analysis Extras] module.
Review Comment:
```suggestion
To use this tokenizer, you must enable the
xref:#analysis-extras-module[analysis-extras Module].
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc:
##########
@@ -3374,8 +3368,7 @@ Solr includes support for stemming Turkish with the
`solr.SnowballPorterFilterFa
=== Ukrainian
Solr provides support for Ukrainian lemmatization with the
`solr.MorphologikFilterFactory`, in the `analysis-extras` module.
-To use this filter, you must add additional .jars to Solr's classpath (as
described in the section
xref:configuration-guide:solr-plugins.adoc#installing-plugins[Installing
Plugins]).
-See `solr/modules/analysis-extras/README.md` for instructions on which jars
you need to add.
+To use this filter, you must enable the xref:#analysis-extras-module[Analysis
Extras] module.
Review Comment:
```suggestion
To use this filter, you must enable the
xref:#analysis-extras-module[analysis-extras Module].
```
##########
solr/solr-ref-guide/modules/query-guide/pages/analytics.adoc:
##########
@@ -23,19 +23,19 @@ The Analytics Component allows users to calculate complex
statistical aggregatio
The component enables interacting with data in a variety of ways, both through
a diverse set of analytics functions as well as powerful faceting functionality.
The standard facets are supported within the analytics component with
additions that leverage its analytical capabilities.
-== Analytics Configuration
+== Module
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
Review Comment:
```suggestion
This is provided via the `analytics`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-detection.adoc:
##########
@@ -31,6 +31,12 @@ For specific information on each of these language
identification implementation
For more information about language analysis in Solr, see
xref:language-analysis.adoc[].
+== Module
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `langid`.
Review Comment:
```suggestion
This is provided via the `langid`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/query-guide/pages/learning-to-rank.adoc:
##########
@@ -113,7 +113,7 @@ In the form of JSON files your trained model or models
(e.g., different models f
== Quick Start with LTR
-The `"techproducts"` example included with Solr is pre-configured with the
plugins required for learning-to-rank, but they are disabled by default.
+The `"techproducts"` example included with Solr is pre-configured to load the
plugins required for learning-to-rank from the `ltr` module, but they are
disabled by default.
Review Comment:
```suggestion
The `"techproducts"` example included with Solr is pre-configured to load
the plugins required for learning-to-rank from the `ltr`
xref:configuration-guide:solr-modules.adoc[Solr Module], but they are disabled
by default.
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/language-analysis.adoc:
##########
@@ -3429,3 +3422,14 @@ The Morfologik `dictionary` parameter value is a
constant specifying which dicti
The dictionary resource must be named `path/to/_language_.dict` and have an
associated `.info` metadata file.
See http://morfologik.blogspot.com/[the Morfologik project] for details.
If the dictionary attribute is not provided, the Polish dictionary is loaded
and used by default.
+
+
+== Analysis Extras Module
+
+Many of the language features listed above are supported by the Analysis
Extras module.
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `analysis-extras`.
+
+Additional details on the specific jar files required is documented in the
`modules/analysis-extras/README.md`.
Review Comment:
```suggestion
Many of the language features listed above are supported by the
`analysis-extras` xref:configuration-guide:solr-modules.adoc[Solr Module] that
needs to be enabled before use.
Additional details on the specific jar files required can be found in the
https://github.com/apache/solr/blob/main/solr/modules/analysis-extras/README.md[Module's
README].
```
##########
solr/solr-ref-guide/modules/query-guide/pages/sql-query.adoc:
##########
@@ -21,11 +21,16 @@
// specific language governing permissions and limitations
// under the License.
-The Solr SQL module brings the power of SQL querying to Solr. The SQL module
needs to be xref:configuration-guide:solr-modules.adoc[installed] to use.
-
-The SQL interface seamlessly combines SQL with Solr's full-text search
capabilities.
+The Solr SQL module brings the power of SQL querying to Solr by seamlessly
combining
Review Comment:
```suggestion
The Solr SQL Module brings the power of SQL querying to Solr by seamlessly
combining
```
##########
solr/solr-ref-guide/modules/query-guide/pages/analytics.adoc:
##########
@@ -23,19 +23,19 @@ The Analytics Component allows users to calculate complex
statistical aggregatio
The component enables interacting with data in a variety of ways, both through
a diverse set of analytics functions as well as powerful faceting functionality.
The standard facets are supported within the analytics component with
additions that leverage its analytical capabilities.
-== Analytics Configuration
+== Module
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
-The Analytics component is in a module, therefore it will need to be enabled
in the `solrconfig.xml` for each collection where you would like to use it.
+The module name is `analytics`.
+
Review Comment:
```suggestion
```
##########
solr/solr-ref-guide/modules/query-guide/pages/result-clustering.adoc:
##########
@@ -36,6 +36,12 @@ The query issued to the system was _Apache Solr_.
It seems clear that faceting could not yield a similar set of groups, although
the goals of both techniques are similar -- to let the user explore the set of
search results and either rephrase the query or narrow the focus to a subset of
current documents.
Clustering is also similar to xref:result-grouping.adoc[] in that it can help
to look deeper into search results, beyond the top few hits.
+== Module
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `clustering`.
Review Comment:
```suggestion
This is provided via the `clustering`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/query-guide/pages/sql-query.adoc:
##########
@@ -21,11 +21,16 @@
// specific language governing permissions and limitations
// under the License.
-The Solr SQL module brings the power of SQL querying to Solr. The SQL module
needs to be xref:configuration-guide:solr-modules.adoc[installed] to use.
-
-The SQL interface seamlessly combines SQL with Solr's full-text search
capabilities.
+The Solr SQL module brings the power of SQL querying to Solr by seamlessly
combining
+SQL with Solr's full-text search capabilities.
Both MapReduce style and JSON Facet API aggregations are supported, which
means that SQL querying can be used to support both *high query volume* and
*high cardinality* use cases.
+== Module
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `sql`.
Review Comment:
```suggestion
This is provided via the `sql`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-update-handlers.adoc:
##########
@@ -275,14 +275,13 @@ The status field will be non-zero in case of failure.
The xref:configuration-guide:script-update-processor.adoc[Scripting module]
provides a separate XSLT Update Request Handler that allows you to index any
arbitrary XML by using the `<tr>` 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
xref:configuration-guide:config-sets.adoc[configset] that can transform the
incoming data to the expected `<add><doc/></add>` format, and use the `tr`
parameter to specify the name of that stylesheet.
-Learn more about adding the `modules/scripting/lib/*` files into Solr's
xref:configuration-guide:libs.adoc#lib-directories[Lib Directories].
+You will need to enable the
xref:configuration-guide:script-update-processor.adoc[Scripting module] before
using this feature.
Review Comment:
```suggestion
You will need to enable the
xref:configuration-guide:script-update-processor.adoc#module[scripting Module]
before using this feature.
```
##########
solr/solr-ref-guide/modules/deployment-guide/pages/distributed-tracing.adoc:
##########
@@ -16,16 +16,22 @@
// specific language governing permissions and limitations
// under the License.
-Solr includes a general tracing framework based on OpenTracing that can be
used to trace lifecycle of a request for performance monitoring.
+Solr includes a general tracing framework based on OpenTracing that can be
used to trace the lifecycle of a request for performance monitoring.
-Tracing data can be configured to send to arbitrary backend like Jaeger,
Zipkin, Datadog, etc.
+Tracing data can be configured to send to arbitrary backends like Jaeger,
Zipkin, Datadog, etc.
At the moment, only Jaeger is supported out of the box.
A sampled distributed tracing query request on Jaeger looks like this:
.Tracing of a Solr query
image::distributed-tracing/query-request-tracing.png[]
+== Module
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `jaegertracer-configurator`.
Review Comment:
```suggestion
This is provided via the `jaegertracer-configurator`
xref:configuration-guide:solr-modules.adoc[Solr Module] that needs to be
enabled before use.
```
##########
solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-tika.adoc:
##########
@@ -49,8 +49,15 @@ By default it maps to the same name but several parameters
control how this is d
* When Solr Cell finishes creating the internal `SolrInputDocument`, the rest
of the indexing stack takes over.
The next step after any update handler is the
xref:configuration-guide:update-request-processors.adoc[Update Request
Processor] chain.
-Solr Cell is a module, which means it's not automatically included with Solr
but must be configured.
-The example configsets have Solr Cell configured, but if you are not using
those, you will want to pay attention to the section <<solrconfig.xml
Configuration>> below.
+
+== Module
+
+This is provided via a xref:configuration-guide:solr-modules.adoc[Solr Module]
that needs to be enabled before use.
+
+The module name is `extraction`.
+
+The "techproducts" example included with Solr is pre-configured to have Solr
Cell configured, but if you are not using it, you will want to pay attention to
the section <<solrconfig.xml Configuration>> below.
Review Comment:
```suggestion
The "techproducts" example included with Solr is pre-configured to have Solr
Cell configured.
If you are not using the example, you will want to pay attention to the
section <<solrconfig.xml Configuration>> below.
```
##########
solr/solr-ref-guide/modules/query-guide/pages/learning-to-rank.adoc:
##########
@@ -113,7 +113,7 @@ In the form of JSON files your trained model or models
(e.g., different models f
== Quick Start with LTR
-The `"techproducts"` example included with Solr is pre-configured with the
plugins required for learning-to-rank, but they are disabled by default.
+The `"techproducts"` example included with Solr is pre-configured to load the
plugins required for learning-to-rank from the `ltr` module, but they are
disabled by default.
To enable the plugins, please specify the `solr.ltr.enabled` JVM System
Property when running the example:
Review Comment:
```suggestion
To enable the plugins, please specify the `solr.ltr.enabled` JVM System
Property when running the `techproducts` example:
```
##########
solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-9.adoc:
##########
@@ -111,8 +111,9 @@ This may require some more disk space for logs than was the
case in version 8.x.
changed package name to `org.apache.solr.security.jwt`, but can still be
loaded as shortform `class="solr.JWTAuthPlugin"`.
* Dependency updates - A lot of dependency updates removes several security
issues from dependencies, and thus make Solr more secure.
* The allow-list defining allowed URLs for the `shards` parameter is not in
the `shardHandler` configuration anymore. It is defined by the `allowUrls`
top-level property of the `solr.xml` file. For more information, see
xref:configuration-guide:configuring-solr-xml.adoc#allow-urls[Format of
solr.allowUrls] documentation.
-* To improve security, `StatelessScriptUpdateProcessorFactory` has been
renamed as `ScriptUpdateProcessorFactory` and moved to `modules/scripting`
package instead of shipping as part of Solr core.
-* To improve security, `XSLTResponseWriter` has been moved to
`modules/scripting` package instead of shipping as part of Solr core.
+* To improve security, `StatelessScriptUpdateProcessorFactory` has been
renamed as `ScriptUpdateProcessorFactory` and moved to `scripting` module
instead of shipping as part of Solr core. Users need to add the module
`scripting` to classpath.
+* To improve security, `XSLTResponseWriter` has been moved to `scripting`
module instead of shipping as part of Solr core. Users need to add the module
`scripting` to classpath.
Review Comment:
```suggestion
* To improve security, `StatelessScriptUpdateProcessorFactory` has been
renamed as `ScriptUpdateProcessorFactory` and moved to the
xref:configuration-guide:script-update-processor.adoc#module[`scripting`
Module] instead of shipping as part of Solr core. This module needs to be
enabled explicitly.
* To improve security, `XSLTResponseWriter` has been moved to the
xref:configuration-guide:script-update-processor.adoc#module[`scripting`
Module] instead of shipping as part of Solr core. This module needs to be
enabled explicitly.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
