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

manual-cn #2716

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

manual-cn #2716

wants to merge 14 commits into from

Conversation

vergil-lai
Copy link

Type of Change (select one):

  • Documentation update

Description of the Change:
Chinese documents

@vergil-lai vergil-lai changed the title new brach manual-cn manual-cn Nov 1, 2024
@vergil-lai
Copy link
Author

translated Changelog.md

Copy link
Collaborator

@sanikolaev sanikolaev left a comment

Choose a reason for hiding this comment

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

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
Copy link
Author

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.

@vergil-lai vergil-lai requested a review from sanikolaev November 5, 2024 11:21
@sanikolaev
Copy link
Collaborator

@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

@sanikolaev sanikolaev linked an issue Nov 7, 2024 that may be closed by this pull request
@sanikolaev sanikolaev assigned sanikolaev and unassigned Nick-S-2018 Nov 7, 2024
@vergil-lai
Copy link
Author

@sanikolaev Still in progress?

@sanikolaev
Copy link
Collaborator

@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
Copy link
Author

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

@sanikolaev
Copy link
Collaborator

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

OK, thank you very much.

@vergil-lai
Copy link
Author

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

@vergil-lai
Copy link
Author

@sanikolaev hi, how about this?

@sanikolaev
Copy link
Collaborator

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

@sanikolaev
Copy link
Collaborator

@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
Copy link
Author

@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
Copy link
Collaborator

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
Copy link
Author

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
Copy link
Collaborator

No worries. Take your time.

Copy link
Collaborator

@sanikolaev sanikolaev left a comment

Choose a reason for hiding this comment

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

There are still some invalid links.

@vergil-lai
Copy link
Author

There are still some invalid links.

yes, i will fix it recently

@vergil-lai
Copy link
Author

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

@sanikolaev
Copy link
Collaborator

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Manticore Search Chinese Document
3 participants