You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ct...@apache.org on 2020/10/09 18:08:52 UTC
[lucene-solr] branch branch_8x updated: Ref Guide: clarify
deprecation status for features removed in 9.0; link to related plugins;
make deprecation messages more consistent
This is an automated email from the ASF dual-hosted git repository.
ctargett pushed a commit to branch branch_8x
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git
The following commit(s) were added to refs/heads/branch_8x by this push:
new 1328839 Ref Guide: clarify deprecation status for features removed in 9.0; link to related plugins; make deprecation messages more consistent
1328839 is described below
commit 13288397596e73b481318938e566b605615f3d81
Author: Cassandra Targett <ca...@lucidworks.com>
AuthorDate: Fri Oct 9 13:07:51 2020 -0500
Ref Guide: clarify deprecation status for features removed in 9.0; link to related plugins; make deprecation messages more consistent
---
.../src/adding-custom-plugins-in-solrcloud-mode.adoc | 3 ++-
solr/solr-ref-guide/src/blockjoin-faceting.adoc | 6 +++++-
solr/solr-ref-guide/src/cdcr-api.adoc | 2 +-
solr/solr-ref-guide/src/cdcr-architecture.adoc | 2 +-
solr/solr-ref-guide/src/cdcr-config.adoc | 2 +-
solr/solr-ref-guide/src/cdcr-operations.adoc | 2 +-
solr/solr-ref-guide/src/cross-data-center-replication-cdcr.adoc | 2 +-
solr/solr-ref-guide/src/dataimport-screen.adoc | 2 +-
solr/solr-ref-guide/src/response-writers.adoc | 5 ++++-
solr/solr-ref-guide/src/running-solr-on-hdfs.adoc | 2 +-
...-structured-data-store-data-with-the-data-import-handler.adoc | 9 ++++++++-
solr/solr-ref-guide/src/velocity-response-writer.adoc | 6 ++++--
solr/solr-ref-guide/src/velocity-search-ui.adoc | 7 +++++++
13 files changed, 37 insertions(+), 13 deletions(-)
diff --git a/solr/solr-ref-guide/src/adding-custom-plugins-in-solrcloud-mode.adoc b/solr/solr-ref-guide/src/adding-custom-plugins-in-solrcloud-mode.adoc
index 1d950d2..fb830da 100644
--- a/solr/solr-ref-guide/src/adding-custom-plugins-in-solrcloud-mode.adoc
+++ b/solr/solr-ref-guide/src/adding-custom-plugins-in-solrcloud-mode.adoc
@@ -21,7 +21,8 @@ In SolrCloud mode, custom plugins need to be shared across all nodes of the clus
.Deprecated
[IMPORTANT]
====
-The functionality here is a subset of the <<package-manager.adoc#package-manager,Package Management>> system. It will no longer be supported in Solr 9.
+The functionality here has changed to be a subset of the <<package-manager.adoc#package-manager,Package Management>> system.
+As described in this page, will no longer be supported in Solr 9.
====
When running Solr in SolrCloud mode and you want to use custom code (such as custom analyzers, tokenizers, query parsers, and other plugins), it can be cumbersome to add jars to the classpath on all nodes in your cluster. Using the <<blob-store-api.adoc#blob-store-api,Blob Store API>> and special commands with the <<config-api.adoc#config-api,Config API>>, you can upload jars to a special system-level collection and dynamically load plugins from them at runtime without needing to restart [...]
diff --git a/solr/solr-ref-guide/src/blockjoin-faceting.adoc b/solr/solr-ref-guide/src/blockjoin-faceting.adoc
index e647834..5d44ce8 100644
--- a/solr/solr-ref-guide/src/blockjoin-faceting.adoc
+++ b/solr/solr-ref-guide/src/blockjoin-faceting.adoc
@@ -20,9 +20,13 @@ BlockJoin facets allow you to aggregate children facet counts by their parents.
It is a common requirement that if a parent document has several children documents, all of them need to increment facet value count only once. This functionality is provided by `BlockJoinDocSetFacetComponent`, and `BlockJoinFacetComponent` just an alias for compatibility.
-CAUTION: This functionality is considered deprecated and will be removed at 9.0.
+[WARNING]
+====
+ This functionality is considered deprecated and will be removed at 9.0.
Users are encouraged to use `uniqueBlock(\_root_)` aggregation under a `terms` facet in the <<json-faceting-domain-changes.adoc#block-join-domain-changes,JSON Facet API>>.
+
If this component is used, it must be explicitly enabled for a request handler in `solrconfig.xml`, in the same way as any other <<requesthandlers-and-searchcomponents-in-solrconfig.adoc#requesthandlers-and-searchcomponents-in-solrconfig,search component>>.
+====
This example shows how you could add this search components to `solrconfig.xml` and define it in request handler:
diff --git a/solr/solr-ref-guide/src/cdcr-api.adoc b/solr/solr-ref-guide/src/cdcr-api.adoc
index f5c26dc..bc0700c 100644
--- a/solr/solr-ref-guide/src/cdcr-api.adoc
+++ b/solr/solr-ref-guide/src/cdcr-api.adoc
@@ -21,7 +21,7 @@ The CDCR API is used to control and monitor the replication process. Control act
[WARNING]
.CDCR is deprecated
====
-This feature (in its current form) is deprecated and will likely be removed in 9.0.
+This feature (in its current form) is deprecated and will be removed in 9.0.
See <<cross-data-center-replication-cdcr.adoc#cross-data-center-replication-cdcr,Cross Data Center Replication>> for more details.
====
diff --git a/solr/solr-ref-guide/src/cdcr-architecture.adoc b/solr/solr-ref-guide/src/cdcr-architecture.adoc
index b479f3d..ee6aa1e 100644
--- a/solr/solr-ref-guide/src/cdcr-architecture.adoc
+++ b/solr/solr-ref-guide/src/cdcr-architecture.adoc
@@ -23,7 +23,7 @@ With CDCR, Source and Target data centers can each serve search queries when CDC
[WARNING]
.CDCR is deprecated
====
-This feature (in its current form) is deprecated and will likely be removed in 9.0.
+This feature (in its current form) is deprecated and will be removed in 9.0.
See <<cross-data-center-replication-cdcr.adoc#cross-data-center-replication-cdcr,Cross Data Center Replication>> for more details.
====
diff --git a/solr/solr-ref-guide/src/cdcr-config.adoc b/solr/solr-ref-guide/src/cdcr-config.adoc
index 25add10..5cbb40c 100644
--- a/solr/solr-ref-guide/src/cdcr-config.adoc
+++ b/solr/solr-ref-guide/src/cdcr-config.adoc
@@ -21,7 +21,7 @@ The Source and Target configurations differ in the case of the data centers bein
[WARNING]
.CDCR is deprecated
====
-This feature (in its current form) is deprecated and will likely be removed in 9.0.
+This feature (in its current form) is deprecated and will be removed in 9.0.
See <<cross-data-center-replication-cdcr.adoc#cross-data-center-replication-cdcr,Cross Data Center Replication>> for more details.
====
diff --git a/solr/solr-ref-guide/src/cdcr-operations.adoc b/solr/solr-ref-guide/src/cdcr-operations.adoc
index af4d0d9..c03d640 100644
--- a/solr/solr-ref-guide/src/cdcr-operations.adoc
+++ b/solr/solr-ref-guide/src/cdcr-operations.adoc
@@ -19,7 +19,7 @@
[WARNING]
.CDCR is deprecated
====
-This feature (in its current form) is deprecated and will likely be removed in 9.0.
+This feature (in its current form) is deprecated and will be removed in 9.0.
See <<cross-data-center-replication-cdcr.adoc#cross-data-center-replication-cdcr,Cross Data Center Replication>> for more details.
====
diff --git a/solr/solr-ref-guide/src/cross-data-center-replication-cdcr.adoc b/solr/solr-ref-guide/src/cross-data-center-replication-cdcr.adoc
index f19b2c4..00f6dc9 100644
--- a/solr/solr-ref-guide/src/cross-data-center-replication-cdcr.adoc
+++ b/solr/solr-ref-guide/src/cross-data-center-replication-cdcr.adoc
@@ -22,7 +22,7 @@ Cross Data Center Replication (CDCR) allows you to create multiple SolrCloud dat
[WARNING]
.CDCR is deprecated
====
-This feature (in its current form) is deprecated and will likely be removed in 9.0.
+This feature (in its current form) is deprecated and will be removed in 9.0.
Anyone currently using CDCR should consider migrating away from it.
There are several open issues which make CDCR complex to maintain and generally unstable.
diff --git a/solr/solr-ref-guide/src/dataimport-screen.adoc b/solr/solr-ref-guide/src/dataimport-screen.adoc
index 1f28cd5..14904e3 100644
--- a/solr/solr-ref-guide/src/dataimport-screen.adoc
+++ b/solr/solr-ref-guide/src/dataimport-screen.adoc
@@ -16,7 +16,7 @@
// specific language governing permissions and limitations
// under the License.
-WARNING: The Data Import Handler is deprecated as of v8.6 and is scheduled to be removed in 9.0.
+WARNING: The Data Import Handler is deprecated as of v8.6 and will be removed in 9.0.
The Dataimport screen shows the configuration of the DataImportHandler (DIH) and allows you start, and monitor the status of, import commands as defined by the options selected on the screen and defined in the configuration file.
diff --git a/solr/solr-ref-guide/src/response-writers.adoc b/solr/solr-ref-guide/src/response-writers.adoc
index a921658..6b1ca83 100644
--- a/solr/solr-ref-guide/src/response-writers.adoc
+++ b/solr/solr-ref-guide/src/response-writers.adoc
@@ -21,7 +21,8 @@ A Response Writer generates the formatted response of a search.
Solr supports a variety of Response Writers to ensure that query responses can be parsed by the appropriate language or application.
-The `wt` parameter selects the Response Writer to be used. The list below describe shows the most common settings for the `wt` parameter, with links to further sections that discuss them in more detail.
+The `wt` parameter selects the Response Writer to be used.
+The list below shows the most common settings for the `wt` parameter, with links to the sections that discuss them in more detail.
* <<CSV Response Writer,csv>>
* <<GeoJSON Response Writer,geojson>>
@@ -301,6 +302,8 @@ MA147LL/A,"electronics,music",Apple 60 GB iPod with Video Playback Black,10,399.
[[velocity-writer]]
== Velocity Response Writer
+_Deprecated_
+
The `VelocityResponseWriter` processes the Solr response and request context through Apache Velocity templating.
See the <<velocity-response-writer.adoc#velocity-response-writer,Velocity Response Writer>> section for details.
diff --git a/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc b/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc
index e74b7a5..fdab964 100644
--- a/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc
+++ b/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc
@@ -16,7 +16,7 @@
// specific language governing permissions and limitations
// under the License.
-WARNING: Storing indexes in HDFS is deprecated and may be be removed in 9.0. This functionality may be moved to a 3rd-party plugin in the future.
+WARNING: Storing indexes in HDFS is deprecated and will be removed in 9.0. This functionality may be replaced by a 3rd-party plugin in the future.
Solr has support for writing and reading its index and transaction log files to the HDFS distributed filesystem.
diff --git a/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc b/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
index 98c315e..24160c7 100644
--- a/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
+++ b/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
@@ -17,7 +17,14 @@
// specific language governing permissions and limitations
// under the License.
-WARNING: The Data Import Handler is deprecated is scheduled to be removed in 9.0. This functionality will likely migrate to a 3rd-party plugin in the near future.
+[WARNING]
+====
+The Data Import Handler is deprecated and will be removed in 9.0.
+
+This functionality is being migrated to a new 3rd party plugin available at https://github.com/rohitbemax/dataimporthandler.
+
+See the section <<package-manager.adoc#package-manager,Package Manager>> for information about Solr's plugin framework.
+====
Many search applications store the content to be indexed in a structured data store, such as a relational database. The Data Import Handler (DIH) provides a mechanism for importing content from a data store and indexing it.
diff --git a/solr/solr-ref-guide/src/velocity-response-writer.adoc b/solr/solr-ref-guide/src/velocity-response-writer.adoc
index c493440..d6ac3d9 100644
--- a/solr/solr-ref-guide/src/velocity-response-writer.adoc
+++ b/solr/solr-ref-guide/src/velocity-response-writer.adoc
@@ -18,9 +18,11 @@
The VelocityResponseWriter is an optional plugin available in the `contrib/velocity` directory. It powers the /browse user interfaces when using some example configurations such as "techproducts" and "example/files".
-[IMPORTANT]
+[WARNING]
====
-The VelocityResponseWriter has been deprecated and may be removed in a future version of Solr.
+The VelocityResponseWriter and associated /browse UI is deprecated and will be removed in 9.0.
+
+The functionality has been replaced by a 3rd party plugin available at https://github.com/erikhatcher/solritas.
====
Its JAR and dependencies must be added (via `<lib>` or solr/home lib inclusion), and must be registered in `solrconfig.xml` like this:
diff --git a/solr/solr-ref-guide/src/velocity-search-ui.adoc b/solr/solr-ref-guide/src/velocity-search-ui.adoc
index 96d7f93..4d58926 100644
--- a/solr/solr-ref-guide/src/velocity-search-ui.adoc
+++ b/solr/solr-ref-guide/src/velocity-search-ui.adoc
@@ -18,6 +18,13 @@
Solr includes a sample search UI based on the <<response-writers.adoc#velocity-writer,VelocityResponseWriter>> (also known as Solritas) that demonstrates several useful features, such as searching, faceting, highlighting, autocomplete, and geospatial searching.
+[WARNING]
+====
+The VelocityResponseWriter and associated /browse UI is deprecated and will be removed in 9.0.
+
+The functionality has been replaced by a 3rd party plugin available at https://github.com/erikhatcher/solritas.
+====
+
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