gbowne1 / reactsocialnetwork

Social Media website/app made with React 18 & MUI v5
GNU General Public License v3.0
33 stars 60 forks source link

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

Open gbowne1 opened 1 year ago

gbowne1 commented 1 year ago

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:

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.

martinyis commented 1 year ago

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

gbowne1 commented 1 year ago

Ok. I can assign anyone.

akshayamadhuri commented 1 year ago

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

gbowne1 commented 1 year ago

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

akshayamadhuri commented 1 year ago

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

gbowne1 commented 1 year ago

Yes and it would then become CONTRIBUTING.telugu.md

@akshaya-hub

akshayamadhuri commented 1 year ago

@gbowne1 sure

akshayamadhuri commented 1 year ago

@gbowne1 opened the PR please review it

LuckyTigerr commented 1 year ago

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

gbowne1 commented 1 year ago

Sure @LuckyTigerr

akshayamadhuri commented 1 year ago

@gbowne1 can i contribute to Punjabi and Bengali

gbowne1 commented 1 year ago

Yes you can @akshayamadhuri

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

DavidGomes77 commented 1 year ago

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

gbowne1 commented 1 year ago

Ok @DavidGomes77

laurittab commented 9 months ago

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