Skip to content

[DOCS] Reorganize, rewrite and add examples to analysis topics #44726

@kat257

Description

@kat257

As part of the larger effort to update and improve Elasticsearch docs, the Analysis section is in need of a revamp. Relevant issues: the topics vary in depth and completeness; some have dated examples or examples that are not consistent; chunking may need to be removed or added; and the organization is arbitrary and does not always show the relationship between one topic and another.

To make these changes, docs covered by this issue will incorporate a revised, standardized structure. For example, in token filters, I'll add examples, configuration parameters, and customization options, and replace circular definitions such as "NGram Token Filter: A token filter of type ngram" with a complete definition and explanation about when the user would expect to employ that filter.

Proposed structure:

  1. Title (Level 2): Definition and explanation of topic
  2. Example (Level 3): Vanilla example and output
  3. Configure parameters (Level 3): Parameters available with descriptions
  4. Customize (Level 3): How to customize
  5. Example (Level 4): Customize example and output

PRs will be revised as I work through the topics. Some PRs may include more than one topic when changes are small and comparable across topics.

Top Level Docs

Sections
Analyzers #58362

Character Filters

Token Filters

Tokenizers #58361

  • chargroup-tokenizer
  • classic-tokenizer
  • edgengram-tokenizer
  • keyword-tokenizer
  • letter-tokenizer
  • lowercase-tokenizer
  • ngram-tokenizer
  • pathhierarchy-tokenizer-examples
  • pathhierarchy-tokenizer
  • pattern-tokenizer
  • simplepattern-tokenizer
  • simplepatternsplit-tokenizer
  • standard-tokenizer
  • thai-tokenizer
  • uaxurlemail-tokenizer
  • whitespace-tokenizer

Metadata

Metadata

Assignees

Labels

:Search Relevance/AnalysisHow text is split into tokens>docsGeneral docs changesMetaTeam:DocsMeta label for docs teamTeam:Search RelevanceMeta label for the Search Relevance team in Elasticsearch

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions