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

🎉 Outreachy spring 2022: Applicants tasks/contributions #1

Closed
BatoolMM opened this issue Mar 21, 2022 · 73 comments
Closed

🎉 Outreachy spring 2022: Applicants tasks/contributions #1

BatoolMM opened this issue Mar 21, 2022 · 73 comments
Labels

Comments

@BatoolMM
Copy link
Member

BatoolMM commented Mar 21, 2022

🎊 Welcome Outreachy 2022 Contributors! We're excited that you're here 🎉

This ticket will serve as the central point tracking the contributions of perspective Outreachy (spring 2022 cohort) applicants.

Outreachy provides paid remote, three-month internships to support diversity in Free and Open Source Software (FOSS). For more information about what Outreachy is, follow this link.

Outreachy internships are:

💵 Paid - $7,000 USD total internship stipend

🌍 Remote - both interns and mentors work remotely

🕰 3 months - internships run May to August.

For those interested, this process is described here.

We ask all outreachy candidates to work on a minimum of 3 projects simultaneously so that they are not completely relying on their selection in OSCSA if we end up not selecting them!

Summary

Open Science Community Saudi Arabia (OSCSA) aims to introduce open educational resources (OERs) for Open Science in Arabic to facilitate learning of Open science practices to novice learners. Therefore, we work with other Open Science communities such as the Turing Way and Open Life Science to localise their open educational resources (OER) using Crowdin, GitHub and Zenodo.

We use GitHub as a version control system for all the translations and to acknowledge all contributors. Crowdin is used as a translation management system (or TMS) to make contributions smooth. Any changes made to Crowdin will be reflected on GitHub using automation and continuous integration (CI). Crowdin provides Translation Memory (TM), Glossary, Machine Translation (MT) and QA checks.

In Outreachy spring 2022, we are accepting applicants to localise specific chapters of The Turing Way. The Turing Way is a handbook to reproducible, ethical and collaborative data science. It supports a diverse community of contributors to make data science accessible, comprehensible and effective for everyone. You can find more information about it, in the TW repository.

Successful candidates will improve the localisation process by adding documentation in Arabic, enriching the glossary, moderating the translation, using screenshots to improve the translation and collecting feedback.

How to start?

  • Join OSCSA community here

  • You will need to create an account in Crowdin and join our project here. Once you join, you have to comment on this issue, so we follow your work in Crowdin.

  • Navigate to the Project home and click on Arabic

Screenshot 2022-03-28 at 19 55 05

  • Once you click on Arabic, you will be directed to this window which contains all the files that are inside the Turing Way book

Screenshot 2022-03-28 at 19 55 26

  • Scroll down until you reach reproducibale_reserach and then to open . Translate one the topics in this task in Crowdin.

Screenshot 2022-03-28 at 20 02 34

  • Choose any of the markdown files inside and click on three dots (⋮) select Go to editor

Screenshot 2022-03-28 at 20 04 03

  • This way, it will open the crowdin editor where you will so all the translations! All the translation was done using crowdin machine translation (similar to google translation). None of it was done manually, so all the translation needs to be re-translated and then proofread (Approved). Chose only one single file and read it from the TW book before starting the translation - and start from the top of the file (title).

Screenshot 2022-03-28 at 19 57 07

  • Follow up the steps of how to use Crowdin Editor here.

Using the Main menu in the top left corner, you can switch between files for translations, change translation language, contact manager, switch the view, get help or quit the editor. For more information, follow the docs here. If you have questions, please add them to this issue!

You need only to translate one small file with no more than 300 words. You don't only translate strings, but you also have to add terms to the glossary.

Glossary

The Glossary is supposed to contain terminology that has a purpose of explaining some specific terms or the ones often used in the project to be translated properly and consistently such as (e.g. open science, open access, open hardware, ...etc). It's not supposed to include names of people, books, ...etc.

You should add a specific term add to the glossary if:
1- It's commonly used in the project, but translators can translate it differently. For example, open access can be translated الوصول الحر أو الوصول المفتوح أو النفاذ الحر but we want to keep consistency throughout the project when it's translated by many contributors - so they can use the same translation, not multiple ones.
2- Some English terminology doesn't exist in Arabic. Once you translate them, you include them in Glossary (e.g. Git, GitHub, repository,..etc).

The Glossary should be consistent in style. The Arabic translation should contain the Arabic translation followed on the left the English terms between brackets with spaces between brackets. For example, the Arabic for Open access should be (Open Access) الوصول الحر with space between brackets and the Arabic word.

If you have questions about the glossary،, ask under this issue.

Submission

Once you finish a very small part of the translation, submit a PR for a markdown file called NAME_docs.md in /docs in this repo to include brief documentation in Arabic ( around 500 words or more using Markdown) about the translation process of the project in Crowdin. This should include (Getting started with Crowdin, tips, ..etc) using images and GIFs.

If you have any questions throughout the process, add your question to this issue!

Tasks for Intern Selection:

Tasks during the internship

  • Expands the Glossary and ensure consistency in the Translation
  • Collect feedback from the community members about the translation workflow.
  • Translate 6 parts/sub-chapters from the Guide for Reproducible Research.
  • Review other contributions in the Translation
  • Deploy the book with the 6 translated chapters
  • Provide documentation about the Workflow in Arabic.

Meetings

We will lead a video call in Elements to answer any questions you have. This could be a problem using Crowdin editor or understanding any of the tasks in the internship. This will be on Friday, the 1st of April at 10 am UTC. Follow this link for invitation to Element!

Assessing Candidates

  • Candidate should be comfortable collaborating through GitHub
  • Candidates should complete all tasks listed for intern selection.

Resources

@BatoolMM BatoolMM added good first issue Good for newcomers Outreachy labels Mar 21, 2022
@oluwaseunlijoka
Copy link

Hello everyone, My name is Oluwaseun, I just joined Crowdin.

@BatoolMM
Copy link
Member Author

Hi @oluwaseunlijoka, you should be able to join the project through this link: https://turingway.crowdin.com/u/signup?hash=3d0624a322db57a403a7ece3ccce900a24.

Let me know if you have a problem accessing it!

@oluwaseunlijoka
Copy link

Hello @BatoolMM, Thank you, I just joined now. I guess you are mentor now. Please can lead me through how I can start, I am from https://www.outreachy.org/. Thank you

@BatoolMM
Copy link
Member Author

@oluwaseunlijoka I added a few screenshots and details - let me know here if you struggle with anything!

@ThanaMeri
Copy link
Contributor

Hello @BatoolMM , my name is Thana. I just joined the project by following the link you provided.

@BatoolMM
Copy link
Member Author

Hi, Thana - you've been added to Crowdin, feel free to follow the steps and let me know if you have any questions!

@ahmedEid1
Copy link

Hello @BatoolMM, I am Ahmed an engineering student from Egypt, and an outreachy applicant for this spring.
I am very existed to help increase the science martials available in Arabic to make learning and getting into the science field easier for any Arabic speaker.

@ahmedEid1
Copy link

you have to comment on this issue, so we can promote you to Manager in Crowdin.

I just joined the project, do i have to wait to be a manger before starting to contribute ?

@BatoolMM
Copy link
Member Author

Hi Ahmed, thank you for joining - you don't have to wait, you should be able to use Crowdin now. Let me know if you have any questions about crowdin.

@Nizahra2038
Copy link

Hi @BatoolMM my name is Fatima I am oureachy applicant I have joined the crowdin what next

@nancyalaswad90
Copy link
Contributor

nancyalaswad90 commented Mar 29, 2022

.

hi @BatoolMM

I added issue here ,please review and advice

@AsmaKacem1
Copy link
Member

Hello @BatoolMM , My name is Asma. I'm from Tunisia it's a small country in the north of Africa. I'm a Telecommunication engineering student and an Outreachy applicant. I am
excited to be contributing to this project because I love my native language Arabic and make it easier for the Arabic speaker to learn. I just joined the project by following the link you provided.

@BatoolMM
Copy link
Member Author

BatoolMM commented Mar 29, 2022

Hi @AsmaKacem1 @nancyalaswad90 @Nizahra2038, thank you for joining - please follow the steps in this issue - if any of you have any questions, please add them here under this issue (don't open a new issue). Here is more info on how to use Crowdin Editor.

@Boutainaelatbaoui
Copy link
Contributor

Hello @BatoolMM, I am Boutaina from Morocco. I am an outreachy applicant. I have joined crowdin, and I am super excited to contribute to your organization and be a part of your community.

@BatoolMM
Copy link
Member Author

BatoolMM commented Mar 29, 2022

Hi Boutaina! Let me know if you struggle with anything in Crowdin.

@BatoolMM
Copy link
Member Author

BatoolMM commented Mar 29, 2022

We will hold a video call in Elements to answer any questions you have. This could be a problem using Crowdin editor or understanding any of the tasks in the internship. This will be on Friday, the 1st of April at 10 am UTC. Follow this link for invitation to Element!

@Boutainaelatbaoui
Copy link
Contributor

Hi Boutaina! Let me know if you struggle with anything in Crowdin.

I'm trying to click on 'go to the editor', but I can't find it. Could you please help me?

outreachy

@amj1337
Copy link
Contributor

amj1337 commented Mar 29, 2022

Hi @BatoolMM , I'm Alaa, an aspiring Outreachy intern, looking forward to be working with you.

@BatoolMM
Copy link
Member Author

Thank you @Boutainaelatbaoui for the question. If Go to editor isn't visible, choose Proofreading and you will end up with something similar to this screenshot.

Screenshot 2022-03-29 at 20 08 29

You’ll see the list of source strings and their translations that you can approve or correct. The strings with the QA checks issues will be highlighted in this mode. You’ll also see the strings that were translated with the help of Translation Memory or Machine Translation engine. You can still change the complete translation. Let me know if this works for you!

Hi @amj1337, you are welcome to go through the steps and post your questions here!

@BatoolMM
Copy link
Member Author

All individuals who commented on this issue are granted Manager access so they can get access to all features of the Crowdin editor! Let me know if you still don't see Go to editor option.

@nancyalaswad90
Copy link
Contributor

.
Thanks for your explanation above @BatoolMM

I made some script , will you please give your opinion about it

.

@AsmaKacem1
Copy link
Member

Hello,
me too I made some script, could you please verify if there is something I can improve @BatoolMM .

Could you please explain to us about the video of OLS2 and OLS1?

@BatoolMM
Copy link
Member Author

BatoolMM commented Mar 30, 2022

Thank you @AsmaKacem1 for adding the translation. Please work in one single markdown file and completely finish it before moving to another file. Can you kindly focus on translatingopen-hardware.md which you started working on?

I see that you also added a few terms to the Glossary. That's really good - but some terms like def are repeated with two different meanings. If you are adding the English word between brackets, please keep space between the bracket and the word - e.g. GitHub : (GitHub) منصة جيت هب - not (GitHub)جيتهاب. With space between brackets and the word.

Once you complete a file or a couple of paragraphs from the same file, I'll add comments in Crowdin for you (like below).

Screenshot 2022-03-31 at 01 22 51

@nancyalaswad90 Your translation is good, I added some comments on Crowdin - please go through them. You should be able to access the comments tab in Crowdin similar to the screenshot above (on the right)!

Let me know if you have any questions!

@nancyalaswad90
Copy link
Contributor

Thanks @BatoolMM for your feedback

I will do the update and send you

@AsmaKacem1
Copy link
Member

Thank you @BatoolMM . I took these notes and I will do the necessary change you mentioned.

@nancyalaswad90
Copy link
Contributor

Thanks @BatoolMM for your explanation comments

Just finished some updates in my translation and added a few terms to the Glossary. , will you please give your opinion about it.

@BatoolMM
Copy link
Member Author

BatoolMM commented Mar 31, 2022

In terms of the glossary. The Glossary is supposed to contain terminology that has a purpose of explaining some specific terms or the ones often used in the project to be translated consistently and adequately, such as (e.g. open science, open access, open hardware, ...etc). It's not supposed to include names of initiatives.

There are some issues in the Glossay below:

Screenshot 2022-03-31 at 16 00 13

  • All terms should have been filled in the 1st column (English) since the book is written in English but GitHub isn't filled in the 1st column.
  • It's not consistent in style. The Arabic translation should contain the Arabic translation followed on the left the English terms between brackets with spaces between brackets. For example, the Arabic for Open access should be (Open Access) الوصول الحر with space between brackets and the Arabic word.
  • Budapest open access initiative, def, open by default, isn't supposed to be on the Glossary.
  • Please make sure the style of the Glossay is consistent.

@amj1337
Copy link
Contributor

amj1337 commented Apr 2, 2022

Hi @BatoolMM when reading the book I came across words that look similar in their general meaning like "Reproducible" and "Replicable" but they were defined to have different meanings in the book, is it right for those words to be added to the Glossary with their definitions from the Turing way book itself ? even thought they are not defined in the file that I chose to translate but some of them are used in it.

@BatoolMM
Copy link
Member Author

BatoolMM commented Apr 2, 2022

Thank you @amj1337 for this question

when reading the book I came across words that look similar in their general meaning like "Reproducible" and "Replicable" but they were defined to have different meanings in the book, is it right for those words to be added to the Glossary with their definitions from the Turing way book itself? even though they are not defined in the file that I chose to translate but some of them are used in it.

Absolutely!

@nancyalaswad90
Copy link
Contributor

Dear @BatoolMM

Please advise , what should I do now ? and what is the assessment for my previous updates ?

@BatoolMM
Copy link
Member Author

BatoolMM commented Apr 3, 2022

Dear @BatoolMM

Please advise , what should I do now ? and what is the assessment for my previous updates ?

Done!

@nancyalaswad90
Copy link
Contributor

@BatoolMM Thank you for your quick feedback

I made some changes , I wish you provide me with your feedback

@AsmaKacem1
Copy link
Member

Hi @BatoolMM , I have finished the open-hardware.md
could you please give me your opinion about it?

@ThanaMeri
Copy link
Contributor

Marhba. @BatoolMM I did some translations so far. it would be great if you give me a feedback

@nancyalaswad90
Copy link
Contributor

Hi @BatoolMM , I have finished the open-access.md

I wish you provide me with your feedback

@BatoolMM
Copy link
Member Author

BatoolMM commented Apr 5, 2022

@nancyalaswad90 @AsmaKacem1 @ThanaMeri I added feedback to all of you in Crowdin - the next round of feedback will be given by the 9th of April.

@BatoolMM
Copy link
Member Author

BatoolMM commented Apr 5, 2022

@ThanaMeri - there are comments, just checked them now and tagged you. Let me know if you couldn't find them!

@nancyalaswad90
Copy link
Contributor

Hi @BatoolMM , I have finished the open-access.md

Please provide me with your feedback

@amj1337
Copy link
Contributor

amj1337 commented Apr 11, 2022

Good evening @BatoolMM , if available , would you please check my translation of the overview-barriers.md file and provide me with feedback on what is approved and what needs rectification.

@BatoolMM
Copy link
Member Author

@amj1337 @nancyalaswad90 I went through the translation and added a few comments. Please feel free to start the 2nd part by submitting a PR. I updated the instructions (above). If you have any questions, please let me know!

@aleesteele
Copy link

Hi, everyone! I just wanted to introduce myself in this issue, and say hello 👋! I'm Anne Lee Steele (@aleesteele), the Community Manager of The Turing Way. Together with @malvikasharan and @KirstieJane (who are co-leads of the project), we just wanted to say that we're so excited to follow the work you're doing with The Turing Way and with the amazing @BatoolMM! Translation is such important work that extends far beyond The Turing Way alone (as you all are well aware of - much moreso than me!)... and has much broader effects in the wider open source and open science communities. Best of luck with the application process, and if you have any questions about the project more broadly, please feel free to send me a message at asteele@turing.ac.uk. Congratulations again to you all! 🎉 🎉 🎉

@BatoolMM
Copy link
Member Author

Thank you @aleesteele for introducing yourself, that's very thoughtful of you 🌷 .

I'd encourage everyone who has contributed so far in Crowdin to record their contribution in Outreachy regardless if they completed their PRs or not. If you have any questions about how to record your contribution, please feel free to ask!

@nancyalaswad90
Copy link
Contributor

nancyalaswad90 commented Apr 14, 2022

Glad to know you @aleesteele 🌷 .

Hi @BatoolMM , really grateful for your support and here is my work in previous two days

  • I check your comments and made changes to the open-access.md file.

  • I just submitting a PR .

  • And Finally add contribution in Outreachy.
    .

image
.

Please provide me with your feedback

.

@BatoolMM
Copy link
Member Author

Thank you to everyone who submitted a PR so far 🎉🎉 - Feedback is provided for PR #4 #5 #6!

@nancyalaswad90
Copy link
Contributor

nancyalaswad90 commented Apr 15, 2022

Hi @BatoolMM

I approved all the suggestions feedback and made the required change .

.

Thanks for your guidance , please review.

.

@BatoolMM
Copy link
Member Author

All PRs are merged, please don't forget to submit your final contribution through Outreachy.

We have many strong candidates but we'll only take one intern so we would like to remind you to work on a minimum of 2-3 projects simultaneously so that they are not completely relying on their selection in OSCSA if we end up not selecting them!

If you have any questions, please feel free to ask!

@ThanaMeri
Copy link
Contributor

ThanaMeri commented Apr 17, 2022

@BatoolMM Do I still have time to post my PR ? I thought the deadline is April 22 ?

@BatoolMM
Copy link
Member Author

@ThanaMeri of course, you are very welcome to submit your PR, the deadline is the 22nd of April!

@ThanaMeri
Copy link
Contributor

@BatoolMM will you please give me a feedback on my PR ?

@BatoolMM BatoolMM mentioned this issue Apr 19, 2022
@BatoolMM
Copy link
Member Author

All PRs are merged, and our newsletter mentions all your wonderful contributions. You can view the newsletter here. Please don't forget to record your final contributions in Outreachy. If you have any questions, don't hesitate to reach out!

@nancyalaswad90
Copy link
Contributor

All PRs are merged, and our newsletter mentions all your wonderful contributions. You can view the newsletter here. Please don't forget to record your final contributions in Outreachy. If you have any questions, don't hesitate to reach out!
.

Thanks for your time and support @BatoolMM 🌺🌺
.

@amj1337
Copy link
Contributor

amj1337 commented Apr 21, 2022

Hi @BatoolMM I have just sent my PR, when available would you please check it out, thank you.

@BatoolMM
Copy link
Member Author

Thank you for submitting PR #8 - please go through the comments I added!

@BatoolMM
Copy link
Member Author

BatoolMM commented Oct 6, 2022

The intership has ended and this issue will be closed!

@BatoolMM BatoolMM closed this as completed Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

10 participants