-
Notifications
You must be signed in to change notification settings - Fork 8
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
Internationalize The Repo! #29
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hello there.
It's really tempting to see the idea and the structure of the project. Something that I've been wishing I had when I started learning web-dev.
It's true that almost all programming languages are written in English, but this repo is about education. And education should be Universal.
So, my pitch is to restructure this repo a little, to provide internationalized repo, that can be implemented to an API later in the future.
And, let's be honest here, explanations in your mother tongue are way more efficient, and clear when it comes to really absorbing the knowledge.
I suggest we go down with one of three structures:
1st: Embedding Localizations (in the same file)
This can be the easy way of doing it. Because, let's face it, the English term will be the reference anyway. The term the user will be searching for.
But, the contributor can add a new section containing the same two ways of explaining it, but in his own language.
Pro's for that are:
Con's for this approach will be:
2nd: Tagging Term
.md
Files With Language SuffixThis way can seem less clunky to implement. And relatively easy to implement since current repo is still small.
We can simply suffix the current
.md
files with the ISO 639 two-letter language codes, in small case (e.g.api-en.md
). and then, a contributor to his language can make another file with the same name, but with the language code of the language he translates/localizes to (e.g.api-jp.md
).Then, the contributor links the language version in the
README
(e.g.[APIs](/Glossary/A/api.md) ([JP](/Glossary/A/api-jp.md), [AR](/Glossary/A/api-ar.md))
)Pro's to This
Con's to that:
README
.3rd: A Glossary For Every Language
The preferred approach to me, to move the current glossary to a
EN
folder, along with itsREADME
as the index. and craft a new folder with itsREADME
index for every language to be added later.Pro's to this:
en-us
, from the ISO639-ISO3166 respectively)Of course a
maintainers.md
file will be a must-have, to make every locale maintainers announced.That's all I have.
Let me hear your thoughts.
The text was updated successfully, but these errors were encountered: