search

openservicemesh / osm-docs

a docs page for open service mesh
https://docs.openservicemesh.io
Apache License 2.0
4 stars 40 forks source link

Translate documents in Chinese #384

Closed addozhang closed 2 years ago

addozhang commented 2 years ago

There are many potential users of osm in China. To make OSM docs more accessible to us, it's better to make OSM docs support multi-language. This should be not only for Chinese, other languages as well.

In this PR, our team makes theme support multi-languages first, then provides Chinese version docs based on branch release-v1.1.

netlify[bot] commented 2 years ago

Deploy Preview for osm-docs ready!

Name Link
Latest commit 8054ff5a1b5792fb6620fe713d92249f76dd5e72
Latest deploy log https://app.netlify.com/sites/osm-docs/deploys/62bfb0ff3c89820008107086
Deploy Preview https://deploy-preview-384--osm-docs.netlify.app/zh/docs/guides/reconciler
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

shashankram commented 2 years ago

Hey @addozhang, thanks for doing this. Is there guidance on how new documentation should be crafted in a manner where it can be auto-translated to other languages, or would we need to make multiple language-specific copies of it at the time of writing the doc? Could you update the main README.md file with details on how to go about this?

addozhang commented 2 years ago

@shashankram Let's discuss here first.

For new drafted document (it's english one in general), it's placed in content/en folder and presented on page of english version. It wont's be show on other languages page. There are two approaches:

  1. We can copy it to other languages folders (such as content/zh) and it will be rendered in English on other languages page temporarily. Then label issue as translating required, and some one can work on translation.
  2. Leave new drafted document disappear from other languages page, label issue as translating required and some guy will work on translation (need to create doc in specified language folder first.)

Do you have any better solution?

allenlsy commented 2 years ago

Can you also provide a Chinese doc maintenance plan? If the core team does not have the resource to update the Chinese version when updating the English version, what's the procedure we should follow to keep the Chinese (and other languages) version updated?

addozhang commented 2 years ago

@allenlsy Thanks for your review comments, all comments are resolved.

Our team is extending OSM by making it supports other proxies (submitted in issue), such as the Pipy from our team. At the same time, our team and the contributors will work together to host the translation of OSM documentation.

For the concern of how to keep other languages updated, we drafted a proposal here. If all are good with it, we will proceed with updating the README.md accordingly.

addozhang commented 2 years ago

Just synced from release-v1.1 branch of upstream.

shashankram commented 2 years ago

@allenlsy Thanks for your review comments, all comments are resolved.

Our team is extending OSM by making it supports other proxies (submitted in issue), such as the Pipy from our team. At the same time, our team and the contributors will work together to host the translation of OSM documentation.

For the concern of how to keep other languages updated, we drafted a proposal here. If all are good with it, we will proceed with updating the README.md accordingly.

@addozhang, thanks for sharing the proposal. We shall review it and update this thread.

addozhang commented 2 years ago

@shashankram In this translation, we did not import any new images or files. The ha1.png, ha2.png are from English edition. But I couldn't agree with you any more on making filename more readable and we will be careful of this in future.

By the way, we create a proposal in #401 as discussed on Slack.

shashankram commented 2 years ago

@shashankram In this translation, we did not import any new images or files. The ha1.png, ha2.png are from English edition. But I couldn't agree with you any more on making filename more readable and we will be careful of this in future.

By the way, we create a proposal in #401 as discussed on Slack.

Thanks @addozhang, I haven't had the chance to read the proposal, but I agree with the approach you have taken in this PR. @allenlsy, @zr-msft could you please review this?

zr-msft commented 2 years ago

thank you @addozhang for all your work on this.

With the v1.2 release, we've added the scaffolding for handling localizations as well as outlining the process to follow: https://github.com/openservicemesh/osm-docs#localization

In the 1.2 release branch, we've already added a zh directory config.toml:

Please follow the process outlined above to create a new PR for localization of the 1.2 release.

addozhang commented 2 years ago

@zr-msft It's really a great news, thanks for your support.

addozhang commented 2 years ago

@zr-msft New PR #427 raised. Please help to review.

bridgetkromhout commented 2 years ago

Given that https://github.com/openservicemesh/osm-docs/pull/427 has been merged into 1.2, do we still intend to also work on this PR? Or shall we close it and do any appropriate cherry-pick out of what's been merged? Thanks.

addozhang commented 2 years ago

@bridgetkromhout we can close this one. All have been merged into 1.2.0 branch.