☂️ Translate the website in Japanese 🇯🇵

[ematipico]

Coordination issue for translating the website in Japanese.

Upon more studying, I think we can push the changes directly to main.

Our documentation uses Starlight, and that's how we can enable i18n: https://starlight.astro.build/guides/i18n/

My advice is to take charge of one page at the time.

I leave the task/coordination/help in the capable hands of @nissy-dev @unvalley and @TaKO8Ki !

[ematipico]

cc @Gumichocopengin8 as you said you would like to help :)

[nissy-dev]

Here is a list of the tasks that I currently have in mind.

• Modify astro.config.js and src/content/docs directory for i18n @Gumichocopengin8
  • see: https://starlight.astro.build/guides/i18n/#configure-i18n
• Translate src/content/docs
  • index.md @Gumichocopengin8
  • 404.md @Gumichocopengin8
  • analyzer/index.md @Gumichocopengin8
  • formatter/index.mdx @Gumichocopengin8
  • linter/index.mdx @Naturalclar
  • guides/big-projects.mdx @u-abyss
  • guides/getting-started.mdx @Yuiki
  • guides/how-biome-works.mdx @Spice-Z
  • guides/integrate-in-editor.mdx @Spice-Z
  • guides/manual-installation.mdx @chansuke
  • internals/architecture.mdx @seo1nk
  • internals/credits.mdx @hitohata
  • internals/language-support.mdx @yossydev
  • internals/philosophy.mdx @yoshi2no
  • internals/versioning.mdx @@yossydev
  • recipes/continuous-integration.mdx @yossydev
  • reference/vscode.mdx @sakimyto

This issue excludes the following auto-generated documents from scope:

