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

Translate README.md to Arabic #1586

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Translate README.md to Arabic #1586

wants to merge 12 commits into from

Conversation

BatoolMM
Copy link
Member

Summary

In order to attract volunteers to translate chapters of the book to Arabic, I translated README.md to Arabic.
I think it'll be useful to translate the CONTRIBUTING.md and the presentation to Arabic as well.

What should a reviewer concentrate their feedback on?

  • Everything looks ok?

Acknowledging contributors

@netlify
Copy link

netlify bot commented Nov 13, 2020

Deploy preview for the-turing-way failed.

Built with commit 419a5c9

https://app.netlify.com/sites/the-turing-way/deploys/605228bd1eef540008be9ada

@BatoolMM BatoolMM changed the title translated README.md to Arabic Translate README.md to Arabic Nov 13, 2020
@BatoolMM BatoolMM added the book-dash-nov20 This is to be used on issues and PR during/for the book dash in Nov 2020 label Nov 13, 2020
right-align doesn't seem to work, needs to be fixed later.
@BatoolMM BatoolMM added the translation Translating the book into other languages label Nov 19, 2020
@malvikasharan
Copy link
Collaborator

@BatoolMM can you recommend someone to review this?

Arabic is read from right to left but it's a bit challenging to change the direction of the text in markdown without HTML tags, so it needs to be aligned to the right. Tags `ltr` need to be used for every paragraph or line. It can't be applied to all the text at once.
@BatoolMM
Copy link
Member Author

@WafaaMoh can you help in reviewing the Arabic translation, please?

@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 23, 2021

@BatoolMM Great work, Batool!

@BatoolMM
Copy link
Member Author

BatoolMM commented Feb 23, 2021

@Hanaffi, thank you. Actually, this PR is not ready to be merged. I can easily spot many words that may need to be paraphrased. Also, there is sometimes a problem with the orientation of the sentence when English and Arabic are mixed in the same sentence. It'd be great f you can help review it @Hanaffi by making some suggestions, if it's OK?

@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 23, 2021

@BatoolMM Yes, Thats totally fine. Please add me to the reviewers.

@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 23, 2021

@BatoolMM
Instead of using <div dir="rtl"></div> you can use : http://rtlmd.codecast.ir/
It looks easier and more elegant.

@BatoolMM
Copy link
Member Author

@Hanaffi, it'll be amazing if this tool works. I think you can work on this PR without assignment by clicking on edit file.
Image 26-02-2021 at 02 01

It'll be great if you can review it and suggest changes. If you have any question, please let me know!

@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 25, 2021

@BatoolMM Its disabled for me as I'm not a collaborator 😔😢


zz

@BatoolMM
Copy link
Member Author

Malvika kindly gave you triage access. You should be able to use Edit File now. Let me know if you still have any problem @Hanaffi!

@BatoolMM
Copy link
Member Author

What about "review changes" button on the top corner?
This is an example #1356 of a README file reviewed this way when it was translated to Dutch. Most reviewers don't have triage access as far as I know but I could be wrong, I'll read more in GitHub documentation. Let me know if you still can't review!

@Hanaffi Hanaffi self-requested a review February 26, 2021 01:59
@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 26, 2021

@BatoolMM That just let me write feedback for the pull-request.

@Hanaffi

This comment has been minimized.

@malvikasharan
Copy link
Collaborator

malvikasharan commented Feb 26, 2021

Hi @Hanaffi, Batool is right. Most contributors don’t have triage or write access. You should be able to comment on different parts of the document nonetheless. I can definitely give you write access, but I think on any open repository you can review and comment on PRs without being added to the repo.

@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 26, 2021

@malvikasharan Thanks :) I feel super power now xd

@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 26, 2021

@BatoolMM Hello Batool, Can you try to fix/pass these checks?

@BatoolMM
Copy link
Member Author

I'll take care of these checks at the end because some changes have been introduced to CI after creating this PR. In other words, this PR needs to be updated with the master branch.
I've looked at the translation, thank you for the works but there's still some problem with the orientation and links. There are no hyperlinks to the toc. Also, some paragraphs aligned LTR wheras others RTL.
Image 26-02-2021 at 13 37

@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 26, 2021

@BatoolMM
Can you mention in what line the orientation problem?

  • For links, IDK how to align them right in md files

You can view the file better here.
https://github.com/alan-turing-institute/the-turing-way/blob/ff43c03a197f4fc2c81c9e4830d557f9169aff7a/README-translated/README-ARABIC.md

@malvikasharan
Copy link
Collaborator

You can review that here: https://raw.githubusercontent.com/alan-turing-institute/the-turing-way/ff43c03a197f4fc2c81c9e4830d557f9169aff7a/README-translated/README-ARABIC.md

Copy link
Member Author

