search

cnumr / best-practices

115 Web Ecodesign Best Practices
Other
425 stars 60 forks source link

Define the process for the internationalization of best practices #407

Open ACTLEM opened 2 years ago

ACTLEM commented 2 years ago

Context

Today the best practices are only in French. They are therefore not very accessible to non-French speakers, which limits their use in many countries.

What

Establish an organization to make good practices multi-language. Define a default language to facilitate exchanges (English?) or at least a second "official" language on the repository. Translate at least the good practices into English.

Action

manucoffin commented 2 years ago

Hey, I'd like to help on the English translation. Would it be a good idea to create on folder per language inside of "chapters"?

rija commented 2 years ago

Hi, It seems the language code is encoded in the file name, e.g: BP114fr.md

Maybe it's simpler to keep translations in the same directory after all, especially if it's only English for awhile?

In any case, I can also help with English translations when this moves forward.

rija commented 2 years ago

Regarding the process to handle update notification so that the translations can be updated quickly:

Maybe by setting up a github action that create a Github issue requesting translation whenever a BP_*_fr.md file is part of a commit?

florimondmanca commented 1 year ago

Hello,

On #505 I came to the same conclusion that it would be beneficial to have English translations at least.

Not only it would help increase their reuse by the community at large, but it would also foster collaboration on best practices as well as help establish the credibility of this checklist when being used as part of international ecodesign work or expertise delivery.

English translation of best practices

It seems @Mathieuinfy has already done a lot of work. đź‘Ź

What do we think about the flat folder organization?

Personally, I feel skeptical about it.

It would seem more usable for someone interested in a particular language to have everything under a folder for that language: easier to navigate, process automatically, or download for offline use.

Any thoughts against moving files under « locale folders » ?

Which language should README.md use?

Currently the repository has an English name, an English description… but a README.md written in French, with English version separately available as README_en.

To conform with the existing English title and description, shouldn’t README.md be in English as well?

This is touchy because the repository is certainly used by several French users and organizations. We should be careful to provide a smooth transition if we do go for README_en -> README and README -> README_fr.

For example, we could add a note in French at the top of the English README.md with a link to the French version.

Thoughts?