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

Document Translation #120

Closed
20 of 41 tasks
nikogu opened this issue Nov 6, 2017 · 45 comments
Closed
20 of 41 tasks

Document Translation #120

nikogu opened this issue Nov 6, 2017 · 45 comments

Comments

@nikogu
Copy link
Contributor

nikogu commented Nov 6, 2017

We just finished most of translate jobs and published at pro.ant.design, welcome to visit it and review the translation. Give us PR if you find any typos. 🎅


Volunteer Wanted

Hey, guys! We are going to provide English documentation.

But we are short of staff :-( So, we want some volunteers to help us to translate antd's documentation into English. Every translation task needs a translator and a reviewer. Both of them are expected that they had used the component(AvatarLsit PageHeader etc...) in real world.

Translator

A translator should be familiar with both Chinese and English.

If you want to be a volunteer translator, just comment this issue. For example, "I want to be the translator of button and alert ....". And then, we will update this issue(e.g. button (translator: @afc163 , reviewer: @ddcat1115 )), and ping you.

Premise:

Contributing:

  1. Fork
  2. Create a branch starting at master and name it as translation-[xxx]
  3. npm install && npm start, see: Development
  4. Find Markdown files and the index.md and demo/*.md use different format, see: Internationalization of Ant Design website ant-design#1423
    • docs: under /docs
    • components: under /scaffold/src/components/xxx(xxx is the component which you need to translate)
  5. Just translate it, and you had better read our advice first.
  6. Create a pull request when your translation is done, and ping your reviewer.
    • docs: request to ant-design-pro-site:master
    • components: request to ant-design-pro:master
  7. PR will be merged, if your reviewer think it is OK.

See:

Reviewer

A reviewer should be a native English speaker.

If you want to be a volunteer reviewer, just comment this issue. For example, "I want to be the reviewer of button and alert...". And then, we will update this issue(e.g. button (translator: @afc163 , reviewer: @ddcat1115 )), and ping you.

After your corresponding translator finish his/her work, you should review and provide some advice.

Example

TODOs

/docs

/components

@gardner
Copy link

gardner commented Nov 6, 2017

Thanks for taking the time to translate the documentation!

This is really great. Our UX team brought Ant Design to us and asked if we could use this on a new project. The design and engineering decisions I have learned about across all of the ant design projects are amazing and I would love to use and participate but by ability to read or write Chinese is non-existent.

@afc163
Copy link
Member

afc163 commented Nov 7, 2017

@viztor
Copy link

viztor commented Nov 7, 2017

@afc163 thanks for mentioning me
I might want to take getting started.
ant-design/ant-design-pro-site#107

@viztor
Copy link

viztor commented Nov 9, 2017

review needed for getting-started.md:
@gardner In case you might want to lend a helping hand.

@gardner
Copy link

gardner commented Nov 10, 2017

@viztor all of the language was technically correct. I don't know how to describe it other than English with Chinese characteristics. There were a few things that were understandable but sounded non-native. I took a pass at updating it and submitted a PR here: ant-design/ant-design-pro-site#112

I don't understand Chinese but as a native Californian I am happy to help with translation however I can. :)

@gardner
Copy link

gardner commented Nov 10, 2017

The current way the docs are organized leaves a little to be desired. I am new to bisheng so I will read up on it and see if there is a way to modularize translations a bit better. I know some folks that may be able to help out with other languages.

@sundaisun
Copy link

Hi, just came across ant design pro, great work! I am a product designer on the Design System team at Eventbrite, based in San Francisco, and would like to help translating layout.md. Let me know :)

@viztor
Copy link

viztor commented Nov 11, 2017

@sundaisun Hi, already working on Layout.md, forgot to mention it here.
@nikogu also i18n.md and cli.md are ready for review.

@priezz
Copy link

priezz commented Nov 26, 2017

Hello! First of all, thanks for the great template!

This issue is about documentation translation, but I don't want to open the separate one for the template translation. I have written a short script to automatically translate the cloned template into English with Google. Here it is:

REGEXP='\p{Han}[\p{Han}|\s|,|。|,|\.|“|”|0-9|a-z|A-Z|-|-|:|:]*'; 
rg --color never "$REGEXP" -o --vimgrep src | sed -r "s|([^:]+):([^:]+):([^:]+):(.+)|STR='\4'; sed -i \"\2s/\$STR/\$\(trans --brief zh:en \\\"\$STR\\\"\)/\" $(pwd)/\1;|g" > /tmp/translate.sh;
rg --color never "$REGEXP" -o --vimgrep mock | sed -r "s|([^:]+):([^:]+):([^:]+):(.+)|STR='\4'; sed -i \"\2s/\$STR/\$\(trans --brief zh:en \\\"\$STR\\\"\)/\" $(pwd)/\1;|g" >> /tmp/translate.sh;
sh /tmp/translate.sh;

Dependencies: Translate Shell, ripgrep

macOS users should update to the GNU sed firtst:

brew install --with-default-names gnu-sed

The result is rather acceptable - translation is not ideal, of course, but at lease it enables Chinese non-speaker to start with.

Hope it helps to someone :)

Edit: translate within the commands changed to the more common trans.
Edit2: macOS instruction added.

@davidctj
Copy link

davidctj commented Dec 5, 2017

Hi, thanks for providing such amazing ant design pro!
I'm a frontend developer who has been using ant design a lot, love it!
I'd like to translate on faq.md && theme.md

@B1anker
Copy link

B1anker commented Dec 7, 2017

Can CET-6 have a try?

@chenshuai2144
Copy link
Collaborator

@B1anker Of course.
you can translate and then pr

@xueqingxiao
Copy link

I can take biz-icon.md, deploy.md, error.md, faq.md.

@bunshar
Copy link

bunshar commented Dec 11, 2017

I can help in making demos in english. In ant-design the demos have data in english and I can convert that within week if it's required.

@chenshuai2144
Copy link
Collaborator

@bunshar 当然需要了

@priezz
Copy link

priezz commented Dec 11, 2017

@bunshar, my script above translates demo data. For me it seems that it could be too early for the fine tuned manual translation as the product is still in active development stage. However, I could be wrong :)

@lorecrafting
Copy link

lorecrafting commented Dec 11, 2017

Hello, I would like to help with translation. Are you folks trying to get all the documentation translation done by the time Ant Pro 1.0 is released?

Also i'm currently translating the Ant Pro component data, and also mock data so that the Dashboard can be displayed in English. Should I put the translation of mock data and ant pro sample components in a new 'english' branch?
@nikogu

Thanks!

Edit: Oops didn't see the awesome work that @priezz did with the script. Don't want to do double duty with the demo translations since @bunshar said he could do it, so i'll wait for further coordination.

@lorecrafting
Copy link

lorecrafting commented Dec 12, 2017

I will start translating components in the ant-design-pro repo, going to start with Charts!

Edit: Just created a PR for translated Charts components. Would like a review, thanks!

Edit: I was also wondering, does the release of Ant Design Pro 1.0 have a hard dependency on translating docs to English? Or would it be possible that Ant Pro 1.0 gets released first, and Pull Requests for translations can come in later? Thanks!

@bunshar
Copy link

bunshar commented Dec 13, 2017

Nice script @priezz !
Needed some changes to get it to run in Mac so sharing that

Translate script for mac users as sed in mac is not same as sed in gnu

install with - brew install --with-default-names gnu-sed
and then use that. Also the translate doesn't work but trans does

REGEXP='\p{Han}[\p{Han}|\s|,|。|,|\.|“|”|0-9|a-z|A-Z|-|-|:|:]*'; 
rg --color never "$REGEXP" -o --vimgrep src | gsed -r "s|([^:]+):([^:]+):([^:]+):(.+)|STR='\4'; gsed -i \"\2s/\$STR/\$\(trans --brief zh:en \\\"\$STR\\\"\)/\" $(pwd)/\1;|g" > /tmp/translate.sh;
rg --color never "$REGEXP" -o --vimgrep mock | gsed -r "s|([^:]+):([^:]+):([^:]+):(.+)|STR='\4'; gsed -i \"\2s/\$STR/\$\(trans --brief zh:en \\\"\$STR\\\"\)/\" $(pwd)/\1;|g" >> /tmp/translate.sh;
sh /tmp/translate.sh;

@priezz
Copy link

priezz commented Dec 13, 2017

@bunshar, thank you for your addition! You are right, unfortunately mac's sed is not gnu-compatible.
However, with --with-default-names option, you have provided, brew installs sed without g in the front. So the script stays unchanged. I also update translate to trans in the initial script as it is their recommended command name.

@bunshar
Copy link

bunshar commented Dec 13, 2017

The issue is that this breaks my ability to keep the repo in sync as there are so many changes.

I think this is the right time to start translation. The script is a good starting point and will save quite a lot of effort.

@ddcat1115
Copy link
Contributor

@lorecrafting The Ant Design Pro 1.0 do not rely on the translation work, and only some of the guide docs may be changed after the 1.0 release. As for components, you can start your translation at anytime 😃

@ddcat1115 ddcat1115 mentioned this issue Dec 26, 2017
@ZoeVonFeng
Copy link

ZoeVonFeng commented Jan 4, 2018

I can help on " use-components-alone.md" translation if it is not taken yet. And thank you for the great framework!
Update: I already finished and created a pull request since it was a short page. It is open for review.

@atav32
Copy link

atav32 commented Mar 28, 2018

Sign me up. I'll help translate.

@meluo
Copy link

meluo commented May 16, 2018

Module build failed: Error: Cannot use decorators and decorators2 plugin together

@sroze
Copy link

sroze commented May 25, 2018

Thank you all for your translation efforts. This seems to be a very nice set of UI elements ❤️

@zhuzisheng
Copy link

I can help translate the login part into English.

@maria-le
Copy link

Google Translate does a pretty good job doesn't it? Why not just use that?

@chloesun
Copy link

chloesun commented Feb 5, 2019

I can help with some translation as well, feel free to reach out and let me know what pieces I can work on!

@robsonsilv4
Copy link
Contributor

I added README in portuguese (pt-BR), see #5438.
And i will also help to translate documentation to portuguese.

@BoyoJustice
Copy link

I would be happy to be a reviewer of "router-and-nav.md" if still available.

@cyw1361546576
Copy link

cyw1361546576 commented Dec 14, 2019 via email

@nelsonacalves
Copy link

nelsonacalves commented Aug 14, 2020

We just finished most of translate jobs and published at pro.ant.design, welcome to visit it and review the translation. Give us PR if you find any typos. 🎅

Volunteer Wanted

Hey, guys! We are going to provide English documentation.

So,
How can i help translate?
what work is available?

dengli1216 pushed a commit to myForkProject/ant-design-pro that referenced this issue Mar 17, 2021
Update src/components/users/modal.js
@semezzato
Copy link

I'm a brazilian developer and I want to join this.
I want to help translate it, but in portuguese, we have a large dev market in ascension here.
By the way, it will be a nice contribution for all.

@Yoann-Paquet
Copy link

Hello when are you going to translate Ant Design into French?

@qq6690876
Copy link

I’m a product manager and I want to help translate it.
I'd like to translate on Result

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

No branches or pull requests