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.

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

[DOCS] Reformat keyword token filter docs #49662

Closed
wants to merge 20 commits into from
Closed

[DOCS] Reformat keyword token filter docs #49662

wants to merge 20 commits into from

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Nov 27, 2019

Reformats the keyword _marker and keyword_repeat token filter docs. Changes include:

  • Adds title abbreviations
  • Revises description and adds Lucene links
  • Adds explicit analyzer examples
  • Reformats parameter section for keyword_marker
  • Adds sections for adding the filters to analyzers

Preview links

Adds a conceptual overview page, borrowed and modified from the
Definitive Guide, to cover stemming concepts docs in depth. I plan to
extend this page to cover other concepts (stopwords, keywords) as part
of #44726.

Also reformats the `keyword _marker` and `keyword_repeat` token filter
docs. Changes include:
* Adds title abbreviations
* Revises description and adds Lucene links
* Adds explicit analyzer examples
* Reformats parameter section for `keyword_marker`
* Adds sections for adding the filters to analyzers
@jrodewig jrodewig added >docs General docs changes :Search Relevance/Analysis How text is split into tokens v8.0.0 v7.6.0 v7.4.3 v7.5.1 labels Nov 27, 2019
@jrodewig jrodewig requested review from debadair and jimczi November 27, 2019 20:36
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-search (:Search/Analysis)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@jrodewig jrodewig requested a review from romseygeek December 4, 2019 16:03
@jrodewig jrodewig removed the v7.4.3 label Dec 10, 2019
@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments, but didn't review the last bit in detail. (The more general things apply throughout.)

docs/reference/analysis/common-uses.asciidoc Outdated Show resolved Hide resolved
docs/reference/analysis/common-uses.asciidoc Outdated Show resolved Hide resolved
docs/reference/analysis/common-uses.asciidoc Outdated Show resolved Hide resolved
docs/reference/analysis/common-uses.asciidoc Outdated Show resolved Hide resolved
docs/reference/analysis/common-uses.asciidoc Outdated Show resolved Hide resolved
@jrodewig
Copy link
Contributor Author

jrodewig commented Dec 12, 2019

Thanks for your thorough review @debadair.

I'll work on re-homing the stemming concepts info to the Analysis page and reach out again once that's ready.

@jrodewig
Copy link
Contributor Author

@debadair After giving this some more thought, I think it makes more sense to move these conceptual docs to a separate PR.

I've opened #50286 to contain the conceptual docs. I'll update this PR to focus solely on the filter reformat work.

@jrodewig jrodewig removed the WIP label Dec 17, 2019
@jrodewig jrodewig changed the title [DOCS] Add stemming concept docs. Reformat keyword token filter docs. [DOCS] Reformat keyword token filter docs. Dec 17, 2019
@jrodewig jrodewig requested a review from debadair December 17, 2019 17:40
@jrodewig
Copy link
Contributor Author

This is ready for another review at your convenience.

@jrodewig jrodewig changed the title [DOCS] Reformat keyword token filter docs. [DOCS] Reformat keyword token filter docs Dec 18, 2019
@jrodewig jrodewig removed the v8.0.0 label Dec 19, 2019
@jrodewig
Copy link
Contributor Author

After some consideration, I think I have a better approach for this. Gonna close this PR. Will open a new one once that's ready for review.

@jrodewig jrodewig closed this Dec 24, 2019
@jrodewig jrodewig deleted the reformat.keywords-token-filters branch January 29, 2020 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :Search Relevance/Analysis How text is split into tokens
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants