Internationalization and localization

[Ubugeeei]

Roadmap

• Create a framework for i18n support (for now, keep all content in English) 👉 feat: add i18n support #27
• Translation of existing documents
  As for the Japanese, either @Ubugeeei or @NozomuIkuta will handle it.
• Move javascript-parser-in-rust.
  Let's think about the details here.
• Decide on the handling of the javascript-parser-in-rust repository in consultation with @Boshen .
• Consider the operational approach for translations of this repository and document it in the contribution guide.

[NozomuIkuta]

@Ubugeeei

Thank you for creating this issue.

Introducing i18n into the current site is not so difficult.
Actually, VitePress default theme supports it natively, and I could set it up within 30 minutes.

All we have to do is to define docs/<locale> directory (e.g. docs/ja) and put same files as ones at root directory (e.g. docs/index.md corresponds to docs/ja/index.md).

The biggest issue of supporting i18n is how we manage translation, which is likely to be behind the original version.
As far as I know, Vue Router's practice is one of successful cases.

Without operation policy, supporting multi language will lead to management difficulty and user confusion.

If we could manage translated-versions in other repositories (although we need another domain for that), vuejs-translations/ryu-cho would help us to track differences between translated version and the original one.

If we can come up with a systematic way of tracking changes on the original version in one repository, we can immediately start i18n support, or we could consider the details later and just complete #4.

Do you have any thoughts?

[Ubugeeei]

Hmm, this is a difficult issue.
I don't have any ideas at the moment, but for now,
let's look for and refer to some projects that are being operated within the same domain (the same repository) 😕

[Ubugeeei]

• vue-i18n
• pinia (only zh)
• vue router (only zh)
• vuex
• vue macros
• vuetify

[Ubugeeei]

@NozomuIkuta

I personally have a preference for operating within the same repository.
Similar to how vue router created the docs-sync-zh, I think creating branches for each locale in the same repository could be a good idea.
I'll leave the naming of the branches up to you. 😉

[Ubugeeei]

@NozomuIkuta
I have documented the roadmap.
There are challenges regarding operations, but let's tackle them gradually.

[Boshen]

Decide on the handling of the javascript-parser-in-rust repository in consultation with @Boshen .

Shall we copy all content into the "learn" section once i18n support is landed?

[NozomuIkuta]

Decide on the handling of the javascript-parser-in-rust repository in consultation with @Boshen .

Shall we copy all content into the "learn" section once i18n support is landed?

I wonder where to insert the contents in "Learn" section 🤔
Current sidebar is like below:

• Architecture
  • Introduction
  • Parser
  • Linter
  • Resolver
  • Transformer
  • Formatter
  • Minifier
• ECMAScript
  • Spec
  • Grammer
• Performance
• Ecosystem
• References

Shall we add top-level category like "JavaScript Parser in Rust" or add contents to ECMAScript category?

[NozomuIkuta]

VitePress author (thank you @brc-dd) shares it with me Crowdin as an option for translation management.

You can try it out in use case of pnpm.

They support free plan for OSS projects (link), so if the service matches our needs, @Boshen can apply for it.

[Boshen]

VitePress author (thank you @brc-dd) shares it with me Crowdin as an option for translation management.

You can try it out in use case of pnpm.

They support free plan for OSS projects (link), so if the service matches our needs, @Boshen can apply for it.

I've applied it with the following message

oxc (The JavaScript Oxdiation Compiler) is a collection of JavaScript tools written in Rust.
Oxc is building a parser, linter, formatter, transpiler, minifier, resolver ... all written in Rust.
The website will eventually contain information around how to use, contribute and learn everything around the oxc project.
The website is currently using Vitepress and we are exploring translation management tracked at #13

Let's hope they accept the application 🤞

[Boshen]

https://crowdin.com/project/oxc is now up, please let me know if you can't join the project.

The next thing is to set it up like pnpm ... maybe I'll let you guys to play around with it?

[Ubugeeei]

!?

[Boshen]

Oh I see a github integration, hold on let me give it a try.

[Boshen]

Everything seems to be ready, there is now a github branch https://github.com/oxc-project/oxc-project.github.io/commits/l10n_main 🤔 and a auto crated PR #44

The translations are mapped to https://github.com/oxc-project/oxc-project.github.io/tree/l10n_main/translations

We also need to fix the file mapping

[Boshen]

It seems like Crowndin is working now, let's play around with it by moving contents of javascript-parser-in-rust repository over.

[NozomuIkuta]

@Boshen

I'm translating Japanese document and want to test Crowdin config like path matching.
Would you give me and @Ubugeeei a role with which we can synchronize Japanese contents (I gues Manager role?)?
This is also about testing fix for #50 (comment) 🙏

[Boshen]

@Boshen

I'm translating Japanese document and want to test Crowdin config like path matching. Would you give me and @Ubugeeei a role with which we can synchronize Japanese contents (I gues Manager role?)? This is also about testing fix for #50 (comment) 🙏

This is unfortunate. What's required in order to make things work? I'll configure it.

[Boshen]

@NozomuIkuta @Ubugeeei I also received this email:

As a result of a recent source files update, you’ve exceeded the hosted words limit for your Crowdin account (username: Boshen). Please upgrade your plan to keep making more сontent multilingual. Otherwise, your account will be suspended within 10 days.

On the account it says:

You have 0 private projects with a total of 60,898 hosted words.

😅 What's hosted words lol, can we mitigate this?

[brc-dd]

Shouldn't the limit for open-source projects be more? 60K words is for free accounts. You can probably ask their support. Or are you logging in from some different email? 👀

[Boshen]

Shouldn't the limit for open-source projects be more? 60K words is for free accounts. You can probably ask their support. Or are you logging in from some different email? 👀

Thank you for the pointers, I emailed them and they approved for the open-source plan.

[NozomuIkuta]

@Boshen

I'm glad to hear that they approved your request 👍

By the way, now is it possible to manage roles in the project, or do we have to upgrade plan?

[Boshen]

@Boshen

I'm glad to hear that they approved your request 👍

By the way, now is it possible to manage roles in the project, or do we have to upgrade plan?

It still shows the same error message. Just let me know if there are things need to be configured.

[NozomuIkuta]

Hmm, it says that "Crowdin is completely free of charge for open-source projects". 🤔

You might want to contact them again for support.

[Boshen]

Hmm, it says that "Crowdin is completely free of charge for open-source projects". 🤔

You might want to contact them again for support.

I guess it's free but the open source tier only allows for 1 manager. We can have as many translators as we want though.

[Boshen]

Thank you all for the effort for setting this up. I'm going to close as not planned for now due to maintenance burden, and avoiding burn out.