MM-67672: Added note on CJKSearch feature flag#8755
MM-67672: Added note on CJKSearch feature flag#8755agarciamontoro wants to merge 3 commits intov11.5-documentationfrom
Conversation
|
|
||
| - MariaDB v10+ no longer functions as a MySQL drop-in replacement, and it's not supported for Mattermost due to the requirement of MySQL 5.7.12. Prior versions of MariaDB were not officially supported but may have functioned in older Mattermost releases. If you are running MariaDB now, migrating from MariaDB to the MySQL equivalent is recommended. | ||
| - Deployments requiring searching in Chinese, Japanese, and Korean languages require MySQL 5.7.6+ and the configuration of `ngram Full-Text parser <https://dev.mysql.com/doc/refman/5.7/en/fulltext-search-ngram.html>`__. For searching two characters, you will also need to set ``ft_min_word_len`` and ``innodb_ft_min_token_size`` to ``2`` and restart MySQL. See `CJK discussion <https://github.com/mattermost/mattermost/issues/2033#issuecomment-183872616>`__ for details. | ||
| - MySQL deployments requiring searching in Chinese, Japanese, and Korean languages require the configuration of `ngram Full-Text parser <https://dev.mysql.com/doc/refman/5.7/en/fulltext-search-ngram.html>`__. For searching two characters, you will also need to set ``ft_min_word_len`` and ``innodb_ft_min_token_size`` to ``2`` and restart MySQL. See `CJK discussion <https://github.com/mattermost/mattermost/issues/2033#issuecomment-183872616>`__ for details. |
There was a problem hiding this comment.
I also removed the mention to MySQL v5.7, which has been out of support for years. This is not really important to this PR, though, and I left everything else intact.
|
Newest code from mattermost has been published to preview environment for Git SHA 22b74d7 |
amyblais
added
1: Dev Review
|
@agarciamontoro We use release branch in the docs repo. I haven't created one for v11.6 yet as we haven't started the release process for v11.6 yet. |
hanzei
left a comment
hanzei
left a comment
There was a problem hiding this comment.
Should we document the performance limits of the CJK search?
|
|
||
| See :doc:`database requirements documentation </deployment-guide/software-hardware-requirements>` for how to set up search for these languages. | ||
| ```{Attention} | ||
| Starting on Mattermost v11.6, searching for Chinese, Japanese or Korean (CJK) characters can be enabled with the `feature flag <https://developers.mattermost.com/contribute/more-info/server/feature-flags/#changing-feature-flag-values>` ``MM_FEATUREFLAGS_CJKSEARCH``. |
This is covered by the current recommendation of using Elasticsearch after 2.5 million posts: https://docs.mattermost.com/administration-guide/scale/enterprise-search.html#do-i-need-to-use-elasticsearch-or-aws-opensearch But we can add a reminder there, it won't hurt. |
agarciamontoro
force-pushed
the
MM-67672.cjk.search.docs
branch
from
eea710f to
3fdebd3
Compare
|
Force-pushed to rebase on top of |
|
Newest code from mattermost has been published to preview environment for Git SHA eea710f |
|
Newest code from mattermost has been published to preview environment for Git SHA 3fdebd3 |
amyblais
added
1: Dev Review
3 participants
Summary
My first instinct with respect to these docs was to completely remove them, but we cannot do that until v10.11's EOL on August.
So I simply added a note stating the new feature flag on the next v11.6.
This cannot be merged until mattermost/mattermost#35260 is merged and v11.6 is released. Not sure how we sync docs updates with the releases. @amyblais, any tips?
Ticket Link
https://mattermost.atlassian.net/browse/MM-67672