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

Contributor's Guide: Adding Translations #4

Open
aatishb opened this issue Sep 9, 2020 · 39 comments
Open

Contributor's Guide: Adding Translations #4

aatishb opened this issue Sep 9, 2020 · 39 comments

Comments

@aatishb
Copy link
Owner

aatishb commented Sep 9, 2020

Contributor's Guide: Adding Translations

Thanks for your interest in contributing translations to this interactive essay!

This step-by-step guide is written assuming that this may be your first time contributing on GitHub. If you have questions or concerns, you can leave a comment below, open a new issue, or send me an email. If you're familiar with Github, you can skim through this guide.

We encourage contributions of all kinds, including from first-time GitHub contributors, and are acknowledging all contributions on the Github Page using the All Contributors system.

The index.html page contains the entire text of the article in English. To add a translation, you'll need to make a copy of this file and then go through this document line by line and translate it.

Steps to Contribute a Translation

  • Sign up for a Github Account if you don't already have one.

  • So that we don't double our efforts, first check if anyone is already working on this translation in the comment thread below. If no one is translating to this language, leave a comment below letting us know that you would like to proceed with a translation (don't forget to include the language you're translating to!)

  • If someone else is already working on a translation for this language, we can still use your help in reviewing this translation. If the translation is already live and you want to make improvements (e.g. correct a typo or fix a broken link), you can do so by simply editing the file and submitting a Pull Request. If you have many edits, it's better that you follow the procedure below to combine your changes into a single Pull Request. If the translation is not yet live (i.e. someone is currently working on it), you can indicate your interest in collaborating on it or reviewing it with a comment below tagging whoever is working on it.

  • On the Github Page for maskmath, click the Fork button on the top right. This will create your own personal copy of the contents of this website (known as a fork), accessible at https://github.com/your-username/maskmath
    Screen Shot 2020-09-09 at 4 29 01 PM

  • Next, set up a live website for your fork. To do this, on your own fork of maskmath, click Settings on the top right.
    Screen Shot 2020-09-09 at 4 37 37 PM

  • Scroll down to GitHub Pages and select the master branch and click save.
    Screen Shot 2020-09-09 at 4 31 51 PM

  • This will let you view your local version of the website at https://your-username.github.io/maskmath/. Check that this link works, you should see a copy of the original mask math essay.

  • Next, make a copy of index.html with the two-letter language code of the language you are translating to. For example, if you are translating to Spanish, this file will be called index-es.html If you're new to GitHub, here's how to go about doing this. First copy the contents of index.html to the clipboard. Then, on your fork of maskmath, click here to create a new file.
    Screen Shot 2020-09-09 at 4 52 39 PM

  • Give this file the name index-languagecode.html where languagecode is the two letter language code (e.g. index-es.html). Next, paste in the contents of the original index.html file and when you're done click Commit new file to save changes.
    Screen Shot 2020-09-09 at 4 55 20 PM
    Screen Shot 2020-09-09 at 4 55 12 PM

  • If this worked, you should shortly be able to access this new page online at https://your-username.github.io/maskmath/index-languagecode.html

  • In your fork, click on the index-languagecode.html file and press the edit button on the top right.
    Screen Shot 2020-09-09 at 5 01 33 PM

  • In Line 3 of the this file which reads <html lang="en">, replace the language code en with the language code that you are translating into.

  • You can now go through this file line by line and translate all the English text. After you translate a section, press the commit changes button at the bottom of the page to save your changes.

  • It's better to do this in short stretches because then you can open the live website at https://your-username.github.io/maskmath/index-languagecode.html to test and make sure the changes are working as expected. If you make a mistake, you can compare your changes against index.html to see what went wrong. (Click Commits on your fork to see a complete list of all your changes.)

  • (More advanced) If you prefer to work locally on your computer instead of on the GitHub website, you can use the GitHub Desktop client and a text editor like Sublime Editor.

  • You're encouraged to add a line of credit to yourself in the translation. In the Credits & References section of index-languagecode.html next to the sentence This essay was created by Aatish Bhatia in collaboration with Henry Reich. For example, you can add a (translated) sentence like It was translated into [your-language] by [your-name]. You can link your name to your website or social media profile.

  • In your fork, click on the folder js, and then click on the file vue-definitions.js and press the edit button on the top right. Look for the section that lists all the translations (around line 250). Duplicate the last entry in this list, then edit it so that it points to the correct url and name of the language you are translating into, and save changes. If this worked correctly, you should shortly see your language listed in the header of the page. Confirm that this link works as expected.
    Screen Shot 2020-09-30 at 10 54 26 AM
    Untitled

  • When you're done with the translation and have tested that that the website loads as expected, make a Pull Request to incorporate your changes into the original maskmath website. To do this, in your fork of maskmath, click the Pull request button, and then click Create pull request.
    Screen Shot 2020-09-09 at 5 08 30 PM
    Screen Shot 2020-09-09 at 5 12 49 PM

  • Add a title and description, and Create your pull request. You can add any relevant notes in here. Please keep the Allow edits by maintainers button ticked as this will help me easily merge your changes.
    Screen Shot 2020-09-09 at 5 13 35 PM

  • Your Pull Request will be reviewed and once accepted you will be added as a contributor.