• internals/changelog.mdx
• linter/rules/*.mdx
• reference/configuration.mdx (will be auto-generated in 📎 Auto generate the configuration page configuration.mdx #825)
• reference/cli.mdx
• blog/*mdx (blog is not auto-generated, but priority is low)

---

How to contribute

If you are interested in translation, please comment on this issue with the task name (like I'll take reference/cli.mdx) and create a PR!

Also, I think it would be a good idea to use tools such as GPT when translating. The following tools are used to translate React's official documentation:

https://github.com/smikitky/chatgpt-md-translator

[nissy-dev]

@Gumichocopengin8
Are you working on any tasks about translations? If not, it might be a good to have them do these tasks first!

[Gumichocopengin8]

yeah i'm working on it. I'll make a PR shortly after translating the 404.md and index.mdx
its kinda hard to translate it in natural Japanese

[nissy-dev]

Thank you! I've marked you a task on my to-do list that I think you might be working on.

Since there are many things to translate, there may not be a need to make each Japanese translation so natural. It is recommended that you separate the PR and try to improve it later. This is OSS, someone may commit a better translation.

[Gumichocopengin8]

@nissy-dev #887 is the first PR of the Japanese translation. There's one sentence I cannot come up with a good translation. Do you have any good idea?

[unvalley]

Honestly, I'm not positive for translation. I think it requires maintenance cost, the language native can only contribute, cannot understand the translation quality if we are not the language speaker.
Besides, I don't know how much this is required.

I would be glad if you could convince me🙃
It would be nice to have new contributors, but if we do it, I want to provide higher quality translations than translation tools.

[chansuke]

I am Japanese native and would like to help on this if it's possible.

[nissy-dev]

@unvalley Thank you for clarifying your stands. Basically, I think it's better to support if a new member will work this translation mainly!

I seem your concerns are mainly about maintenance costs and translation quality. I could understand this point but, I couldn't understand how serious these problems are compared to the benefits that translation brings.

To be honest, there are many things we won't know until we try like translation needs, costs, and quality. So first of all, I want to respect the wishes of those who want to contribute. If the maintenance cost or translation quality becomes problem, I think we can decide to remove translated docs.

And then, this is not just a Japanese problem. I believe that by being translated into Japanese, there will be a movement to translate it into other languages as well, and the project has the potential to spread worldwide. In fact, javascript-parser-in-rust started being translated into other languages after it was translated into Japanese.

[unvalley]

@nissy-dev
Thank you for the explanation. Let's try it out and see how Japanese speakers react. I would be happy if we could also know how much Japanese translations helped to install biome. I will also contribute as much as I can.

---

PS:
For instance, when a lint rule is implemented, we need to provide its translation in Japanese as well. It's not ideal to be unable to keep pace with original (English). From my experience, there are numerous documents that are caught in this situation. I think this task requires more perseverance than one might initially anticipate.

[Gumichocopengin8]

@unvalley I understand your concerns and I also agree that maintenance cost could be expensive, but I believe there are more benefits than the cost, especially for non English native people. I think lots of people appreciate translated doc since some are not comfortable reading and seeing English even with translation tools. For example, this user in discord would appreciate Japanese doc. Discord is a good place to ask questions but if docs have the answer, it would save users and contributors time. Also, potentially we might get more users who use the translated languages (SEO :)).

[nissy-dev]

For instance, when a lint rule is implemented, we need to provide its translation in Japanese as well. It's not ideal to be unable to keep pace with original (English).

I agree with this point. I updated the comment and excluded auto generated docs which were updated often from the scope. In the ESLint documentation, individual rules are not translated.

see: #880 (comment)

[Yuiki]

This is great project! I'm also a native Japanese speaker, so I think I can make some contributions.
I want to take guides/getting-started.mdx :)

[yossydev]

Good! I would love to work on this one myself!

[nissy-dev]

@Yuiki I assigned 👍

@yossydev Which file do you translate? see #880 (comment)

[yossydev]

Which file do you translate? see #880 (comment)

Sorry!
Then I would like to do it from internationals/language-support.mdx!

[ematipico]

@unvalley

I agree with @nissy-dev here. As for personal experience, in the past I was more keen to provide translation for my fellow country mates for projects that had already translations.

Although you are right that this creates maintenance burden to us, and we should make sure we don't burnout. It's good that you called out this, thank you.

It's like an investment, we should do it and hope for the best. I believe this is the right time to do it! And if it doesn't go well, we can always revert.

[Gumichocopengin8]

@nissy-dev can I work on analyzer/index.md and formatter/index.mdx?

[nissy-dev]

@Gumichocopengin8 I assigned!

[Spice-Z]

@nissy-dev

Hi!
Can I take guides/how-biome-works.mdx and guides/integrate-in-editor.mdx ?

[nissy-dev]

@Spice-Z I assigned!

[yoshi2no]

@nissy-dev

Hi!
Can I take internals/philosophy.mdx ?

Thanks!

[nissy-dev]

@yoshi2no I assigned!

[hitohata]

Hi @nissy-dev
Could I take internals/credits.mdx?

Thanks.

[Gumichocopengin8]

I found a routing bug. I'm pretty sure it worked fine on Vercel, so the bug is introduced after switching to Netlify.
Here's the fix #1011

[yossydev]

@yossydev Hmm, I don't think this redirect is wrong.This problem seems to be resolved by placing blog/index.mdx in ja docs.

And then, I think the problem is that the 404 feedback is not enough. The 404 page was probably not working properly because it was deployed to vercel, and the translation was also interrupted. see: #954

However, since we replaced vercel with netlify just yesterday, the 404 page seems to be working properly. Therefore, it would be ideal to fix as follows.

• add blog/index.mdx in ja docs
• translate 404.md

@nissy-dev
I see! Thank you!
May I tackle the problem over there myself? 👀

"add blog/index.mdx in ja docs" ← Regarding this, should the content remain in English??
For example, there is a blog article called Biome formatter wins the Prettier challenge, but is it okay if the title is still in English on the ja/blog page?

[nissy-dev]

@yossydev When I just checked, the blog directory moved and blog/index.mdx itself was removed...
If it's easy to fix, I think you can change it to https://biomejs.dev/blog, but I don't think many people access the footer of the top page, so it's okay to just leave it as 404.

[Gumichocopengin8]

Don't we wanna add other sponsors or README sponsor info is outdated?

[ematipico]

Don't we wanna add other sponsors or README sponsor info is outdated?

Only gold and platinum sponsors are featured on our website

[nissy-dev]

These are the remaining tasks that I have in mind

First, the translation task in #880 (comment).

• linter/index.mdx @Naturalclar
• guides/integrate-in-editor.mdx @Spice-Z

And tasks related to documents that have been recently updated.

• Update translation for formatter/index.mdx @chansuke
  • We added content regarding prettier compatibility
• Translate formatter option philosophy page @yossydev
  • We will add new page soon

I plan to close this issue as soon as I finish translating two assigned documents. Tasks related to recent updates will be created as separate issues when this issue is closed, but if someone want to start them from now, there is no problem in starting them.

[Spice-Z]

@nissy-dev
Sorry to late !
I just created the PR for guides/integrate-in-editor.mdx.

#1025

[chansuke]

@nissy-dev
Hi, thank you for the work!
Can I update formatter/index.mdx?

Update translation for formatter/index.mdx

[nissy-dev]

@chansuke Yes! I assigned you.

[yossydev]

@nissy-dev
Good evening!

Translate formatter option philosophy page

Can I do this myself?

[zhoujian-official]

Hello, is there anyone translating blogs to Japanese? I'm trying to translate blogs to Chinese but don't know where to put it. Anyone show me an example of the Japanese blog translation please.

[ematipico]

@nissy-dev @zhoujian-official

I think we should not translate our blog posts. Instead, we should let the community translate the blog posts in their platforms (for example, what Sosuke Suzuki did for Prettier's blog post https://zenn.dev/sosukesuzuki/articles/e1e47e2a760e9d ) and we could promote these translations in our channels:

• add a link at the end of each blog post
• use Discord announcements channel
• use twitter and mastodon

Here's some context about why we should do it this way: https://discord.com/channels/1132231889290285117/1138807473726300270/1181247964136615958

[zhoujian-official]

Sounds reasonable.

Here is my Chinese translation of the blogs:

Biome v1 : https://juejin.cn/post/7308539123538624549
Announcing Biome : https://juejin.cn/post/7308539123538608165
Biome formatter wins the Prettier challenge : https://juejin.cn/post/7308643782375768118

[ematipico]

That's great @zhoujian-official ! Feel free to create a PR to add those links , maybe with this markdown at the very end of the page:

## Translations

- [<TITLE IN YOUR LANGUAGE>](LINK)

[nissy-dev]

@ematipico

I think we should not translate our blog posts. Instead, we should let the community translate the blog posts in their platforms

Totally, I agree with your opinions! I removed the task related to blog translation from #880 (comment)

[nissy-dev]

@yossydev

Translate formatter option philosophy page
Can I do this myself?

Yes, but I recommend starting after the PR has been merged.

[nissy-dev]

@Naturalclar Hi! How's the translation going? If you don't have time, you can also assign it to someone else.

[Naturalclar]

@nissy-dev sorry for the late response! 🙏 I'll send a PR by end of tomorrow.

[unvalley]

We recently added the Formatter Option Philosophy. This is interesting part to know about biome's direction. Anyone interested in this translation?

[nissy-dev]

I have already assigned it to @yossydev
ref: #880 (comment), #880 (comment)

[unvalley]

Ah, sorry I missed that.

[nissy-dev]

All the originally planned translations have been completed, so I would like to close this issue. Thank you very much to everyone who helped with the translation!

[ematipico]

One last thing to do, I think, would be to translate the README.md :)

[nissy-dev]

I created the new issue #1125