Skip to content

[docs] Standardize synonym terminology in token filter references - #156682

Draft
leemthompo wants to merge 2 commits into
elastic:mainfrom
leemthompo:docs/synonyms-terminology-fixes
Draft

[docs] Standardize synonym terminology in token filter references#156682
leemthompo wants to merge 2 commits into
elastic:mainfrom
leemthompo:docs/synonyms-terminology-fixes

Conversation

@leemthompo

Copy link
Copy Markdown
Member

Summary

Companion to elastic/docs-content#7945 (elastic/docs-content-internal#1624).

Standardizes terminology and clarifies the circuit breaker default in both synonym token filter reference pages.

Changes

Applied to both analysis-synonym-tokenfilter.md and analysis-synonym-graph-tokenfilter.md:

  • Terminology: standardize "synonyms sets" → "synonym sets" and "synonyms set" → "synonym set" in headings and prose
  • Tense: fix future tense to present tense (the index will remainthe index remains, you will need to includeinclude)
  • Circuit breaker clarity: add a sentence noting that lenient defaults to the value of updateable, so the default behavior with updateable: true is to log and use an empty map
  • Kibana UI link: add the Kibana UI as a synonym configuration option alongside the existing API, file, and inline methods
  • Link text: update cross-repo link text to match renamed section heading on the primer page

- Standardize 'synonyms sets' to 'synonym sets' and 'synonyms set'
  to 'synonym set' in headings and prose (both reference pages)
- Fix future tense: 'the index will remain' to 'the index remains',
  'you will need to include' to 'include'
- Add lenient default note to circuit breaker section: lenient
  defaults to the value of updateable, so with updateable: true the
  default behavior is to log and use an empty map
- Update cross-repo link text to match renamed section heading
Both reference pages listed only the API, file, and inline methods.
Add the Kibana UI as a configuration option with a cross-repo link
to the docs-content primer page.
@github-actions

github-actions Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@github-actions

Copy link
Copy Markdown
Contributor

ℹ️ Important: Docs version tagging

👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version.

We use applies_to tags to mark version-specific features and changes.

Expand for a quick overview

When to use applies_to tags:

✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g. preview, ga) in a specific version
✅ When availability differs across deployments and environments

What NOT to do:

❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an applies_to tag
❌ Don't forget that applies_to tags can be used at the page, section, and inline level

🤔 Need help?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants