manual-cn

[vergil-lai]

Type of Change (select one):

• Documentation update

Description of the Change:
Chinese documents

[vergil-lai]

translated Changelog.md

[sanikolaev]

Let's replace the images with symlinks to ../manual/... to save space and avoid unneeded duplicates:

➜  manual git:(manual-cn) find . -type f|egrep "png|gif"
./images/manticore_database_flow_1.png
./Searching/autocomplete_github_demo.png
./Searching/didyoumean.png
./Searching/Full_text_matching/graphviz.png
./Searching/autocomplete.png
./Searching/faceted.png
./Searching/fuzzysearch.png
./Connecting_to_the_server/cli_browser.png
./manticore_database_flow_2.png
./mnt.cr.gif
./Node_info_and_management/Profiling/graphviz.png
./4.2.0_ps_on_vs_off.png

[vergil-lai]

Let's replace the images with symlinks to ../manual/... to save space and avoid unneeded duplicates:

➜  manual git:(manual-cn) find . -type f|egrep "png|gif"
./images/manticore_database_flow_1.png
./Searching/autocomplete_github_demo.png
./Searching/didyoumean.png
./Searching/Full_text_matching/graphviz.png
./Searching/autocomplete.png
./Searching/faceted.png
./Searching/fuzzysearch.png
./Connecting_to_the_server/cli_browser.png
./manticore_database_flow_2.png
./mnt.cr.gif
./Node_info_and_management/Profiling/graphviz.png
./4.2.0_ps_on_vs_off.png

Done.

[sanikolaev]

@Nick-S-2018 Many links are now broken due to changes in the section titles, for example:

--- a/manual-cn/Updating_table_schema_and_settings.md
+++ b/manual-cn/Updating_table_schema_and_settings.md
@@ -27,7 +27,7 @@ ALTER TABLE table MODIFY COLUMN column_name bigint
 - `text indexed` / `string indexed` - 仅索引的全文索引字段（原始值不存储在文档存储中）
 - `text indexed attribute` / `string indexed attribute` - 全文索引字段 + 字符串属性（不存储原始值）
 - `text stored` / `string stored` - 仅存储在文档存储中的值，不进行全文索引，也不是字符串属性
-- 将 `engine='columnar'` 添加到任何属性（JSON 除外）将使其存储在 [列式存储](Creating_a_table/Data_types.md#Row-wise-and-columnar-attribute-storages) 中
+- 将 `engine='columnar'` 添加到任何属性（JSON 除外）将使其存储在 [列式存储](Creating_a_table/Data_types.md#Row-wise-and-columnar-attribute-storages)⛔ 中

➜  manual-cn git:(manual-cn) ✗ diff Creating_a_table/Data_types.md ../manual/Creating_a_table/Data_types.md

...

-### 行存储和列存储属性
+### Row-wise and columnar attribute storages

Can we improve the checkDocs script , so it can update the anchors to match the new titles? Fixing that manually seems to be too boring.

Attaching the whole diff with the invalid links:
invalid_links.diff.zip

[vergil-lai]

@sanikolaev Still in progress?

[sanikolaev]

@vergil-lai Yes, unfortunately, the issue with anchors can't be fixed just by improving the script:

Can we improve the checkDocs script , so it can update the anchors to match the new titles? Fixing that manually seems to be too boring.

We'll need to update all the links manually or find another automation solution.

[vergil-lai]

Let me try write a new script. if cant work i will fix it manually.

[sanikolaev]

Let me try write a new script. if cant work i will fix it manually.

OK, thank you very much.

[vergil-lai]

@sanikolaev
I fixed the link in the documentation.
During this process, I found that many of the original documents had incorrect links.

[vergil-lai]

@sanikolaev hi, how about this?

[sanikolaev]

@vergil-lai Hi. Sorry we were sidetracked by urgent issues. Thanks for your fixes. I'm testing them now.

[sanikolaev]

@vergil-lai there are still some invalid links. Here's a diff from our validation script

invalid_links.diff.zip

Can you please look into this?

[vergil-lai]

@vergil-lai there are still some invalid links. Here's a diff from our validation script

invalid_links.diff.zip

Can you please look into this?

Ok, i will fixed it latter.

BTW, i havnt fix ChangeLog.md, Coz many bad link.

[sanikolaev]

BTW, i havnt fix ChangeLog.md, Coz many bad link.

Do you mean there are a lot of broken links? Can you please provide a few examples?

[vergil-lai]

BTW, i havnt fix ChangeLog.md, Coz many bad link.

Do you mean there are a lot of broken links? Can you please provide a few examples?

Sorry, im busy recently, I will fix it.

[sanikolaev]

No worries. Take your time.

[sanikolaev]

There are still some invalid links.

[vergil-lai]

There are still some invalid links.

yes, i will fix it recently

[vergil-lai]

Sorry, I've been a bit busy with my new job recently.
Happy new year

[sanikolaev]

Happy New Year, @vergil-lai, and congrats on the new job!

Thanks for the commit. There are still some broken links left. I've marked them with ⛔ in the latest commit, so it's easier to find and fix them.

[vergil-lai]

commited.
But many of the links you marked are correct.
I try it on github

[vergil-lai]

@sanikolaev Is there anything else that's incorrect?

[sanikolaev]

Sorry for the delay. I'll look into it today. I'll ask you to update a few pages as we are making a release and some pages have been updated since the revision you translated. I'll prepare a list.

[sanikolaev]

@vergil-lai I've reviewed the current state and have fixed a few things. It's almost okay. There's one significant issue in https://github.com/vergil-lai/manticoresearch/blob/manual-cn/manual-cn/Server_settings/Searchd.md :

• it's partly untranslated
• and messed up, e.g.:

### attr_flush_period

<!-- example conf attr_flush_period -->auto_optimize

<!-- example conf auto_optimize -->

Can you please fix this?

It seems like we also need to update the docs rendering engine.

E.g. @Nick-S-2018 , I don't get this:

![using /cli in browser](cli_browser.png)⛔

in ./Connecting_to_the_server/HTTP.md

The image file exists. It's rendered fine by markdown viewers. Same for all other images.

[vergil-lai]

fixed