Should support translations and semver versioning

[janderssonse]

I'm interested in refering your checklist(s) from a document, which might be used in the public sector. However in the public sector, there is at times quite strict obligations regarding, native language support. For now, I will most likely do an unoffical translation to Swedish of the document shown as https://best.openssf.org/Concise-Guide-for-Developing-More-Secure-Software and friends . But it would be even better if:

• The guides were open for translation and took such contributions.
• The versions were following semver so one would know when to update the translation
• The online version had a choose lang-button so one could choose between available translations.

Would be great if It would be considered. Thanks.

[SecurityCRob]

Hello @janderssonse ! Thanks for the issue. Historically we have accepted members' contributions for translations of our work. We'd love to collaborate with your to help ensure we're able to support that. I'll add my pal @david-a-wheeler into this, as he has had some experience working with translations of LF docs in the past, and can speak to the capabilities if we're able to add a button like you have suggested to select the language the viewer desires.

[janderssonse]

@SecurityCRob and @david-a-wheeler Here is an Swedish translation from me, initiated by @thomaswennersten which might act as motivator for OpenSSF to also work on the translation possibilities. Let me know if you need a few more "quality approvals proof-reads" before acceptance, I can think of few who would be interested in this.:) Of course you can always AI it back and see that it roughly matches your intent also.

[janderssonse]

Concise-Guide-for-Evaluating-Open-Source-Software.sv.md

[janderssonse]

@david-a-wheeler I notice there are some related work regarding translations. #795 How can one aboard and become engaged in a translation team for Swedish? I would very much like to see Swedish support for the checklists - currently I work for agency, and we have preferred rules to use native language etc. It would be much nicer to point to official translated versions, (with versioning maybe), than to just fork and do unofficial translations.

[janderssonse]

Ok, read up on https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/translations.md
So I guess I would need to find at least another proofreader willing to do this work over time. That should not be a problem. And also in some way, become a trusted team member of the team translating swedish. How would I go about doing so?

[gkunz]

Hi @janderssonse! Thank you very much for getting back to this issue and offering to contribute a Swedish translation!

I assume your question is primarily about how to get started (since you mentioned that you think it is possible to find another contributor to the translation). I'd say that we can handle this fairly easily and lightweight: just let us know who should be part of the translation team and we can add the team to the documentation. Then you can go ahead and contribute a translation.

[janderssonse]

Hi @gkunz. Would you prefer any specific structure as to where to keep translations in the project? My proposal (and a common practice) would be main folder "l10n" (for localization). and then a subdir with the langcode as of IS0 639,. so "l10n/sv" for swedish, l10n/ja for Japanese.. and so on.

And on a long term, if going allowing for translations, I would suggest moving the main english documents to l10n/en, but that is just me:)

[david-a-wheeler]

Thanks so much for being willing to work on a translation!

First, I recommend you find at least one other person able & willing to be part of a Swedish "trusted translation team" & their GitHub id. Then create a proposed pull request to list that new team here:
https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/translations.md

The directory structure and names chosen will end up being displayed in the final URLs. So I would recommend not having a special l10 directory and then the language, as that creates longer URLs. There are several options:

1. What we do in the LFD121 labs is prefix the filename, e.g., ja_hello.html. This makes it easy to share files between languages.
2. We could create a directory for each language, e.g., ja/ or sv/. Issue: do we:
   a. create that subdirectory within each directory where it applies, or
   b. create one directory under docs/ once for each language, and duplicate the directory structure?

[janderssonse]

II guess option 2a would be fairly easy to maintain even for a few possible future translations to different languages.

[janderssonse]

Thanks so much for being willing to work on a translation!

First, I recommend you find at least one other person able & willing to be part of a Swedish "trusted translation team" & their GitHub id. Then create a proposed pull request to list that new team here: https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/translations.md

I have now asked @haaninjo if he would like to share the swedish translation team responsibility with me.

[haaninjo]

Thanks for the invite @janderssonse

I like consistent translations, word usage and grammar, so I gladly accept and will make sure to review coming translations :-)

To say something about myself, I see that my ten year anniversary as coordinator of Swedish GNOME translations will be later this year. Doesn't time fly?