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.

Sign up for GitHub

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

Jump to bottom

[feature]: Developer documentation in other languages than English #235

Open
6 of 25 tasks
gbowne1 opened this issue Jun 1, 2023 · 15 comments
Open
6 of 25 tasks

[feature]: Developer documentation in other languages than English #235

gbowne1 opened this issue Jun 1, 2023 · 15 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request feature This should be a new feature. good first issue Good for newcomers help wanted Extra attention is needed high-priority low-complexity This is a low complexity or beginner issue
Milestone
Developer Documen...

Comments

@gbowne1
Copy link
Owner

gbowne1 commented Jun 1, 2023 •
edited
Loading

Is your feature request related to a problem? Please describe.

I think it would be a great idea to have a small collection of developer documentation in other languages than English.

A quick review of our stars, forks, etc. shows people mostly from India. So likely those primary and secondary/dialectical languages used in India should get translated first.

People could add/contribute their own as time goes on.

I would start with out CONTRIBUTING.md

Describe the solution you would like

The most helpful developer document we have is CONTRIBUTING.md in the /docs folder.
Translations could be done as CONTRIBUTING.(language).md such as CONTRIBUTING.hindi.md

Some languages could include:

  • Urdu
  • Hindi
  • Odia
  • Tamil
  • Gujarati
  • Duala
  • Maltese
  • Mandarin Chinese
  • Spanish
  • Arabic
  • Bengali
  • Portuguese
  • Russian
  • Japanese
  • Punjabi
  • French
  • German
  • Assamese
  • Tagalog
  • Berber
  • Kswahili / Swahili
  • Manipuri / Meitei
  • Malay
  • Telugu
  • Bangla

Describe the alternatives you have tried

Some popular projects do include developer documentation and some primary instructions and other documenation in other languages. This may reduce the barrier to entry for non native / ESL speakers.

After a quick review in Google Translate, this should be pretty easily done.

Additional context

Do not close this issue till most if not all of the languages have been added.
@gbowne1 gbowne1 added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers question Further information is requested a11y Issues with accessibity labels Jun 1, 2023
@gbowne1 gbowne1 added this to the Developer Documentation milestone Jun 1, 2023
@martinyis
Copy link
Contributor

Hey, it looks like an interesting issue. Could you assign it to me? I know personally Russian and Spanish

@gbowne1
Copy link
Owner Author

gbowne1 commented Jun 2, 2023

Ok. I can assign anyone.

@gbowne1 gbowne1 linked a pull request Jun 4, 2023 that will close this issue
Translating CONTRIBUTING.md into Hindi and Spanish #236
Merged
@akshayamadhuri
Copy link
Contributor

@gbowne1 can I work on this? i know personally Hindi, Telugu

@gbowne1
Copy link
Owner Author

gbowne1 commented Jun 4, 2023

@Akshaya-hub Hindi is in the current PR, but you can definitely add Telugu.

@akshayamadhuri
Copy link
Contributor

@gbowne1 should i need to translate only the contributing.md file to TELUGU

@gbowne1
Copy link
Owner Author

gbowne1 commented Jun 4, 2023

Yes and it would then become CONTRIBUTING.telugu.md

@Akshaya-hub

@akshayamadhuri
Copy link
Contributor

@gbowne1 sure

@gbowne1 gbowne1 removed a link to a pull request Jun 4, 2023
Translating CONTRIBUTING.md into Hindi and Spanish #236
Merged
@akshayamadhuri
Copy link
Contributor

@gbowne1 opened the PR please review it

@LuckyTigerr
Copy link
Contributor

@gbowne1, hello, can I make documentation in Russian?

@gbowne1
Copy link
Owner Author

gbowne1 commented Jun 5, 2023

Sure @LuckyTigerr

@LuckyTigerr LuckyTigerr mentioned this issue Jun 6, 2023
Merged
@akshayamadhuri
Copy link
Contributor

@gbowne1 can i contribute to Punjabi and Bengali

@gbowne1
Copy link
Owner Author

gbowne1 commented Jun 9, 2023

Yes you can @akshayamadhuri

The filenames would be CONTRIBUTING.punjabi.md and CONTRIBUTING.bengali.md

@DavidGomes77
Copy link

@gbowne1 Hey, I could do the Contributing for German, French and Portuguese. Just assign it to me.

@gbowne1
Copy link
Owner Author

gbowne1 commented Jun 23, 2023

Ok @DavidGomes77

@laurittab
Copy link

Hi all, I'll work on CONTRIBUTING.french.md as I haven't seen it added so far.

@laurittab laurittab mentioned this issue Dec 5, 2023
Merged
@gbowne1 gbowne1 removed bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers question Further information is requested a11y Issues with accessibity labels Feb 21, 2024
@gbowne1 gbowne1 added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers high-priority low-complexity This is a low complexity or beginner issue feature This should be a new feature. labels Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request feature This should be a new feature. good first issue Good for newcomers help wanted Extra attention is needed high-priority low-complexity This is a low complexity or beginner issue
Projects
Senior Social Dating Site
Status: Todo
Milestone
Developer Documentation
Development

No branches or pull requests
9 participants
@manuel12 @balajik @gbowne1 @laurittab @pawel975 @akshayamadhuri @LuckyTigerr @martinyis @DavidGomes77