Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
82 tasks done
kat257 opened this issue Jul 22, 2019 · 3 comments
Closed
82 tasks done

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

kat257 opened this issue Jul 22, 2019 · 3 comments
Assignees
@jrodewig
Labels
>docs General docs changes Meta :Search Relevance/Analysis How text is split into tokens Team:Docs Meta label for docs team Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch

Comments

@kat257
Copy link
Contributor

kat257 commented Jul 22, 2019 •
edited by jrodewig
Loading

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
@kat257 kat257 added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories Meta 7x labels Jul 22, 2019
@kat257 kat257 self-assigned this Jul 22, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search

@jrodewig jrodewig self-assigned this Aug 23, 2019
@debadair
Copy link
Contributor

[docs issue triage]

@jrodewig jrodewig mentioned this issue Oct 15, 2019
Merged
@jrodewig jrodewig changed the title [DOCS] Reorganize, rewrite and add examples to Analysis Topics [DOCS] Reorganize, rewrite and add examples to analysis topics Oct 15, 2019
@jrodewig jrodewig mentioned this issue Oct 23, 2019
Merged
This was referenced Oct 30, 2019
Merged
Merged
This was referenced Nov 12, 2019
Merged
Merged
Merged
This was referenced Nov 20, 2019
Merged
Merged
Merged
This was referenced Nov 27, 2019
Closed
Closed
Merged
jrodewig added a commit that referenced this issue Dec 4, 2019
@jrodewig
[DOCS] Reformat length token filter docs (#49805)
e964a97 
* Adds a title abbreviation
* Updates the description and adds a Lucene link
* Reformats the parameters section
* Adds analyze, custom analyzer, and custom filter snippets

Relates to #44726.
jrodewig added a commit that referenced this issue Dec 4, 2019
@jrodewig
[DOCS] Reformat length token filter docs (#49805)
87a73b6 
* Adds a title abbreviation
* Updates the description and adds a Lucene link
* Reformats the parameters section
* Adds analyze, custom analyzer, and custom filter snippets

Relates to #44726.
jrodewig added a commit that referenced this issue Dec 4, 2019
@jrodewig
[DOCS] Reformat length token filter docs (#49805)
d755fbd 
* Adds a title abbreviation
* Updates the description and adds a Lucene link
* Reformats the parameters section
* Adds analyze, custom analyzer, and custom filter snippets

Relates to #44726.
This was referenced Dec 4, 2019
Merged
Merged
@polyfractal polyfractal removed the 7x label Dec 12, 2019
SivagurunathanV pushed a commit to SivagurunathanV/elasticsearch that referenced this issue Jan 23, 2020
@jrodewig @SivagurunathanV
[DOCS] Reformat length token filter docs (elastic#49805)
42dc5a7 
* Adds a title abbreviation
* Updates the description and adds a Lucene link
* Reformats the parameters section
* Adds analyze, custom analyzer, and custom filter snippets

Relates to elastic#44726.
@jrodewig jrodewig mentioned this issue Feb 12, 2020
Merged
@rjernst rjernst added Team:Docs Meta label for docs team Team:Search Meta label for search team labels May 4, 2020
@jrodewig jrodewig added :Search Relevance/Analysis How text is split into tokens and removed :Search/Search Search-related issues that do not fall into other categories labels Jun 19, 2020
@javanna javanna added Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch and removed Team:Search Meta label for search team labels Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jrodewig jrodewig

Labels
>docs General docs changes Meta :Search Relevance/Analysis How text is split into tokens Team:Docs Meta label for docs team Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@rjernst @debadair @javanna @polyfractal @elasticmachine @kat257 @jrodewig