-
Notifications
You must be signed in to change notification settings - Fork 609
support for Elastic(Open)search CJK analysis plugins #8829
Copy link
Copy link
Open
Description
Let's update the Mattermost Product Documentation to reflect the System Admin Elasticsearch/OpenSearch search configuration experience captured via Engineering PR mattermost/mattermost#34784
Scope & constraints
- Review PR #34784 as the source of truth before drafting.
- Use the milestone version from PR metadata: v11.6.0.
- Focus only on admin-visible capability and operational expectations proved by the PR:
- new ElasticsearchSettings.EnableCJKAnalyzers setting
- default is false
- supported analyzer plugins named in PR evidence: analysis-nori, analysis-kuromoji, analysis-smartcn
- applies to Elasticsearch and OpenSearch
- purpose is improved search behavior for Korean, Japanese, and Chinese when required plugins are installed
- Do not document implementation details, code structure, templates, internal test scaffolding, or Docker/local-dev setup unless an existing admin doc explicitly uses those pages for supported product setup.
- Do not modify: changelogs, important upgrade notes, version archive, removed/deprecated features, unsupported legacy releases.
- Any statement not directly supported by PR evidence must be marked: [NOT PRESENT IN PR — REQUIRES HUMAN JUDGMENT].
- Required doc touchpoints (pages/sections if known; otherwise "identify likely pages")
- Identify likely admin docs covering:
- Elasticsearch/OpenSearch configuration
- search configuration / search backend setup
- config.json / System Console reference for Elasticsearch settings
- Only touch end-user search docs if an existing page explicitly claims a CJK limitation that this PR resolves. Otherwise leave end-user docs unchanged. [NOT PRESENT IN PR — REQUIRES HUMAN JUDGMENT]
- For simple capability parity: Keep to ONE task, not multiple persona sections
- Keep this as one System Admin task.
- Output requirements (what to return: proposed text, page list, before/after, etc.)
- Return:
- whether a doc update is necessary
- the most likely existing page(s) to update
- a short rationale tied to PR evidence
- proposed doc text in the existing page style
- before/after snippets or exact insertion points
- The proposed update should, at minimum:
- name the new setting EnableCJKAnalyzers
- state that it is disabled by default
- state that required analyzer plugins must be installed
- name the supported plugins exactly as shown in the PR
- describe the admin-facing outcome as improved search results for Korean, Japanese, and Chinese
- Do not invent UI labels, System Console paths, or exact log messages unless explicitly present in PR evidence.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels