Skip to content

Commit 0fa6ac0

Browse files
authored
[DOCS] Add tutorials section to analysis topic (#50809)
Adds a 'Configure text analysis' page to house tutorial content for the analysis topic. Also relocates the following pages as children as this new page: * 'Test an analyzer' * 'Configuring built-in analyzers' * 'Create a custom analyzer' I plan to add a tutorial for specifying index-time and search-time analyzers to this section as part of a future PR.
1 parent 0605eb2 commit 0fa6ac0

File tree

5 files changed

+34
-8
lines changed

5 files changed

+34
-8
lines changed

docs/reference/analysis.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ include::analysis/overview.asciidoc[]
146146

147147
include::analysis/concepts.asciidoc[]
148148

149-
include::analysis/testing.asciidoc[]
149+
include::analysis/configure-text-analysis.asciidoc[]
150150

151151
include::analysis/analyzers.asciidoc[]
152152

docs/reference/analysis/analyzers.asciidoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,6 @@ If you do not find an analyzer suitable for your needs, you can create a
5454
<<analysis-tokenizers,tokenizer>>, and <<analysis-tokenfilters,token filters>>.
5555

5656

57-
include::analyzers/configuring.asciidoc[]
58-
5957
include::analyzers/fingerprint-analyzer.asciidoc[]
6058

6159
include::analyzers/keyword-analyzer.asciidoc[]
@@ -70,6 +68,4 @@ include::analyzers/standard-analyzer.asciidoc[]
7068

7169
include::analyzers/stop-analyzer.asciidoc[]
7270

73-
include::analyzers/whitespace-analyzer.asciidoc[]
74-
75-
include::analyzers/custom-analyzer.asciidoc[]
71+
include::analyzers/whitespace-analyzer.asciidoc[]

docs/reference/analysis/analyzers/custom-analyzer.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[analysis-custom-analyzer]]
2-
=== Custom Analyzer
2+
=== Create a custom analyzer
33

44
When the built-in analyzers do not fulfill your needs, you can create a
55
`custom` analyzer which uses the appropriate combination of:
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[[configure-text-analysis]]
2+
== Configure text analysis
3+
4+
By default, {es} uses the <<analysis-standard-analyzer,`standard` analyzer>> for
5+
all text analysis. The `standard` analyzer gives you out-of-the-box support for
6+
most natural languages and use cases. If you chose to use the `standard`
7+
analyzer as-is, no further configuration is needed.
8+
9+
If the standard analyzer does not fit your needs, review and test {es}'s other
10+
built-in <<analysis-analyzers,built-in analyzers>>. Built-in analyzers don't
11+
require configuration, but some support options that can be used to adjust their
12+
behavior. For example, you can configure the `standard` analyzer with a list of
13+
custom stop words to remove.
14+
15+
If no built-in analyzer fits your needs, you can test and create a custom
16+
analyzer. Custom analyzers involve selecting and combining different
17+
<<analyzer-anatomy,analyzer components>>, giving you greater control over
18+
the process.
19+
20+
* <<test-analyzer>>
21+
* <<configuring-analyzers>>
22+
* <<analysis-custom-analyzer>>
23+
24+
25+
include::testing.asciidoc[]
26+
27+
include::analyzers/configuring.asciidoc[]
28+
29+
include::analyzers/custom-analyzer.asciidoc[]

docs/reference/analysis/testing.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
== Testing analyzers
1+
[[test-analyzer]]
2+
=== Test an analyzer
23

34
The <<indices-analyze,`analyze` API>> is an invaluable tool for viewing the
45
terms produced by an analyzer. A built-in analyzer (or combination of built-in

0 commit comments

Comments
 (0)