search

biomejs / biome

A toolchain for web projects, aimed to provide functionalities to maintain them. Biome offers formatter and linter, usable via CLI and LSP.
https://biomejs.dev
Apache License 2.0
14.3k stars 443 forks source link

☂️ Translate the website in Japanese 🇯🇵 #880

Closed ematipico closed 9 months ago

ematipico commented 10 months ago

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 commented 10 months ago

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

nissy-dev commented 10 months ago

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

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

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 commented 10 months ago

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

Gumichocopengin8 commented 10 months ago

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 commented 10 months ago

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 commented 10 months ago

@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 commented 9 months ago

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 commented 9 months ago

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

nissy-dev commented 9 months ago

@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 commented 9 months ago

@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 commented 9 months ago

@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 commented 9 months ago

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: https://github.com/biomejs/biome/issues/880#issuecomment-1826477936

Yuiki commented 9 months ago

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 commented 9 months ago

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

nissy-dev commented 9 months ago

@Yuiki I assigned 👍

@yossydev Which file do you translate? see https://github.com/biomejs/biome/issues/880#issuecomment-1826477936

yossydev commented 9 months ago

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

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

ematipico commented 9 months ago

@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 commented 9 months ago

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

nissy-dev commented 9 months ago

@Gumichocopengin8 I assigned!

Spice-Z commented 9 months ago

@nissy-dev

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

nissy-dev commented 9 months ago

@Spice-Z I assigned!

yoshi2no commented 9 months ago

@nissy-dev

Hi! Can I take internals/philosophy.mdx ?

Thanks!

nissy-dev commented 9 months ago

@yoshi2no I assigned!

hitohata commented 9 months ago

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

Thanks.

yossydev commented 9 months ago

@nissy-dev Now that I was able to get a PR out for the first translation, I would like to work on the internals/versioning.mdx next!

nissy-dev commented 9 months ago

@hitohata @yoshi2no I assigned!

seo1nk commented 9 months ago

@nissy-dev Hi! Can I take internals/architecture.mdx ?

sakimyto commented 9 months ago

@nissy-dev can I take reference/cli.mdx & reference/vscode.mdx?

unvalley commented 9 months ago

Thank you for your work, guys. When your PR is ready for review, please assign @nissy-dev, @TaKO8Ki, and @unvalley as reviewers.

Gumichocopengin8 commented 9 months ago

I think only core contributors and maintainers can assign PRs to them as reviewers.

TaKO8Ki commented 9 months ago

It might be a good idea to create a team, such as 'japanese-translation-reviewers', so that reviewers are automatically assigned when files under website/src/content/docs/ja/ are edited or new files are added.

unvalley commented 9 months ago

I think only core contributors and maintainers can assign PRs to them as reviewers.

Oops, I didn't know that.

unvalley commented 9 months ago

@ematipico could you create a team japanese-translation-reviewers includes me, TaKO8Ki, nissy-dev?

TaKO8Ki commented 9 months ago

@ematipico In addition, I would appreciate it if you could turn auto assiginment on if possible. ref: https://docs.github.com/en/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team#configuring-auto-assignment

nissy-dev commented 9 months ago

@sakimyto @seo1nk I assigned!

nissy-dev commented 9 months ago

I created the team https://github.com/orgs/biomejs/teams/japanese-translation-reviewers

TaKO8Ki commented 9 months ago

The next step is to set this team as the code owners. I'll work on it.

Naturalclar commented 9 months ago

@nissy-dev I'd like to work on linter/index.mdx

TaKO8Ki commented 9 months ago

I've assigned you. @Naturalclar

yossydev commented 9 months ago

@nissy-dev Next, I would like to translate recipes/continuous-integration.mdx!

nissy-dev commented 9 months ago

@yossydev I assigned you!

unvalley commented 9 months ago

I think we should set some criteria for translation, for example

@nissy-dev I want you to take the lead, and off course I can help

Conaclos commented 9 months ago

@TaKO8Ki

@ematipico In addition, I would appreciate it if you could turn auto assiginment on if possible. ref: https://docs.github.com/en/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team#configuring-auto-assignment

Have you some context for that? This seems not optimal because the assignment of the review is "randomly" assigned.

TaKO8Ki commented 9 months ago

@ematipico

As you said, the assignment of the review is "randomly" assigned, but as far as I know, auto assignment allows us to choose the number of people to assign. In this case, if you set it to three people, whether you choose round robin or load balance, I believe everyone will get assigned.

nissy-dev commented 9 months ago

@unvalley I think it is ok to create some criteria using tools like linters and formatters. (I don't agree with creating criteria that cannot be guaranteed by tools.) And, I don't have personal opinions about the settings or criteria.

If you or anyone is interested, I would appreciate it if they could install the tool.

TaKO8Ki commented 9 months ago

@unvalley @nissy-dev

I think it is ok to create some criteria using tools like linters and formatters. (I don't agree with creating criteria that cannot be guaranteed by tools.) And, I don't have personal opinions about the settings or criteria.

I share the same opinion. Introducing a tool like textlint might be good, but I also think it's acceptable to have some variation in translation methods without being too concerned about it.

unvalley commented 9 months ago

Let's do that, I can be a bit pedantic about Japanese writing😅

u-abyss commented 9 months ago

@nissy-dev I'd like to work on guides/big-projects.mdx!

nissy-dev commented 9 months ago

@u-abyss I assigned you!

chansuke commented 9 months ago

@nissy-dev Thank you so much for your work! I'd like to take manual-installation.mdx