Document Translation

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:

• ant-design-pro-site is our site of Ant Design Pro and it is repository witch docs here.
• ant-design-pro is ant-design-pro-site’s submodule, it contains component’s docs.

Contributing:

1. Fork
   • docs: ant-design-pro-site and git clone
   • components: ant-design-pro and git clone
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: https://github.com/ant-design/ant-design/issues/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:

• https://github.com/ant-design/ant-design/tree/master/components/button
• https://github.com/ant-design/ant-design/blob/master/components/button/demo/basic.md

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

• docs: 105
• components: 123

TODOs

/docs

• api-doc.md ( translator: @yesmeck )
• authority-management.md ( translator: @chenshuai2144 )
• biz-icon.md ( translator: @ddcat1115 )
• changelog.md ( translator: @ddcat1115 )
• cli.md ( translator: @viztor )
• deploy.md ( translator: @yesmeck )
• error.md ( translator: @nikogu )
• faq.md ( translator: null)
• getting-started.md
• getting-start-inner.md
• graph.md (translator: @RaoHai)
• i18n.md ( translator: @viztor )
• import.md ( translator: null)
• layout.md ( translator: @viztor )
• mock-api.md ( translator: @afc163 ) https://github.com/ant-design/ant-design-pro-site/pull/156
• new-component.md ( translator: @afc163 ) https://github.com/ant-design/ant-design-pro-site/pull/157
• new-page.md ( translator: @valleykid )
• resource.md ( translator: @nikogu )
• router-and-nav.md ( translator: @ddcat1115 )
• server.md ( translator: @valleykid )
• style.md( translator: @yutingzhao1991 ) https://github.com/ant-design/ant-design-pro-site/pull/148
• theme.md ( translator: @nikogu )
• ui-test.md ( translator: @yutingzhao1991 ) https://github.com/ant-design/ant-design-pro-site/pull/151
• use-components-alone.md ( translator: @dengfuping )

/components

• AvatarList (translator: @nikogu)
• Charts (translator: @RaoHai)
• CountDown (translator: @nikogu)
• DescriptionList ( translator: @ddcat1115 )
• Exception ( translator: @ddcat1115 )
• FooterToolbar ( translator: @dengfuping )
• GlobalFooter ( translator: @MrPeak )
• HeaderSearch ( translator: @MrPeak )
• NoticeIcon ( translator: @MrPeak )
• NumberInfo
• Ellipsis
• PageHeader
• Result
• TagSelect
• Trend
• Authorized ( translator: @chenshuai2144 )
• Login

[gardner]

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.

[tchern]

I’d love to help with both review and translation. I am a technical writer, English native and Chinese bilingual writing and reading proficiency. I can start with reviewing /docs/layout.md and components/AvartarList.md. I also spotted a few small grammar errors in getting-started.md, if you’d like me to correct that too.

我可以帮忙中英翻译和修改英文的版本。上面列了几个md是我可以先修改的。 （我英文中文双语，繁体中文和简体中文都能专业读写）