Translate guidelines into other languages

[dgarijo]

See the translation in Portuguese: https://joenio.me/o-guia-de-metadados-para-research-software-rsmd/
I would like to have one in Spanish too (I can volunteer, but I need the time).

Can we provide a "tab" or similar to switch between languages in the template that is selected?

[moranegg]

Hi @dgarijo,
Thanks for the suggestion, this is a very good idea.
Do you know how to use translations in mkdocs?

I found this, but I don't have the time o investigate, and it's out of scope of our effort in FAIR-IMPACT:
https://www.mkdocs.org/dev-guide/translations/

[dgarijo]

I have never done it before. Maybe @joenio has a proposal.
I know that in readthedocs there is support for branches, so we could have the main branch for english and others for other languages. Let's keep the issue open and when someone has the chance, we could investigate it.

[dgarijo]

I have also found this: https://docs.readthedocs.io/en/stable/localization.html (thanks to @esgg)
Basically, you put content in different branches and point to the corresponding one

[joenio]

Hi @dgarijo @moranegg.

I've found that internationalization and localization for MkDocs can be implemented by using plugins, the link below contains a list of MkDocs plugins:

• https://github.com/mkdocs/catalog?tab=readme-ov-file#-internationalization--localization

Among the list included in the link above I've read the quickstart guide of the 1st option, named static-i18n, and it seems a good candidate.

I think that the alternative found by @dgarijo on having branches for each language is also promisor.

Nevertheless, I think that the most time consuming part is the translation itself, the tools used can be any good and simple solution.