docs: Support for Other Language

[CoolPlayLin]

Clear and concise description of the problem

As a developer, I'd like docs would support for local language so that I could have better reading experience.

Suggested solution

Create another repo to save translated docs. The translation work could leave it to contributors to do.

Alternative

No response

Additional context

No response

[github-actions[bot]]

Thank you for your feature proposal.

We marked it as "waiting for user interest" for now to gather some feedback from our community:

• If you would like to see this feature be implemented, please react to the description with an up-vote (:+1:).
• If you have a suggestion or want to point out some special cases that need to be considered, please leave a comment, so we are aware about them.

We would also like to hear about other community members' use cases for the feature to give us a better understanding of their potential implicit or explicit requirements.

We will start the implementation based on:

• the number of votes (:+1:) and comments
• the relevance for the ecosystem
• availability of alternatives and workarounds
• and the complexity of the requested feature

We do this because:

• There are plenty of languages/countries out there and we would like to ensure that every method can cover all or almost all of them.
• Every feature we add to faker has "costs" associated to it:
  • initial costs: design, implementation, reviews, documentation
  • running costs: awareness of the feature itself, more complex module structure, increased bundle size, more work during refactors

---

View more issues which are waiting for user interest

[xDivisionByZerox]

[...] I could have better reading experience.

Thats interesting. As a german, I actually hate reading translated documentation. Often, most words remain in English due to the contextual relevance or if everything is translated it tends to sound unnatural and awkward. May I ask which translation languages you'd like to see in our documentation?

[CoolPlayLin]

@xDivisionByZerox Chinese. I think the transtlation work could hand over contributor who speak this as native language.If there is only English document, it may dissuade some users who are not familiar with English or use machine translation to get bad experiences

[ST-DDT]

We could potentially use a Crowdin or similar service to maintain the translations, that way we don't have to manage them in code. As for putting the translated api docs in any kind of code bundle, I'm not sure whether that is possible at all.

@CoolPlayLin Are you willing to maintain the Chinese translations for at least a year, if we decide to add them?

(Currently, there doesn't seem to be that much of a need, if we look at the votes)

[CoolPlayLin]

@ST-DDT I'm willing to do it if I have free time. I am going to maintain it almost every weekends.

Also, I think docs could add more version for different kinds of languages if there is someone willing to maintain it.