opa icon indicating copy to clipboard operation
opa copied to clipboard

Internationalizing documentation

Open Joffref opened this issue 2 years ago • 5 comments

What part of OPA would you like to see improved?

I think OPA should include some other languages in its documentation.

I'm planning to do, if you agree, the translation of the documentation in French. At least the Introduction.

Joffref avatar Jun 19 '22 09:06 Joffref

That's an interesting idea @Joffref 🙂

And it's probably not a big thing to do from a technical POV, as I assume Hugo supports this well. I think the big challenge would be how to keep this maintained over time. If we update the docs — and we do all the time! — unless we have someone — and ideally at least two people, since we'd want to have someone reviewing as well — fluent in that second language commiting regularly to OPA, we won't be able to update the translation ourselves, and there's always going to be a risk of it getting out of date compared to the English version. I suppose if the translation at least initially covers only the introduction, and "what is OPA/Rego"... that might not be as much of an issue.

@peteroneilljr might have some ideas here as well.

anderseknert avatar Jun 19 '22 12:06 anderseknert

At the very least, we could add a section linking the non-english resources known today. They don't quite fit well in the ecosystem category.

srenatus avatar Jun 19 '22 14:06 srenatus

This issue has been automatically marked as inactive because it has not had any activity in the last 30 days.

stale[bot] avatar Jul 19 '22 22:07 stale[bot]

hi @Joffref ! Thanks for this idea! I think it would be fantastic to have the docs in other languages. The best place to start is the philosophy section. As we introduce new features and syntax, the underlying principles of OPA don't change so this page is pretty static.

Once you get a draft up let me know and I'll hack away at our docs to figure out how to make it switch languages.

Cheers, Peter

peteroneilljr avatar Jul 20 '22 13:07 peteroneilljr

This issue has been automatically marked as inactive because it has not had any activity in the last 30 days.

stale[bot] avatar Aug 30 '22 22:08 stale[bot]

This issue has been automatically marked as inactive because it has not had any activity in the last 30 days.

stale[bot] avatar Apr 07 '23 09:04 stale[bot]

Closing for now. We can re-visit based on interest and if folks would like to volunteer to help achieve this.

ashutosh-narkar avatar Sep 05 '23 23:09 ashutosh-narkar