opa icon indicating copy to clipboard operation
opa copied to clipboard

Docs support for other languages

Open pedroignacio13 opened this issue 3 months ago • 7 comments

What is the underlying problem you're trying to solve?

Making the documentation available in other languages will help expand the usage of OPA to developers from different nationalities.

Describe the ideal solution

The official documentation website could have on the top a list of languages available. Once the user selects the desired language, the website will update its text to the language in question. The website could use AI to translate all the text.

Describe a "Good Enough" solution

The official documentation website could have on the top a list of languages available. Once the user selects the desired language, the website will update its text to the language in question. The website code could be separated on folders, with each language available being a separate folder (the same way the kubernetes documentation website has).

Additional Context

N/A

pedroignacio13 avatar Mar 26 '24 01:03 pedroignacio13

Hello and thanks for your interest! This was brought up before, https://github.com/open-policy-agent/opa/issues/4793. I don't think AI has made translating technical content much easier... has it?

srenatus avatar Mar 26 '24 06:03 srenatus

It's probably better than it was 2 years ago, but the problem of maintainership remains. Even with an almost perfect AI generating translations, we'd have no way to verify that unless we had at least someone (but ideally a few) dedicated to the task over time. That hasn't happened.

anderseknert avatar Mar 26 '24 08:03 anderseknert

I saw the issue from 2 years ago you mentioned. Is the "problem" to implement this feature still the responsible for each language?

pedroignacio13 avatar Mar 26 '24 16:03 pedroignacio13

Hey @pedroignacio13. I have had a look at what k8s does. They shared have some guidelines here: https://kubernetes.io/docs/contribute/localization/#start-a-new-localization. These guidelines make some sensible suggestions on how to localise documentation. Notably:

  1. Because contributors can't approve their own pull requests, you need at least two contributors to begin a localization.
  1. All localization teams must be self-sufficient. The Kubernetes website is happy to host your work, but it's up to you to translate it and keep existing localized content current.

We don't currently have enough community members coming forward to start on this today. However, we should keep the issue open as it would be great if that were to change.

It doesn't look like they have opted to use machine translation either, but that too could change.

charlieegan3 avatar Mar 27 '24 14:03 charlieegan3

I really appreciate the answer Charlie, let's keep going!

pedroignacio13 avatar Mar 27 '24 19:03 pedroignacio13

💪 when the topic comes up, please do promote the issue in your circles and we'll do the same.

charlieegan3 avatar Mar 28 '24 09:03 charlieegan3

This issue has been automatically marked as inactive because it has not had any activity in the last 30 days. Although currently inactive, the issue could still be considered and actively worked on in the future. More details about the use-case this issue attempts to address, the value provided by completing it or possible solutions to resolve it would help to prioritize the issue.

stale[bot] avatar Apr 27 '24 11:04 stale[bot]