Document Translation

[SucculentAnimal]

Discussed in #1700

^{Originally posted by SucculentAnimal March 8, 2022}
Hi, I saw this project is getting popular in Japan, And since this project is very well-documented (It was very helpful, Thanks!), I was wondering can i help for translating documents?

I can only help for Chinese(mandarin) and Japanese part, but I think this might be very helpful for non-english speaker.

Is your feature request related to a problem? Please describe.
Based on #1700. This project has become popular in non-Anglosphere, but the documentation is only in English.

Describe the solution you'd like
Translate documents into languages that meet the needs of the community.

Describe alternatives you've considered

• Leave it to a personal wiki/blog post
• Host translated document myself.

Additional context.
Hello.

I think @wez’s idea of Hightlight GitHub edit link for staled documents is just great and I completely agree for making 100% covered translation is not the first priority .

And Honestly, I think there is nothing we can do about finding volunteer that is fluent in some specific languages and who will maintain the translation and keep it up to date. This part we can only rely on the community. What do y’all think? Is there any solution?

[wez]

I think we need enough commitment from volunteer(s) to get enough useful content together to make it worth adding a translation.
For example, I think it is probably not useful to translate just a single page and have the rest in English.
There is probably some minimal amount or "critical mass" of translation that would be worthwhile; it would be good to identify those areas.

What I suggested about encouraging crowd sourcing for translations is, in my opinion, fine as a way to supplement the efforts of a primary translation maintainer, but in the long run terrible for users if there is not a maintainer that can evaluate PRs for the docs and help keep things feelings more consistent, and if no one from the community shows up to submit content, then it will end up permanently stale.

If there is no maintainer for an extended period and the content is too stale, I think it may be better to for users to consider archiving or removing content.

Ultimately: I don't want to be stuck with something I can't maintain if the level of community support isn't there, especially if the result is generating problems for users. So I'd suggest the following framework for translations:

• A new translation needs to cover a core set of pages (to be decided) to give critical mass to the translation.
• A translation needs to have at least a primary maintainer who can commit to that role for a year at a time. Their responsibilities include:
  • Setting up the initial translation if it is new
  • Keeping at least the core pages up to date, but ideally translating newly added pages. I'd suggest doing this every 4-6 weeks which is my ideal release cadence.
  • Reviewing PRs for doc changes to the translation that were submitted by others from the community to ensure that they are factually accurate and that the style of the prose feels consistent with the rest of the text
  • Making an effort to help locate a replacement maintainer if they can no longer meet these commitments
• If the core set of pages is stale for more than a year, then that entire translation will be visibly flagged as unmaintained and slated for removal once it reaches, say, 18 months of being stale.

What do you think of this?

[SucculentAnimal]

Sorry for the delay in responding.
After reviewing all the description(I have no objection at all and I agree with your opinion.), I would like to volunteer to be a maintainer if possible.
Just FYI:

• I have almost mastered Chinese and Japanese. However, being a maintainer of two languages is a bit difficult. I would prefer to be a maintainer of one language if possible.
• I will be busy from January through May of the following year, so during that time I will only be able to review pull requests and merge them.
  Alternatively, I think I will only help with some of the translation and not maintain it.

If you decide to actually implement this plan, I will be happy to help in any way I can.

Lastly, thank you for your wonderful work, it is much appreciated. Me and my friends love this terminal emulator so much.

[SucculentAnimal]

I will close this issue. Thank you for taking the time to discuss this subject. If we ever discuss this issue again in the future, this will be a great foundation.

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.