From 4147b01db0e95e49e7238c2ed61b93649b291ab9 Mon Sep 17 00:00:00 2001 From: Raul E Watson Date: Sun, 18 Aug 2019 23:50:24 +0100 Subject: [PATCH 1/2] Update AdvancedSearch ReadMe --- app/code/Magento/AdvancedSearch/README.md | 40 ++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/app/code/Magento/AdvancedSearch/README.md b/app/code/Magento/AdvancedSearch/README.md index 763d1917a8546..16914d3f6eade 100644 --- a/app/code/Magento/AdvancedSearch/README.md +++ b/app/code/Magento/AdvancedSearch/README.md @@ -1 +1,39 @@ -AdvancedSearch module introduces advanced search functionality and provides interfaces that allow to implement this functionality by 3rd party search engines +# Magento_AdvancedSearch module +Magento_AdvancedSearch module introduces advanced search functionality and provides interfaces that allow to implement +this functionality by 3rd party search engines. + +## Installation details + +Before disabling or uninstalling this module, note that the following modules depends on this module: +- Magento_Elasticsearch +- Magento_Elasticsearch6 + +For information about module installation in Magento 2, see [Enable or disable modules](https://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-subcommands-enable.html). + +## Extensibility + +Extension developers can interact with the Magento_AdvancedSearch module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/plugins.html). + +[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/depend-inj.html) enables you to override the functionality of the Magento_AdvancedSearch module. + +### Events + +This module observes the following event: + + - `catalogsearch_query_save_after` in the `Magento\AdvancedSearch\Model\Recommendations\SaveSearchQueryRelationsObserver` file. + +For information about an event in Magento 2, see [Events and observers](http://devdocs.magento.com/guides/v2.3/extension-dev-guide/events-and-observers.html#events). + +### Layouts + +The module interact with the following layout handles in the `view/adminhtml/layout` directory: + +- `catalog_search_block` +- `catalog_search_edit` +- `catalog_search_relatedgrid` + +The module interact with the following layout handles in the `view/frontend/layout` directory: + +- `catalogsearch_result_index` + +For more information about layouts in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/layout-overview.html). \ No newline at end of file From b7ed0202a82f595f65341e8ce97e0fb037c163d3 Mon Sep 17 00:00:00 2001 From: Raul E Watson Date: Tue, 20 Aug 2019 00:08:51 +0100 Subject: [PATCH 2/2] Changes requested during PR CR --- app/code/Magento/AdvancedSearch/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/app/code/Magento/AdvancedSearch/README.md b/app/code/Magento/AdvancedSearch/README.md index 16914d3f6eade..999721fca1c8f 100644 --- a/app/code/Magento/AdvancedSearch/README.md +++ b/app/code/Magento/AdvancedSearch/README.md @@ -1,6 +1,5 @@ # Magento_AdvancedSearch module -Magento_AdvancedSearch module introduces advanced search functionality and provides interfaces that allow to implement -this functionality by 3rd party search engines. +The Magento_AdvancedSearch module introduces advanced search functionality and provides interfaces that allow third-party search engines to implement this functionality. ## Installation details @@ -26,13 +25,13 @@ For information about an event in Magento 2, see [Events and observers](http://d ### Layouts -The module interact with the following layout handles in the `view/adminhtml/layout` directory: +The module interacts with the following layout handles in the `view/adminhtml/layout` directory: - `catalog_search_block` - `catalog_search_edit` - `catalog_search_relatedgrid` -The module interact with the following layout handles in the `view/frontend/layout` directory: +The module interacts with the following layout handles in the `view/frontend/layout` directory: - `catalogsearch_result_index`