From e85b02797f37cce1eb5300822549d847df254e1f Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 11 Feb 2025 17:16:09 +0100 Subject: [PATCH 1/4] =?UTF-8?q?elastic=5Fsearch=20=E2=86=92=20elasticsearc?= =?UTF-8?q?h?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Elasticsearch brand is in one word. https://www.elastic.co/elasticsearch --- .../configure_elasticsearch.md} | 0 .../elasticsearch_overview.md} | 0 .../install_elasticsearch.md} | 0 plugins.yml | 7 +++++-- 4 files changed, 5 insertions(+), 2 deletions(-) rename docs/search/search_engines/{elastic_search/configure_elastic_search.md => elasticsearch/configure_elasticsearch.md} (100%) rename docs/search/search_engines/{elastic_search/elastic_search_overview.md => elasticsearch/elasticsearch_overview.md} (100%) rename docs/search/search_engines/{elastic_search/install_elastic_search.md => elasticsearch/install_elasticsearch.md} (100%) diff --git a/docs/search/search_engines/elastic_search/configure_elastic_search.md b/docs/search/search_engines/elasticsearch/configure_elasticsearch.md similarity index 100% rename from docs/search/search_engines/elastic_search/configure_elastic_search.md rename to docs/search/search_engines/elasticsearch/configure_elasticsearch.md diff --git a/docs/search/search_engines/elastic_search/elastic_search_overview.md b/docs/search/search_engines/elasticsearch/elasticsearch_overview.md similarity index 100% rename from docs/search/search_engines/elastic_search/elastic_search_overview.md rename to docs/search/search_engines/elasticsearch/elasticsearch_overview.md diff --git a/docs/search/search_engines/elastic_search/install_elastic_search.md b/docs/search/search_engines/elasticsearch/install_elasticsearch.md similarity index 100% rename from docs/search/search_engines/elastic_search/install_elastic_search.md rename to docs/search/search_engines/elasticsearch/install_elasticsearch.md diff --git a/plugins.yml b/plugins.yml index 731100cbdc..7efb629e55 100644 --- a/plugins.yml +++ b/plugins.yml @@ -23,7 +23,7 @@ plugins: 'commerce/basket.md': 'commerce/commerce.md' 'templating/layout/customize_basket.md': 'commerce/commerce.md' 'guide/search/extend_solr.md': 'search/search_engines/solr_search_engine/solr_overview.md' - 'guide/search/extend_elasticsearch.md': 'search/search_engines/elastic_search/elastic_search_overview.md' + 'guide/search/extend_elasticsearch.md': 'search/search_engines/elasticsearch/elasticsearch_overview.md' 'api/public_php_api.md': 'api/php_api/php_api.md' 'api/rest_api_usage.md': 'api/rest_api/rest_api_usage/rest_api_usage.md' @@ -300,7 +300,7 @@ plugins: 'guide/personalization/best_practices/recommendation_integration.md': 'personalization/recommendation_integration.md' 'guide/search/search.md': 'search/search.md' - 'guide/search/elastic.md': 'search/search_engines/elastic_search/elastic_search_overview.md' + 'guide/search/elastic.md': 'search/search_engines/elasticsearch/elasticsearch_overview.md' 'guide/search/solr.md': 'search/search_engines/solr_search_engine/solr_overview.md' 'api/public_php_api_search.md': 'search/search_api.md' 'guide/search/criteria_reference/search_criteria_reference.md': 'search/criteria_reference/search_criteria_reference.md' @@ -444,6 +444,9 @@ plugins: 'search/shop_search/search_indexing.md': 'search/search.md' 'search/shop_search/search_synonyms.md': 'search/search.md' 'search/shop_search/search_autosuggest.md': 'search/search.md' + 'search/search_engines/elastic_search/install_elastic_search.md': 'search/search_engines/elasticsearch/install_elasticsearch.md' + 'search/search_engines/elastic_search/configure_elastic_search.md': 'search/search_engines/elasticsearch/configure_elasticsearch.md' + 'docs/search/search_engines/elastic_search/elastic_search_overview.md': 'docs/search/search_engines/elasticsearch/elasticsearch_overview.md' 'api/public_php_api_managing_repository.md': 'content_management/content_management_api/bookmark_api.md' 'guide/request_lifecycle.md': 'infrastructure_and_maintenance/request_lifecycle.md' From fe2b8e48072978fd18de152196f39c84a228d173 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 11 Feb 2025 17:25:26 +0100 Subject: [PATCH 2/4] =?UTF-8?q?elastic=5Fsearch=20=E2=86=92=20elasticsearc?= =?UTF-8?q?h?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Elasticsearch brand is in one word. https://www.elastic.co/elasticsearch --- docs/getting_started/install_ibexa_dxp.md | 10 +++++----- .../clustering/clustering.md | 2 +- docs/resources/new_in_doc.md | 6 +++--- .../extensibility/index_custom_elasticsearch_data.md | 2 +- docs/search/search.md | 2 +- .../elasticsearch/install_elasticsearch.md | 6 +++--- .../legacy_search_engine/legacy_search_overview.md | 2 +- docs/search/search_engines/search_engines.md | 4 ++-- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/getting_started/install_ibexa_dxp.md b/docs/getting_started/install_ibexa_dxp.md index a19a6c0120..efc68adbe4 100644 --- a/docs/getting_started/install_ibexa_dxp.md +++ b/docs/getting_started/install_ibexa_dxp.md @@ -250,11 +250,11 @@ You may choose to replace the [default search engine](legacy_search_overview.md) Do the following steps to enable Elasticsearch: - 1. [Download and install Elasticsearch](install_elastic_search.md) - 2. [Verify that the Elasticsearch instance is up](install_elastic_search.md#verify-the-instance) - 3. [Set the default search engine](install_elastic_search.md#set-the-default-search-engine) - 4. [Configure the search engine](configure_elastic_search.md) - 5. [Push the templates](install_elastic_search.md#push-the-templates) + 1. [Download and install Elasticsearch](install_elasticsearch.md) + 2. [Verify that the Elasticsearch instance is up](install_elasticsearch.md#verify-the-instance) + 3. [Set the default search engine](install_elasticsearch.md#set-the-default-search-engine) + 4. [Configure the search engine](configure_elasticsearch.md) + 5. [Push the templates](install_elasticsearch.md#push-the-templates) Configure the following parameter in the `.env` file: diff --git a/docs/infrastructure_and_maintenance/clustering/clustering.md b/docs/infrastructure_and_maintenance/clustering/clustering.md index cd5f799d81..f7345353b5 100644 --- a/docs/infrastructure_and_maintenance/clustering/clustering.md +++ b/docs/infrastructure_and_maintenance/clustering/clustering.md @@ -26,7 +26,7 @@ For more information on requirements, see [Requirements page](requirements.md). It's also recommended to use: -- [Solr](solr_overview.md) or [Elasticsearch](elastic_search_overview.md) for better search and performance +- [Solr](solr_overview.md) or [Elasticsearch](elasticsearch_overview.md) for better search and performance - a CDN for improved performance and faster ping time worldwide - you can use Fastly, which has native support as HTTP cache and CDN. - active/passive database for failover diff --git a/docs/resources/new_in_doc.md b/docs/resources/new_in_doc.md index fe505fd52d..f9367bfe1c 100644 --- a/docs/resources/new_in_doc.md +++ b/docs/resources/new_in_doc.md @@ -183,7 +183,7 @@ This page contains recent highlights and notable changes in [[= product_name =]] ### Search -- [Configuring Elasticsearch with analyzers for different languages](https://doc.ibexa.co/en/master/search/search_engines/elastic_search/configure_elastic_search/#add-language-specific-analysers) +- [Configuring Elasticsearch with analyzers for different languages](https://doc.ibexa.co/en/master/search/search_engines/elasticsearch/configure_elasticsearch/#add-language-specific-analysers) - [ContentName search criterion](https://doc.ibexa.co/en/master/search/criteria_reference/contentname_criterion/) ### Dashboard @@ -251,7 +251,7 @@ This page contains recent highlights and notable changes in [[= product_name =]] ### Search -- Updated [Elasticsearch search engine](https://doc.ibexa.co/en/master/search/search_engines/elastic_search/elastic_search_overview/) description +- Updated [Elasticsearch search engine](https://doc.ibexa.co/en/master/search/search_engines/elasticsearch/elasticsearch_overview/) description - New Search Criteria: - [Image](https://doc.ibexa.co/en/master/search/criteria_reference/image_criterion/) - [ImageDimensions](https://doc.ibexa.co/en/master/search/criteria_reference/imagedimensions_criterion/) @@ -572,7 +572,7 @@ This page contains recent highlights and notable changes in [[= product_name =]] ### Search - [Updated search engines documentation](https://doc.ibexa.co/en/master/search/search_engines/search_engines/): - - [Elasticsearch search engine](https://doc.ibexa.co/en/master/search/search_engines/elastic_search/elastic_search_overview/) + - [Elasticsearch search engine](https://doc.ibexa.co/en/master/search/search_engines/elasticsearch/elasticsearch_overview/) - [Solr search engine](https://doc.ibexa.co/en/master/search/search_engines/solr_search_engine/solr_overview/) - [Legacy search engine](https://doc.ibexa.co/en/master/search/search_engines/legacy_search_engine/legacy_search_overview/#legacy-search-engine) diff --git a/docs/search/extensibility/index_custom_elasticsearch_data.md b/docs/search/extensibility/index_custom_elasticsearch_data.md index 75a79ac137..d000fcf3a7 100644 --- a/docs/search/extensibility/index_custom_elasticsearch_data.md +++ b/docs/search/extensibility/index_custom_elasticsearch_data.md @@ -4,7 +4,7 @@ description: Index custom data when using the Elasticsearch search engine. # Index custom Elasticsearch data -[Elasticsearch](elastic_search_overview.md) indexes content and location data out of the box. +[Elasticsearch](elasticsearch_overview.md) indexes content and location data out of the box. Besides what is indexed automatically, you can add additional data to the Elasticsearch index. To do so, subscribe to one of the following events: diff --git a/docs/search/search.md b/docs/search/search.md index 878345ef7a..c1aa69d006 100644 --- a/docs/search/search.md +++ b/docs/search/search.md @@ -10,7 +10,7 @@ These are supported across different search engines, allowing you to plug in ano [[= cards([ "search/search_engines/search_engines", - "search/search_engines/elastic_search/elastic_search_overview", + "search/search_engines/elasticsearch/elasticsearch_overview", "search/search_engines/solr_search_engine/solr_overview", "search/search_api", "search/search_criteria_and_sort_clauses", diff --git a/docs/search/search_engines/elasticsearch/install_elasticsearch.md b/docs/search/search_engines/elasticsearch/install_elasticsearch.md index c43f71fa7e..c49db96a59 100644 --- a/docs/search/search_engines/elasticsearch/install_elasticsearch.md +++ b/docs/search/search_engines/elasticsearch/install_elasticsearch.md @@ -64,11 +64,11 @@ All configuration is made in the `/config/packages/ibexa_elasticsearch.yaml` fil First, decide how [[= product_name =]] connects to Elasticsearch and configure other connection settings. -For more information, see [Configuring connections](configure_elastic_search.md#configure-connections). +For more information, see [Configuring connections](configure_elasticsearch.md#configure-connections). Then, define a field type mappings template that instructs Elasticsearch to interpret [[= product_name =]] fields as specific types. -For more information, see [Configuring field type mappings](configure_elastic_search.md#define-field-type-mapping-templates). +For more information, see [Configuring field type mappings](configure_elasticsearch.md#define-field-type-mapping-templates). ## Push the templates @@ -91,4 +91,4 @@ php bin/console ibexa:reindex !!! caution "Risks of premature indexing" Don't reindex your data before you create index templates. - Otherwise Elasticsearch attempts to use its [dynamic field mapping](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/dynamic-field-mapping.html) feature to create type mappings automatically. \ No newline at end of file + Otherwise Elasticsearch attempts to use its [dynamic field mapping](https://www.elastic.co/guide/en/elasticsearch/reference/7.7/dynamic-field-mapping.html) feature to create type mappings automatically. diff --git a/docs/search/search_engines/legacy_search_engine/legacy_search_overview.md b/docs/search/search_engines/legacy_search_engine/legacy_search_overview.md index a74ac1de14..f626e9eef2 100644 --- a/docs/search/search_engines/legacy_search_engine/legacy_search_overview.md +++ b/docs/search/search_engines/legacy_search_engine/legacy_search_overview.md @@ -15,6 +15,6 @@ For more information, check [search engine comparison](search_engines.md#search- !!! tip The features and performance of Legacy search engine are limited. - If you have specific search or performance needs, it's recommended to use [Solr](solr_overview.md) or [Elasticsearch](elastic_search_overview.md) instead. + If you have specific search or performance needs, it's recommended to use [Solr](solr_overview.md) or [Elasticsearch](elasticsearch_overview.md) instead. Using the Legacy search engine disables most shop features, such as product search. diff --git a/docs/search/search_engines/search_engines.md b/docs/search/search_engines/search_engines.md index fe65995ec9..c0274b5bc9 100644 --- a/docs/search/search_engines/search_engines.md +++ b/docs/search/search_engines/search_engines.md @@ -9,7 +9,7 @@ Currently, they exist in their own [[= product_name =]] Bundles: 1. [Legacy search engine](legacy_search_overview.md) - a database-powered search engine for basic needs. 1. [Solr](solr_overview.md) - an integration providing better overall performance, better scalability and support for more advanced search capabilities. -1. [Elasticsearch](elastic_search_overview.md) - a document-oriented engine providing even better performance and scalability. +1. [Elasticsearch](elasticsearch_overview.md) - a document-oriented engine providing even better performance and scalability. ## Search engines comparison @@ -25,4 +25,4 @@ Currently, they exist in their own [[= product_name =]] Bundles: \*\* For more information about fulltext search syntax support, see [Fulltext Criterion](fulltext_criterion.md). -\*\*\* Elasticsearch offers query-time boosting instead. \ No newline at end of file +\*\*\* Elasticsearch offers query-time boosting instead. From f08207d9d69340b57f8afe86d62707808dc5d883 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 11 Feb 2025 17:38:22 +0100 Subject: [PATCH 3/4] Update plugins.yml --- plugins.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins.yml b/plugins.yml index 7efb629e55..80e8b7c507 100644 --- a/plugins.yml +++ b/plugins.yml @@ -446,7 +446,7 @@ plugins: 'search/shop_search/search_autosuggest.md': 'search/search.md' 'search/search_engines/elastic_search/install_elastic_search.md': 'search/search_engines/elasticsearch/install_elasticsearch.md' 'search/search_engines/elastic_search/configure_elastic_search.md': 'search/search_engines/elasticsearch/configure_elasticsearch.md' - 'docs/search/search_engines/elastic_search/elastic_search_overview.md': 'docs/search/search_engines/elasticsearch/elasticsearch_overview.md' + 'search/search_engines/elastic_search/elastic_search_overview.md': 'search/search_engines/elasticsearch/elasticsearch_overview.md' 'api/public_php_api_managing_repository.md': 'content_management/content_management_api/bookmark_api.md' 'guide/request_lifecycle.md': 'infrastructure_and_maintenance/request_lifecycle.md' From e401486f35889624aa919481424a2d4514b83fcc Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 11 Feb 2025 17:48:40 +0100 Subject: [PATCH 4/4] =?UTF-8?q?mkdocs.yml:=20elastic=5Fsearch=20=E2=86=92?= =?UTF-8?q?=20elasticsearch?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Elasticsearch brand is in one word. https://www.elastic.co/elasticsearch --- mkdocs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index e4a629fc0e..32343fa938 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -473,9 +473,9 @@ nav: - Search engines: - Search engines: search/search_engines/search_engines.md - Elasticsearch search engine: - - Overview: search/search_engines/elastic_search/elastic_search_overview.md - - Install Elasticsearch: search/search_engines/elastic_search/install_elastic_search.md - - Configure Elasticsearch: search/search_engines/elastic_search/configure_elastic_search.md + - Overview: search/search_engines/elasticsearch/elasticsearch_overview.md + - Install Elasticsearch: search/search_engines/elasticsearch/install_elasticsearch.md + - Configure Elasticsearch: search/search_engines/elasticsearch/configure_elasticsearch.md - Solr search engine: - Overview: search/search_engines/solr_search_engine/solr_overview.md - Install Solr: search/search_engines/solr_search_engine/install_solr.md