Ant-design: Document Translation

Created on 21 Apr 2016  ·  138Comments  ·  Source: ant-design/ant-design

We just finished most of translate jobs and published at beta.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(Affix Alert 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: @benjycui, reviewer: @waywardmonkeys )), and ping you.

Contributing:

  1. Fork ant-design and git clone
  2. Create a branch starting at master and name it as translation-button
  3. npm install && npm start, see: Development
  4. Find Markdown files under components/xxx(xxx is the component which you need to translate), index.md and demo/*.md use different format, see: https://github.com/ant-design/ant-design/issues/1423
  5. Just translate it, and you had better read our advice first.
  6. Create a pull request to ant-design:master when your translation is done, and ping your reviewer.
  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: @benjycui, reviewer: @waywardmonkeys )), and ping you.

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

Example: #1932

TODOs

/docs/react

  • [x] getting-started.md (translator: @benjycui, reviewer: )
  • [x] introduce.md (translator: @benjycui, reviewer: )
  • [x] install.md(had been translated into English, but it's outdated). (translator: @benjycui, reviewer: )
  • CHANGELOG.md and upgrade-notes.md won't be translated, but we will provide English edition while releasing next version.

/components

  • [x] affix (translator: @afc163 , reviewer: )
  • [x] alert (translator: @afc163 , reviewer: )
  • [x] badge (translator: @afc163 , reviewer: )
  • [x] backtop (translator: @ddcat1115 , reviewer: )
  • [x] breadcrumb (translator: @forthedamn , reviewer: )
  • [x] button (translator: @benjycui, reviewer: @waywardmonkeys )
  • [x] calendar (translator: @forthedamn, reviewer: )
  • [x] card (translator: @superRaytin, reviewer: )
  • [x] carousel (translator: @superRaytin, reviewer: )
  • [x] cascader (translator: @superRaytin, reviewer: )
  • [x] checkbox (translator: @benjycui, reviewer: )
  • [x] collapse (translator: @ddcat1115, reviewer: )
  • [x] date-picker (translator: @ddcat1115, reviewer: )
  • [x] dropdown (translator: @ddcat1115, reviewer: )
  • [x] form (translator: @GrayChoi, reviewer: )
  • [x] icon (translator: @ryangun, reviewer: )
  • [x] input (translator: @visvadw, reviewer: )
  • [x] input-number (translator: @ryangun, reviewer: @visvadw)
  • [x] layout (translator: @forthedamn , reviewer: )
  • [x] locale-provider (translator: @ddcat1115, reviewer: )
  • [x] menu (translator: @wenshiqi0: reviewer: )
  • [x] message (translator: @u9lyfish, reviewer: )
  • [x] modal (translator: @GrayChoi, reviewer: )
  • [x] notification (translator: @GrayChoi, reviewer: )
  • [x] pagination (translator: @ddcat1115, reviewer: )
  • [x] popconfirm (translator: @wenshiqi0: reviewer: )
  • [x] popover (translator: @wenshiqi0: reviewer: )
  • [x] progress (translator: @ddcat1115, reviewer: )
  • queue-anim will be moved to Ant Motion
  • [x] radio (translator: @qiuyuntao, reviewer: )
  • [x] rate (translator: @qiuyuntao, reviewer: )
  • [x] select (translator: @RaoHai , reviewer: )
  • [x] slider (translator: @RaoHai , reviewer: )
  • [x] spin (translator: @RaoHai , reviewer: )
  • [x] steps (translator: @ddcat1115 , reviewer: )
  • [x] switch (translator: @ddcat1115 , reviewer: )
  • [x] table (translator: @afc163 , reviewer: @manV)
  • [x] tabs (translator: @xueqingxiao, reviewer: )
  • [x] tag (translator: @xueqingxiao, reviewer: )
  • [x] time-picker (translator: @liqi07, reviewer: )
  • [x] timeline (translator: @liqi07, reviewer: )
  • [x] tooltip (translator: @liqi07, reviewer: )
  • [x] transfer (translator: @liqi07, reviewer: )
  • [x] tree (translator: @GrayChoi, reviewer: )
  • [x] tree-select (translator: @ddcat1115 , reviewer: )
  • [x] upload (translator: @hellowenqi , reviewer: )
  • [x] validation

/docs/spec

🕙 Plan

Most helpful comment

Maybe a beta.ant.design?

All 138 comments

install.md should be updated.

Glossary

何时使用 => When To Use

属性 => property

// working on it

Example Sentence

// working on it

i can help with russian :) not english native :(

I can help reviewing table

@manV updated and thanks!

You can review more translation tasks, if you have time :-)

@plandem antd only provide Chinese and English documentation, sorry and thanks.

@benjycui sure I can help reviewing other translations as well, please mention me whenever you need :+1:

I do not know Chinese but I wish I could help translating the components as well

Affix, Alert, Badge. I will translate these component.

Select, Slider, Spin.

rate, radio

@afc163 @RaoHai @qiuyuntao updated and thanks!

http://echojs.com/ 上发一个引关注。

calendar

@forthedamn updated and thanks!

Card, Carousel, Cascader, Checkbox

@superRaytin updated and thanks!

This is great work guys! I can help review the translations wherever you need, so just mention me in the issue where you see fit.

date-picker
dropdown

@ddcat1115 updated and thanks!

breadcrumb

各位翻译的时候尽量不要从中文直译,按语义重新组织语言。

@forthedamn updated and thanks!

message

@u9lyfish updated and thanks!

@benjycui demo 代码中的中文如何处理?是直接替换为英文翻译,还是也分为两份代码?

How should I deal with Chinese texts within code snippets in /demo? Should I replace them with English versions, or split the code snippet into two?

共享一份代码,代码中的中文改为英文,see:https://github.com/ant-design/ant-design/blob/master/components/button/demo/basic.md

@u9lyfish

col

@forthedamn Layout is Assigned to u (col and row included)

backtop & collapse , already marked

timeline

@liqi07 thanks and updated : )

tabs, tag

@xueqingxiao updated and thanks!

@benjycui NP. I think, we'd better rename 'index.md' to 'README.md'.

rename 'index.md' to 'README.md'.

After we provide english documentation, index.md will be split into index.zh-CN.md and index.en-US.md.

So rename them into README.zh-CN.md && README.en-US.md is meaningless.....

I can help with translating tree component.

@GrayChoi update and thanks.

Updated

I want to be the translator of icon, input and input-number.

@ryangun thanks and updated!

@benjycui Oh...Where are the Chinese documentations of input?

Find Markdown files under components/xxx(xxx is the component which you need to translate), index.md and demo/*.md use different format, see: #1423

@ryangun please read the first comment of this issue: https://github.com/ant-design/ant-design/issues/1471#issue-149981757

@benjycui I delete the repository and fork again, then all is ok.

I'll take menu, popconfirm and popover

@wenshiqi0 updated and thanks!

I can help with translating form, modal, notification.

@GrayChoi updated and thanks!

I am a bad guy. 😅

time-picker
tooltip
transfer

@liqi07 :+1:

I want to be the translator of upload

@hellowenqi updated and thanks!

Two errors occur after running 'npm install && npm run ' on windows platform

1. cannot load path properly. I solved this problem by editing path directly in file bisheng

image

2. the second problem is it cannot load file data.js which is empty. Is it a problem of bisheng or a problem of dora ?

This is a wonderful design and implementation 👍 and I want to contribute.
Let me first start with the translation and review of tree-select.

I have noticed that the translation is assigned to @ddcat1115 (tree-select (translator: @ddcat1115 , reviewer: )), but he did not start yet.

Besides this, I can do the review of other components, so I will let you pick up something. 😃

@visvadw you can review those translations in master now, and you can create a PR if you want to improve any of them.

@visvadw You can review the TreeSelect now 😸

2582

I am translating Table now.

I want to review the translation of Input and InputNumber.
Please include me in the first message of this issue as it helps me keeping track of what to do.
For now, as I remember 😄, I reviewed completed or partially the Form, TreeSelect, and Transfer.

@visvadw updated and thanks!

Hi there, I can help reviewing some of the docs. Kindly let me know priorities

@oeddyo https://github.com/ant-design/ant-design/issues/1471#issuecomment-236472039

We are going to finish all the translation tasks before 20th Aug. So there is no priorities now. And you can review the master which we had translated, the directory structure refer: https://github.com/ant-design/ant-design/issues/1471#issue-149981757

Thanks!

Tasks updated.

Hello, I want to be the translator of button and alert. I am a developer in a foreign company, we decide to use react this year. we have daily meeting with foreign colleagues. Though my English is not that good, but I'd like to commit contribution.

@jillyan Button and Alert had been translated. But, you can review any docs if it had been translated and create a PR if you have any idea to improve those docs.

@ryangun Did you finish any translation (of Icon, Input or InputNumber)? If not, I may start the translation of Input, at least.

@visvadw I'm sorry about that. I haven't even started the translation of Input yet, so you can just do it, thank you for your help!

I can review more now.

Kindly let me know what's on going :)

@oeddyo you can review any docs if it had been translated and create a PR if you have any idea to improve those docs, thanks 😄

@xueqingxiao @hellowenqi if you have no time, I am going to finish your tasks, OK?

I`m sorry I have not finished the task yet. I can finish the task in two days. @benjycui

@benjycui in progress.

It seems that the following tasks haven't been translated...

  • input
  • tag
  • Home Page and Footer

@benjycui I will finish tag in this weekend.

@benjycui Input is my todo for tomorrow.

@benjycui I am done with the translation of Input component. See PR 2789.

For the next 10 days I will be on vacation and the access to email/Internet may be limited.

It looks like that the Internet access is pretty good. Therefore, I could do other reviews, if needed.

Well done!
Is there any plan for release date?

It seems all done except some reviews. Could we have a beta doc version at this time and complet the review later? I can't wait to introduce antd to my teammates!

I agree. To have it uploaded, even as a beta, may bring faster and better feedback of reviews.

Maybe a beta.ant.design?

Updated.

@afc163 I can help to translate resource.

@afc163 I will translate and review docs/practice.

@xueqingxiao @visvadw updated and thanks!

@nie-xin @kvetoslavnovak [email protected] and it's documentation are published.

If anyone want to improve those documentation, just click the following button and edit on GitHub:

image

@benjycui Great! I will help as much as I can!

@benjycui Great! But the API doc seems still Chinese simplified.

But the API doc seems still Chinese simplified.

It should be Ok now... My bad.

PR 2998 is the translation (and review) of docs/practice section. I hope it is accurate.

Generally looks fine to me.

Some issues:
Localisation

In Code Text

Should I propose each translation edit as PR?
Should comments go here or https://github.com/ant-design/ant-design/pull/2998 ?

@kvetoslavnovak Comments should be here, as this is the main thread of discussion about translation topic. Yes, each translation can be part of a PR, it this works for you.

@afc163 I've noticed that although (at least some of the) demos contains Chinese content, the source it is all English. Example: Button icon demo and its source.

@visvadw @afc163 this buttun icon example source was corrected just few hours ago because of my PR https://github.com/ant-design/ant-design/pull/3000 so there is no confusion

@kvetoslavnovak Now that some of the items from the list has been translated or they are about to be (PRs are open), so the list needs to be updated.

I will try to keep the list updated.

@visvadw @kvetoslavnovak PRs were merged and beta.ant.design was updated.

D:antdemo\blog>atool-build
module.js:327
throw err;
^

Error: Cannot find module 'atool-build/lib/webpack'
at Function.Module._resolveFilename (module.js:325:15)
at Function.Module._load (module.js:276:25)
at Module.require (module.js:353:17)
at require (internal/module.js:12:17)
at Object. (D:antdemo\blog\webpack.config.js:4:17)
at Module._compile (module.js:409:26)
at Object.Module._extensions..js (module.js:416:10)
at Module.load (module.js:343:32)
at Function.Module._load (module.js:300:12)
at Module.require (module.js:353:17)
at require (internal/module.js:12:17)
can you tell me what's the reason of this? and can i solve it?

@benjycui @afc163 is there anyone trying to translate pattern, changelog, upgrade guide, feature and so on?

Pattern will be updated in this month, so it's meaningless to translate it right now.

Change log and upgrade guide are useless for foreigners for most of them are new comers(OK, some had use antd for a long time..). And we will provide English change log in next version.

Change log and upgrade guide should translate heading.

Yes, please! The english versions of Change Log and Upgrade Guide are helping everybody.
Even new comers may benefit from reading it as it may provide some guidance of what is evolving.

I have updated the issues list.

@kvetoslavnovak thanks!

I have proposed translation PR for Menu and (partially) Mention.

@benjycui thanks for merging my last commits for Menu and Mention translation.
But I cannot see updated http://beta.ant.design/components/menu/ and http://beta.ant.design/components/mention/
???

I forgot to publish. It should be OK now.

Here is updated (cleared) list of residual issues:

Localisation

In Code Text

@kvetoslavnovak You can open another issue for demo translation. We close this now.

Congratulation to 2.0.
@afc163 OK, I will open the ussue so we can keep track regarding residual translation issues.

The residual issues are here #3200

After [email protected] is published, it means that antd-mobile is stable enough, and we want to translate its documentation into English now.

If someone is interested in this, you can trace: https://github.com/ant-design/ant-design-mobile/issues/329

Could someone help us to translate intl-example? https://github.com/ant-design/intl-example/issues/13

I noticed many parts are still untranslated in docs, :

I don't speak chinese, and use Google Translate for this seems very tedious.
If someone could provide a least a succint english translation, I could polish the result.

I do not speak Chinese, but have found Chrome's native translation feature (in the context menu: right-click) gets me 90% there. I would be happy to use this and polish the text to make it easier to understand. Let me know if this would be helpful. If so, just let me know which pages you need most urgently and I can start there.

@loganpowell just PR to us when you found any issue in our document.

Do we know how much text needs translating between antd and antd mobile (maybe a guess at word count)? I would be willing to fund/crowdfund hiring a translator via a freelance site (upwork, etc).

I can help with translating and don't see any open issues now. I would be happy to start translating https://ant.design/docs/pattern/navigation since it's still in Chinese! Please let me know if this is the best thread to contribute on and how I should help.

I want to be the translator of:

I'm familiar with both Chinese and English and I'm a fan of antd.
It would be a pleasure for me to help.

Thank you guys! @shenlin192 @choudlet

Trace for the rest untranslated documents at https://github.com/ant-design/ant-design/issues/6931

I wanted to point out that I'd love to help with any translating or proofreading - if anyone can point me in the right direction, I'm certain I can provide some added clarity and polish to the final text.

@tsaiDavid I am not sure if you had noticed these edit button, actually, you can polish our documentation any time, feel free to PR, thanks!

image

image

Hi all, I would love to volunteer for the translation work, but couldn't find a good task list with references to what's been done + what are the priorities. #6931 is tagged inactive as well. We are using Ant Design in one of our projects as a pilot, so I would want to see the design language docs fully translated.

Right now here are the ones with only Chinese docs:

  • Visual/Layout
  • Visual/Font
  • Patterns/Overview
  • Patterns/Copywriting
  • Patterns/Data Entry
  • Patterns/Data Display
  • Patterns/Feedback
  • Visualization
  • Motion

How can the open source community help with the spec translation effort? Thanks! =]

@richardzyx I've updated #6931, leave a comment on that issue if you are going to translate one of the docs, I will update the list.

Hi Tam,

I was just wondering as Ant design itself provides "Internationalization" feature but most of the website is not even translated. its'nt it irony?

@badaljain Welcome to help us.

Hi is this issue closed?

I'm trying to read this page https://ant.design/docs/spec/data-entry

Thanks anyone who can help :-)

It seems that this issue is closed

@shenlin192 You could leave a comment about which docs you want to translate on issue #6931 and we will update that list.

Hi,
Is anyone working on the translation for 'Data Entry' or 'Data Display' now? If no, I can help on either one (e.g. 'Data Entry' first) :) please let me know if still need. Thanks

@michellechsy We still need your help~

@afc163 alright~ I will work on 'Data Entry' then :)

I apologize if I am a little late on this issue, but I can help with translating Copywriting. When I read the original Chinese document, I found it seems to consist of many examples specific to the Chinese language, so I will see if I can provide more general examples that apply to other languages.

@dchan3 Sure, just try it.

I can help translating Dark Theme if needed.

@lirenyeo Yes, PR welcome!

I can help with the Visualization Page and Detail Page, if it's still needed. :)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

longzb picture longzb  ·  3Comments

shivekkhurana picture shivekkhurana  ·  3Comments

drcmda picture drcmda  ·  3Comments

longhuasishen picture longhuasishen  ·  3Comments

xtznhzxdev picture xtznhzxdev  ·  3Comments