Skip to content

Commit

Permalink
[DOCS] Rename how-to subsection, move recipes to search relevance (#1…
Browse files Browse the repository at this point in the history
  • Loading branch information
leemthompo authored Nov 19, 2024
1 parent 1e1a67c commit c24af84
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 19 deletions.
26 changes: 12 additions & 14 deletions docs/reference/how-to.asciidoc
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
[[how-to]]
= How to
= Optimizations

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

Once you better understand how you want to use Elasticsearch, however,
there are a number of optimizations you can make to improve performance
for your use case.
However, there are a number of optimizations you can make to improve performance for your use case.

This section provides guidance about which changes should and shouldn't be
made.
--
This section provides recommendations for various use cases.

include::how-to/general.asciidoc[]
* <<general-recommendations>>
* <<tune-for-indexing-speed>>
* <<tune-for-search-speed>>
* <<tune-knn-search>>
* <<tune-for-disk-usage>>
* <<size-your-shards>>
* <<use-elasticsearch-for-time-series-data>>

include::how-to/recipes.asciidoc[]
include::how-to/general.asciidoc[]

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

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/how-to/recipes.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[recipes]]
== Recipes
== Search relevance optimizations

This section includes a few recipes to help with common problems:
This section includes a few recipes to help with common search relevance issues:

* <<mixing-exact-search-with-stemming,Mixing exact search with stemming>>
* <<consistent-scoring,Getting consistent scores>>
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/how-to/recipes/scoring.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,9 @@ pages independently of the query.

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

* <<query-dsl-script-score-query,`script_score` query>>
* <<query-dsl-rank-feature-query,`rank_feature` query>>

For instance imagine that you have a `pagerank` field that you wish to
combine with the BM25 score so that the final score is equal to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,12 @@ DSL, with a simplified user experience. Create search applications based on your
results directly in the Kibana Search UI.

include::search-api.asciidoc[]
include::../../how-to/recipes.asciidoc[]
// ☝️ search relevance recipes
include::retrievers-overview.asciidoc[]
include::knn-search.asciidoc[]
include::semantic-search.asciidoc[]
include::search-across-clusters.asciidoc[]
include::search-with-synonyms.asciidoc[]
include::search-application-overview.asciidoc[]
include::behavioral-analytics/behavioral-analytics-overview.asciidoc[]
include::behavioral-analytics/behavioral-analytics-overview.asciidoc[]

0 comments on commit c24af84

Please sign in to comment.