Skip to content

Commit 01ff889

Browse files
committed
[DOCS] Rename how-to subsection, move recipes to search relevance (#117044)
1 parent 1e1a67c commit 01ff889

File tree

4 files changed

+20
-19
lines changed

4 files changed

+20
-19
lines changed

docs/reference/how-to.asciidoc

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
[[how-to]]
2-
= How to
2+
= Optimizations
33

4-
[partintro]
5-
--
6-
Elasticsearch ships with defaults which are intended to give a good out of
7-
the box experience. Full text search, highlighting, aggregations, and indexing
8-
should all just work without the user having to change anything.
4+
Elasticsearch's default settings provide a good out-of-box experience for basic operations like full text search, highlighting, aggregations, and indexing.
95

10-
Once you better understand how you want to use Elasticsearch, however,
11-
there are a number of optimizations you can make to improve performance
12-
for your use case.
6+
However, there are a number of optimizations you can make to improve performance for your use case.
137

14-
This section provides guidance about which changes should and shouldn't be
15-
made.
16-
--
8+
This section provides recommendations for various use cases.
179

18-
include::how-to/general.asciidoc[]
10+
* <<general-recommendations>>
11+
* <<tune-for-indexing-speed>>
12+
* <<tune-for-search-speed>>
13+
* <<tune-knn-search>>
14+
* <<tune-for-disk-usage>>
15+
* <<size-your-shards>>
16+
* <<use-elasticsearch-for-time-series-data>>
1917

20-
include::how-to/recipes.asciidoc[]
18+
include::how-to/general.asciidoc[]
2119

2220
include::how-to/indexing-speed.asciidoc[]
2321

docs/reference/how-to/recipes.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[recipes]]
2-
== Recipes
2+
== Search relevance optimizations
33

4-
This section includes a few recipes to help with common problems:
4+
This section includes a few recipes to help with common search relevance issues:
55

66
* <<mixing-exact-search-with-stemming,Mixing exact search with stemming>>
77
* <<consistent-scoring,Getting consistent scores>>

docs/reference/how-to/recipes/scoring.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,9 @@ pages independently of the query.
8888

8989
There are two main queries that allow combining static score contributions with
9090
textual relevance, eg. as computed with BM25:
91-
- <<query-dsl-script-score-query,`script_score` query>>
92-
- <<query-dsl-rank-feature-query,`rank_feature` query>>
91+
92+
* <<query-dsl-script-score-query,`script_score` query>>
93+
* <<query-dsl-rank-feature-query,`rank_feature` query>>
9394

9495
For instance imagine that you have a `pagerank` field that you wish to
9596
combine with the BM25 score so that the final score is equal to

docs/reference/search/search-your-data/search-your-data.asciidoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,12 @@ DSL, with a simplified user experience. Create search applications based on your
4343
results directly in the Kibana Search UI.
4444

4545
include::search-api.asciidoc[]
46+
include::../../how-to/recipes.asciidoc[]
47+
// ☝️ search relevance recipes
4648
include::retrievers-overview.asciidoc[]
4749
include::knn-search.asciidoc[]
4850
include::semantic-search.asciidoc[]
4951
include::search-across-clusters.asciidoc[]
5052
include::search-with-synonyms.asciidoc[]
5153
include::search-application-overview.asciidoc[]
52-
include::behavioral-analytics/behavioral-analytics-overview.asciidoc[]
54+
include::behavioral-analytics/behavioral-analytics-overview.asciidoc[]

0 commit comments

Comments
 (0)