Translate the main .md files of this repository into other languages.

[JoseJPR]

In this repository we explain a lot of information on how to contribute, guidelines for good conduct, and much more, but it is only in English. I think we could improve the contributors experience adding the content of the most important .md in several languages.

Reference issue "i18n WG Meeting August 7th" - "i18n | Better Contributing Resources, and a call to join"(#372)

We are translating content such as the web .org, API documentation and others, but... ¿What about the main files on Github? I think that we hace severals importante files into this repository but we have this content only on english, for example the main readme.md file and others -> (https://github.com/nodejs/i18n/tree/master/guides).

I remembered that when I help this other project "Node.js CLI Apps Best Practices" (https://github.com/lirantal/nodejs-cli-apps-best-practices/blob/master/README_es.md) with the translation to Spanish, we prepare several different .md so that the user can read the content in his (perhaps this can be done with crowdin).

I could add a "README_es.md" file for Spanish and the corresponding flag in a new section. (For example)

What do you think about this?

[Aissaoui-Ahmed]

+1

[AkiraBrand]

this sounds great. I can help translate to French!

[AkiraBrand]

Alright, everyone, I am starting on the french version tonight of the main readme files (the one you see when you land here https://github.com/AkiraBrand/nodejs.dev) I will name it README_fr.md!

I'm happy to give a time estimate after I spend some time working on it tonight, I'll have a better idea how long it will take after I start to work on it.

From what I understand, we are also looking for translations for these other files, yes? https://github.com/nodejs/i18n/tree/master/guides

if the main readme file goes well, I'm happy to take a look at those for french translations later on!

[JoseJPR]

👋 Hi @AkiraBrand, yes, the idea is to translate all the documentation written in the .md files. But @srl295 told us via slack that he would create a PR to discuss whether to create a subdirectory to host the .md or what would be the best way to work. Perhaps we would wait for before starting work.

[AkiraBrand]

Ah ok, that sounds good, I'll hold off.

[srl295]

@AkiraBrand @JoseJPR i started on it - #391 !

[alexandrtovmach]

@JoseJPR Thank you for great idea, it sounds reasonable, but from personal view it's not a right way to do that. Yeah, we discussed a few times this opportunity, to translate guidelines, but in team repository, like nodejs/node-es, nodejs/node-fr, not here. My points are:

• English is de-facto basic language, and all, translators and contributors should know it. I can't imagine the possible scenario, that new translator will open nodejs/i18n repository, and looking for Spanish guideline, in case he's can't read English
• keep all guides translated in one repo it's a mess of content, and it hard to support and keep up-to-date

I've not contributed actively for last months, and probably team already changed this vision, so let me know if it's not align with current state. This issue should be related: #309

[srl295]

@JoseJPR Thank you for great idea, it sounds reasonable, but from personal view it's not a right way to do that. Yeah, we discussed a few times this opportunity, to translate guidelines, but in team repository, like nodejs/node-es, nodejs/node-fr, not here. My points are:

• English is de-facto basic language, and all, translators and contributors should know it. I can't imagine the possible scenario, that new translator will open nodejs/i18n repository, and looking for Spanish guideline, in case he's can't read English
• keep all guides translated in one repo it's a mess of content, and it hard to support and keep up-to-date

I've not contributed actively for last months, and probably team already changed this vision, so let me know if it's not align with current state. This issue should be related: #309

@alexandrtovmach I think you make sense: if I can summarize, you want to keep the translated guide close to the community that will read it, such as nodejs/node-es? Could we then have a link from the nodejs/i18n:README.md into each of the languages?

Here's a concrete proposal:

1. Looking at the current https://github.com/nodejs/i18n/blob/master/README.md it has a lot of content, including lists of contributors. To make this better translatable, would it be better to move most of what's in the README into guides/INTRODUCTION.md ? And keep the README very small linguistically, almost just a 1 paragraph introduction and the list of contributors?

Related, we can move the list of locales out of https://github.com/nodejs/i18n/blob/master/guides/TEAMS.md#l10n-teams and into the README. So the top README will just have

• very minimal boilerplate
• list of nodejs-** teams
• list of i18n contributors
• link to guides

2. If we do that, then it's the guides/ directory that we can translate!

3. Then, add i18n-guide/es under https://github.com/nodejs/nodejs-es (and other locale repos).
   So for example, https://github.com/nodejs/nodejs-es/tree/master/i18n-guide/es/CROWDIN.md

4. Now, add to the list of teams https://github.com/nodejs/i18n/blob/master/guides/TEAMS.md#l10n-teams (but in the README) a column, "Guide" that takes you to that guide in, say, nodejs-es.

DOes that all make sense? Would it be easier if I open a PR with my proposal? :)

[JoseJPR]

@srl295 I have tried to represent your proposal in a visual diagram so that we can understand it better (I hope to be helpful). I hope I have not been confused when understanding your proposal.

After thinking about the subject I have the following points to discuss (if they seem interesting to you)

Proposal:
1.- I don't see the need to add the last directory "nodejs/nodejs-es/tree/master/ i18n-guide/es", it would leave it like this "nodejs/nodejs-es/tree/master/i18n-guide". In my opinion it is redundant as it already has "nodejs-es" in the path.

Doubts:
1.- Would the entry point to the i18n group be the README.md file in English only? If so, do you think it could be inconvenient for someone who doesn't know English?

Benefits I can see:
1.- We get to update and unify the documentation in each l10n equipment.
2.- We get to involve the l10n teams more. For example, the Spanish team has been without movement for three years. :(

Points of uncertainty:
1.- That we get the l10n groups involved enough to keep the documentation updated in each language.
2.- How can we keep the l10n teams informed when the i18n working group publishes an update on the guides?

[srl295]

@JoseJPR

doubts - English

The list in the i18n readme could have the language link in the native language also ("Spanish-español"). But I think the developer can navigate that far if they've already found the i18n repo.

1.- I don't see the need to add the last directory "nodejs/nodejs-es/tree/master/ i18n-guide/es", it would leave it like this "nodejs/nodejs-es/tree/master/i18n-guide". In my opinion it is redundant as it already has "nodejs-es" in the path.

A language group might be responsible for more than one language dialect/orthography. Maybe simplified and traditional Chinese are in the same group? I think the extra /es is worthwhile

[JoseJPR]

@srl295

The list in the i18n readme could have the....

I understand, it seems good to me, we can try like this :)

A language group might be responsible for more than one language....

You're absolutely right, I didn't realize this.

[JoseJPR]

Hi everybody. 🤓 @obensource what do you think about this idea? Can we move forward with it?

[Trott]

I've unarchived this repo so I can close all PRs and issues before re-archiving.