Thank you so much for contributing!

@aatishb aatishb pinned this issue Sep 9, 2020
@mariapaula9926
Copy link
Contributor

Hi, I would like to help with the Spanish translation!

@aatishb
Copy link
Owner Author

aatishb commented Sep 10, 2020

@mariapaula9926 sounds good, and thanks!

@albannabla
Copy link
Contributor

Hello, I think I could do the Italian translation!
thanks for sharing this, by the way... excellent job! :)

@nlehuen
Copy link
Contributor

nlehuen commented Sep 11, 2020

Hi, I'm ~half way through the French translation in https://github.com/nlehuen/maskmath/blob/master/index-fr.html. Will continue tomorrow!

@gnegrelligarcia
Copy link
Contributor

Hello!! I would like to contribute with a translation to Brazilian Portuguese :)

@albannabla
Copy link
Contributor

Hello,
there are parts that cannot be translated from the HTML file... is this ok?
example:

Screen Shot 2020-09-12 at 7 57 21 AM

@aatishb
Copy link
Owner Author

aatishb commented Sep 12, 2020

We have a fix in the works for this with #5 (as well as a fix for translating the titles and annotations for the two graphs). I'd suggest ignoring this for now and when you submit the pull request we can take care of it.

@albannabla
Copy link
Contributor

We have a fix in the works for this with #5 (as well as a fix for translating the titles and annotations for the two graphs). I'd suggest ignoring this for now and when you submit the pull request we can take care of it.

Brilliant, thank you!

@tobiv
Copy link

tobiv commented Sep 12, 2020

Hi, I'm up for a translation to German.

This was referenced Sep 13, 2020
@ulkar-aghayeva
Copy link
Contributor

Hi there,
I'd be happy to help with the Russian translation!

@progproc
Copy link
Contributor

Hi, I will start the Czech translation (cs).

@mrtzkdev
Copy link

mrtzkdev commented Sep 14, 2020

Hi, I'm up for a translation to German.

I would be happy to help translate or review the german translation.

@pinardemetci
Copy link

Hi, I saw this on @MinutePhysics; thanks for creating this! I would love to help with the Turkish translation (my native language) and would be able to finish by the end of this week.

@aatishb
Copy link
Owner Author

aatishb commented Sep 14, 2020

@pinardemetci (and everyone): That's great, go for it! Greatly appreciate your input!

@alisabzevari
Copy link
Contributor

Hi, I would like to work on the Persian translation.

@pankgeorg
Copy link
Contributor

Hello, I'd like work on traslating to Greek

@pankgeorg
Copy link
Contributor