@BatoolMM BatoolMM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pointed out the lines where the orientation is left to right (LTR) when it supposes to be right to left (RTL). Please note that these are mostly English words that were supposed to be on the same line as the Arabic sentences but I separated them into different lines because the order gets changed as I mix English and Arabic in the same sentence. Having said that, the tool you used seems to be really good and it prevents the disorder when English and Arabic are mixed in the same sentence. So, it'll be good if you can move them back to the same sentence as they suppose to be. I find it useful to compare it with the English REAMDME.md by splitting the screen. It makes it easier to catch the differences. Thank you @Hanaffi

README-translated/README-ARABIC.md Show resolved Hide resolved
README-translated/README-ARABIC.md Outdated Show resolved Hide resolved
README-translated/README-ARABIC.md Outdated Show resolved Hide resolved
README-translated/README-ARABIC.md Outdated Show resolved Hide resolved
README-translated/README-ARABIC.md Outdated Show resolved Hide resolved
README-translated/README-ARABIC.md Outdated Show resolved Hide resolved
README-translated/README-ARABIC.md Outdated Show resolved Hide resolved
README-translated/README-ARABIC.md Outdated Show resolved Hide resolved
README-translated/README-ARABIC.md Outdated Show resolved Hide resolved
README-translated/README-ARABIC.md Outdated Show resolved Hide resolved
@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 26, 2021

@BatoolMM The problem is that we used div for setting the direction.
and as we know, divs take full space (Block elements). So we cant put the link beside it.
If we tried, It won't be a link.

Do you have any idea on how we can accomplish this?

@BatoolMM
Copy link
Member Author

When I completed the translation, I encountered the same problem with the div tag and the links. I also tried other methods besides the div tag to set the directions but none of them worked. It made me realise that it's challenging to use markdown with Arabic text. I think Arabic developers/programmers may need to develop better tools in the future. The best example I can find of a markdown translated to Arabic is this one https://github.com/firstcontributions/first-contributions You can change the language at the top (e.g. Saudi Arabia Flag) and see how they manged to translate it from the raw file. Stil, the turning way README.md file is a bit more complicated.

@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 26, 2021

@BatoolMM It works now :)
Just use <a href=""></a> inside the div.
when it comes to emails, do smth like that:
<a href="mailto:msharan@turing.ac.uk">msharan@turing.ac.uk</a>

Notice how Onion podcast is aligned now
https://github.com/alan-turing-institute/the-turing-way/blob/0811c12ecfbedb2b00913ca86a53454ced2e7aae/README-translated/README-ARABIC.md

@Hanaffi Hanaffi removed the book-dash-nov20 This is to be used on issues and PR during/for the book dash in Nov 2020 label Feb 26, 2021
@BatoolMM
Copy link
Member Author

Thank you @Hanaffi. I have used the <a> tag in a few places in the document. It worked in a few places, but it messed the direction of the words in some cases. I have experimented with a few combinations of tags so it could be me who is doing something wrong. It'll be great if you can test it on the rest of the links on the document. Importantly, the table of content, not sure if you can use the <a> tag here.

@Hanaffi
Copy link
Collaborator

Hanaffi commented Feb 26, 2021

Thank you @Hanaffi. I have used the <a> tag in a few places in the document. It worked in a few places, but it messed the direction of the words in some cases. I have experimented with a few combinations of tags so it could be me who is doing something wrong. It'll be great if you can test it on the rest of the links on the document. Importantly, the table of content, not sure if you can use the <a> tag here.

@BatoolMM Unfortunately, I have exams in the next week and I will finish in middle of March.
Maybe I won't be able to work on that until then. Maybe I can try to finish that when I have time.

@BatoolMM BatoolMM added the book-dash-nov20 This is to be used on issues and PR during/for the book dash in Nov 2020 label Feb 26, 2021
@Hanaffi
Copy link
Collaborator

Hanaffi commented Mar 5, 2021

@BatoolMM It works on https://stackedit.io/
However it doesnt work on github :(
(Try to copy the file and edit it on stackedit, You will find it working well)

@BatoolMM
Copy link
Member Author

BatoolMM commented Mar 6, 2021

Sorry, @Hanaffi I've just seen your comment. You are doing a good job, you can ignore the orientation and focus on the translation itself. It'll be nice to go through the Arabic translation itself and see if it can be improved. Thank you!

Copy link
Collaborator

@Hanaffi Hanaffi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine for me now.
@BatoolMM Can you work on the failed checks?

@BatoolMM
Copy link
Member Author

BatoolMM commented Mar 7, 2021

@Hanaffi, thank you for your work. I'll do the rest because it still needs lots of work and I totally understand that this PR is challenging, it shouldn't be approved even if the CI pass. Also, can you not approve or merge any PR unless it's been approved by a core contributor, please? You are very welcome to suggest improvement in this PR if you have the time.

@BatoolMM BatoolMM requested a review from Hanaffi March 7, 2021 23:08
@Hanaffi
Copy link
Collaborator

Hanaffi commented Mar 7, 2021

@BatoolMM Sorry, I have reviewed and approved some PRs as they were already approved by others.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
book-dash-nov20 This is to be used on issues and PR during/for the book dash in Nov 2020 PR: unreviewed translation Translating the book into other languages
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants