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

Manticore Search Chinese Document #2674

Open
vergil-lai opened this issue Oct 22, 2024 · 10 comments · May be fixed by #2716
Open

Manticore Search Chinese Document #2674

vergil-lai opened this issue Oct 22, 2024 · 10 comments · May be fixed by #2716

Comments

@vergil-lai
Copy link

vergil-lai commented Oct 22, 2024

Hi offical:
I have translated the documentation of Manticore Search into Chinese. I wonder if it can be included or linked by the official site.

Github: https://github.com/vergil-lai/manticoresearch-manual-zh
Gitbook: https://vergil-lai.gitbook.io/manticoresearch-manual-zh

@sanikolaev
Copy link
Collaborator

Hi @vergil-lai

This is great! Thank you! I'll discuss with the team the best way to handle it. A few questions:

@sanikolaev sanikolaev added the waiting Waiting for the original poster (in most cases) or something else label Oct 23, 2024
@vergil-lai
Copy link
Author

vergil-lai commented Oct 23, 2024

Hi @vergil-lai

This is great! Thank you! I'll discuss with the team the best way to handle it. A few questions:

Hi, @sanikolaev

  • My translation is based on the e7e4cc6 commit of the master. My mistake. I should have translated based on manticore-6.36 branch.
  • I used ChatGPT-4o to translate these documents paragraph by paragraph and manually proofread each paragraph.
    • BTW, I keep the original format of the document. e.g. HTML comments like <!-- intro -->, <!-- response -->,<!-- proofread -->etc.
    • How to use these like on the official website and turn it into tabs for each program language?
  • When I have time, I can maintain Chinese documentation for future each release. (old versions are skipped.)

@sanikolaev
Copy link
Collaborator

My translation is based on the e7e4cc6 commit of the master. My mistake. I should have translated based on manticore-6.36 branch.

I think you did all fine. Otherwise, anything newer than 6.3.6 (available here: https://manual.manticoresearch.com/dev/) would still need to be translated.

BTW, I keep the original format of the document. e.g. HTML comments like <!-- intro -->, <!-- response -->, <!-- proofread --> etc. How to use these like on the official website and turn it into tabs for each program language?

It's generated by a custom docs renderer specifically made for https://manual.manticoresearch.com/. Unfortunately, it's not publicly available and open source yet, but we can share the Docker image with you if it helps in maintaining the docs.

When I have time, I can maintain Chinese documentation for future each release

Great. Thanks.

I'll have a call with the team tomorrow and will discuss the further steps of this project.

@vergil-lai
Copy link
Author

It's generated by a custom docs renderer specifically made for https://manual.manticoresearch.com/. Unfortunately, it's not publicly available and open source yet, but we can share the Docker image with you if it helps in maintaining the docs.

Maybe is not needed.Because my page hosted on Gitbook for free and cannot use any scripts or Docker.
If you compile it into the https://manual.manticoresearch.com., it may take effect directly. Because I have keep everything.

@sanikolaev
Copy link
Collaborator

Hello @vergil-lai

We've discussed it, and here’s what we can do:

  • Please create a pull request to commit your changes to the ./manual-cn/ directory.
  • We'll make it accessible at https://cn.manual.manticoresearch.com/dev/
  • For the next release, we'll create a PR with the translated differences and ask you to review it.

@vergil-lai
Copy link
Author

Hello @sanikolaev
i havent translate Changelog.md, do you want me to translate it?

@sanikolaev
Copy link
Collaborator

i havent translate Changelog.md, do you want me to translate it?

Yes, please. I think it's just as important as the other documentation, especially for those who don't speak English.

@vergil-lai
Copy link
Author

i havent translate Changelog.md, do you want me to translate it?

Yes, please. I think it's just as important as the other documentation, especially for those who don't speak English.

ok

@vergil-lai
Copy link
Author

i havent translate Changelog.md, do you want me to translate it?

Yes, please. I think it's just as important as the other documentation, especially for those who don't speak English.

Done.

@sanikolaev sanikolaev removed the waiting Waiting for the original poster (in most cases) or something else label Nov 7, 2024
@sanikolaev
Copy link
Collaborator

Waiting for #2716 (comment) from @Nick-S-2018

@sanikolaev sanikolaev linked a pull request Nov 7, 2024 that will close this issue
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 a pull request may close this issue.

2 participants