@aatishb , Greek is a gender specific language - I'm writing the credits - how do you prefer to be referenced? (He/Him, other?)

@ismarou
Copy link

ismarou commented Sep 18, 2020

Hi @pankgeorg, @aatishb, I just saw the 'minutephysics' video and I thought I could help you with the Greek translation, so we can save time, if you are not done already. If you are interested, e-mail me.

@aatishb
Copy link
Owner Author

aatishb commented Sep 19, 2020

@pankgeorg yes, he/him. Thanks for working on this!

@ToniDS
Copy link

ToniDS commented Sep 22, 2020

Hi, I'm up for a translation to German.

I would be happy to help translate or review the german translation.

What is the current status of the German translation?

@tobiv
Copy link

tobiv commented Sep 22, 2020

@ToniDS see my fork https://github.com/tobiv/maskmath
I haven't had much time to work on it, I'll add you as a collaborator if you like.

@ToniDS
Copy link

ToniDS commented Sep 23, 2020

@ToniDS see my fork https://github.com/tobiv/maskmath
I haven't had much time to work on it, I'll add you as a collaborator if you like.
Yes, please! I will then fork it and write a PR to you, or is there a different workflow?

@huedaya
Copy link
Contributor

huedaya commented Sep 25, 2020

well, working on Bahasa Indonesia (id) translation.

@progproc
Copy link
Contributor

Added the Czech translation. I am new to GitHub so I am not sure if I did the pull request right.

@Sunny121294
Copy link

Hi Aatish
Great work!
I would like to help with हिन‍्दी translation.

@fbuters
Copy link
Contributor

fbuters commented Oct 1, 2020

Hey there!
Is Dutch still available? Otherwise I can provide the Dutch translation!

Cheers,
Frank

@aatishb
Copy link
Owner Author

aatishb commented Oct 1, 2020

@fbuters @Sunny121294 go for it!

@fbuters
Copy link
Contributor

fbuters commented Oct 1, 2020

@fbuters @Sunny121294 go for it!
Alright! Hope to have it finished during upcoming weekend :)

@Sunny121294
Copy link

@aatishb, I'm on it.

@morethanoneanimal
Copy link
Contributor

I'm working on the Polish translation.

@kasiarzynaLu
Copy link
Contributor

I'm working on the Polish translation.

Is there any way I could help with the Polish translation?

@morethanoneanimal
Copy link
Contributor

morethanoneanimal commented Oct 14, 2020

I'm working on the Polish translation.

Is there any way I could help with the Polish translation?

Oczywiście!

I added you as a collaborator to my fork where I'm working on the translation. If you know how github works, feel free to comment on pull requests and add your translations. If not, let me know and we'll figure something out.

@atjn
Copy link

atjn commented Oct 27, 2020

I'll start work on a Danish translation :)

@Mentathiel
Copy link
Contributor

Hey, I'm about to start a Serbian translation.

@kisaragi-hiu
Copy link

I have started working on a Traditional Chinese translation at https://github.com/kisaragi-hiu/maskmath/tree/translation/zh-Hant.

@bojanastojanova
Copy link
Contributor

Hi, I'll start working on a Macedonian translation today. I have a team of scientists and teachers that will help out, so we should be done very quickly! BTW, is there a possibility to synchronize the MinutePhysics video in Macedonian as well, or at least add subtitles?

@aatishb
Copy link
Owner Author

aatishb commented Feb 16, 2021

@bojanastojanova Great! I don't know about adding subtitles to the MinutePhysics video, it used to be possible in the past for people to contribute translations to YouTube videos but unfortunately I think YouTube no longer allows this.

@bojanastojanova
Copy link
Contributor

@aatishb
Hey there, Macedonian translation is ready although it took longer than expected. I've sent a pull request last week, let me know when it goes up online so we can embed it at nzd.mk

This was referenced Apr 29, 2021
@dev-owner
Copy link
Contributor

I would like to help with the Korean translation. Thank you for sharing. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests