Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 65eaadc

Browse files
authored
Merge pull request #318 from mautz-et-tong/docu/25674
[DOKU] Update documentation regarding Magento2 issue #25674
2 parents 52d0c1a + 45c7eb6 commit 65eaadc

File tree

4 files changed

+38
-38
lines changed

4 files changed

+38
-38
lines changed

src/catalog/search-elasticsearch.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,77 +7,77 @@ Elasticsearch is a powerful and highly scalable distributed search engine that i
77

88
## Step 1: Configure Search Options
99

10-
1. On the Admin sidebar, tap **Stores**. Then under **Settings**, choose **Configuration**.
10+
1. On the Admin sidebar, go to **Stores** > _Settings_ > **Configuration**.
1111

1212
1. In the panel on the left under **Catalog**, choose **Catalog**.
1313

1414
1. Expand ![]({% link images/images/btn-expand.png %}) the **Catalog Search** section.
1515

16-
1. For the **Search Engine** field, clear the **Use system value** checkbox and choose the version that is installed on your server.
16+
1. For **Search Engine**, clear the **Use system value** checkbox and choose the version that is installed on your server.
1717

18-
* Elasticsearch (Deprecated) &mdash; Elasticsearch 2.0+ has reached end of life, and is now deprecated. To learn more, see <a href="https://www.elastic.co/support/eol" target="_blank">Elastic Product End of Life Dates.
18+
- Elasticsearch (Deprecated) - Elasticsearch 2.x has reached end of life, and is now deprecated. To learn more, see [Elastic Product End of Life Dates](https://www.elastic.co/support/eol){:target="_blank"}.
1919

20-
* Elasticsearch 5.0+ (Default) &mdash; Elasticsearch 5.0+ is scheduled for end of life. To learn more, see <a href="https://www.elastic.co/support/eol" target="_blank">Elastic Product End of Life Dates.
20+
- Elasticsearch 5.x (Default) - Elasticsearch 5.x is scheduled for end of life. To learn more, see [Elastic Product End of Life Dates](https://www.elastic.co/support/eol){:target="_blank"}.
2121

22-
* Elasticsearch 6.0+ (Recommended) &mdash;For the best performance, we recommend that you use the latest version of Elasticsearch 6.0+.
22+
- Elasticsearch 6.x (Recommended) - For the best performance, we recommend that you use the latest version of Elasticsearch 6.x.
2323

2424
{:.bs-callout-info}
2525
To learn more about using Elasticsearch versions 2.x and 5.x, see [Change the Elasticsearch Client][2]{:target="_blank"}.
2626

2727
![]({% link images/images/config-catalog-catalog-search-elasticsearch-1.png %}){: .zoom}
28-
*[Elasticsearch Settings]({% link configuration/catalog/catalog.md %})*
28+
_[Elasticsearch Settings]({% link configuration/catalog/catalog.md %})_
2929

30-
1. For **Enable EAV Indexer**, set if you want to enable or disable the Product EAV indexer. This feature improves indexation speed and restricts the indexer from use by 3rd party extensions. This option only displays for Elasticsearch or Elasticsearch 5.0+ Search Engines.
30+
1. For **Enable EAV Indexer**, set if you want to enable or disable the Product EAV indexer. This feature improves indexation speed and restricts the indexer from use by 3rd-party extensions. This option only displays for Elasticsearch or Elasticsearch 5.x Search Engines.
3131

32-
1. To limit the length and word count of search query text, set the **Minimal Query Length** and **Maximum Query Length**.
32+
1. To limit the length and word count of search query text, seta value for **Minimal Query Length** and **Maximum Query Length**.
3333

3434
{:.bs-callout-info}
35-
**Important:** The value set for this minimum and maximum range must be compatible with the corresponding range set in your Elasticsearch search engine configurations. For example, if you set these values to 2 and 300 in Magento, update the values in your search engine.
35+
**Important:** The value set for this minimum and maximum range must be compatible with the corresponding range set in your Elasticsearch search engine configurations. For example, if you set these values to `2` and `300` in Magento, update the values in your search engine.
3636

3737
1. To limit the amount of popular search results to cache for faster responses, set an amount for **Number of top search results to cache**.
3838

39-
The default is 100. Entering a value of 0 caches all search terms and results when entered a second time.
39+
The default is `100`. Entering a value of `0` caches all search terms and results when entered a second time.
4040

41-
1. To limit the maximum number of search results to display for search autocomplete, set an amount for **Autocomplete Limit**. Restricting this amount increases performance of searches and reduces the displayed list size. The default amount is 8.
41+
1. To limit the maximum number of search results to display for search autocomplete, set an amount for **Autocomplete Limit**. Restricting this amount increases performance of searches and reduces the displayed list size. The default amount is `8`.
4242

4343
## Step 2: Configure the Elasticsearch Connection
4444

4545
![]({% link images/images/config-catalog-catalog-search-elasticsearch-2.png %}){: .zoom}
46-
*Elasticsearch Connection Settings*
46+
_Elasticsearch Connection Settings_
4747

48-
1. Enter the **Elasticsearch Server Hostname**. The default is: `localhost`.
48+
1. Enter the **Elasticsearch Server Hostname**. The default is `localhost`.
4949

5050
1. Enter the **Elasticsearch Server Port**.
5151

52-
1. In the **Elasticsearch Index Prefix** field, enter a prefix.to identify the Elasticsearch index. For example: Magento2.
52+
1. For **Elasticsearch Index Prefix**, enter a prefix to identify the Elasticsearch index. Example: `Magento2`.
5353

54-
1. Set **Enable Elasticsearch HTTP Auth** to Yes to use HTTP authentication to prompt for a username and password to access Elasticsearch Server.
54+
1. Set **Enable Elasticsearch HTTP Auth** to `Yes` to use HTTP authentication to prompt for a username and password to access Elasticsearch Server.
5555

56-
1. In the **Elasticsearch Server Timeout** field, enter the number of seconds before the system times out. The default is: 15.
56+
1. For **Elasticsearch Server Timeout**, enter the number of seconds before the system times out. The default is `15`.
5757

58-
1. To verify the configuration, tap <span class="btn">Test Connection</span>.
58+
1. To verify the configuration, click <span class="btn">Test Connection</span>.
5959

6060
## Step 3: Configure Suggestions and Recommendations
6161

6262
{:.bs-callout-info}
6363
Search suggestions and recommendations can impact server performance.
6464

65-
1. Set **Enable Search Suggestions** to Yes”. Then, do the following:
65+
1. Set **Enable Search Suggestions** to `Yes` and do the following:
6666

6767
![]({% link images/images/config-catalog-catalog-search-elasticsearch-3.png %}){: .zoom}
68-
*Elasticsearch Suggestion and Recommendation Settings*
68+
_Elasticsearch Suggestion and Recommendation Settings_
6969

70-
* In the **Search Suggestions Count** field, enter the number of search suggestions to offer.
70+
- For **Search Suggestions Count**, enter the number of search suggestions to offer.
7171

72-
* To show the number of results found for each suggestion, set **Show Results for Each Suggestion** to Yes.
72+
- To show the number of results found for each suggestion, set **Show Results for Each Suggestion** to `Yes`.
7373

74-
1. To offer recommendations, set **Enable Search Recommendations** to Yes”. Then, do the following:
74+
1. To offer recommendations, set **Enable Search Recommendations** to `Yes` and do the following:
7575

76-
* In the **Search Recommendation Count** field, enter the number of recommendations to offer.
76+
- For **Search Recommendation Count**, enter the number of recommendations to offer.
7777

78-
* To show the number of results found for each recommendation, set **Show Results Count for Each Recommendation** to Yes.
78+
- To show the number of results found for each recommendation, set **Show Results Count for Each Recommendation** to `Yes`.
7979

80-
1. When complete, tap <span class="btn">Save Config</span>.
80+
1. When complete, click <span class="btn">Save Config</span>.
8181

8282
[1]: http://devdocs.magento.com/guides/v2.3/config-guide/elasticsearch/es-overview.html
8383
[2]: https://devdocs.magento.com/guides/v2.3/config-guide/elasticsearch/es-downgrade.html

0 commit comments

Comments
 (0)