Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs support for other languages #6646

Open
pedroignacio13 opened this issue Mar 26, 2024 · 7 comments
Open

Docs support for other languages #6646

pedroignacio13 opened this issue Mar 26, 2024 · 7 comments

Comments

@pedroignacio13
Copy link

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

@srenatus
Copy link
Contributor

Hello and thanks for your interest! This was brought up before, #4793. I don't think AI has made translating technical content much easier... has it?

@anderseknert
Copy link
Member

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.

@pedroignacio13
Copy link
Author

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

@charlieegan3
Copy link
Contributor

charlieegan3 commented Mar 27, 2024

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.

@pedroignacio13
Copy link
Author

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

@charlieegan3
Copy link
Contributor

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

Copy link

stale bot commented Apr 27, 2024

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 stale bot added the inactive label Apr 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants