Document Translation

[nikogu]

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: 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:

• 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 ) Translate Mock Data documentation ant-design-pro-site#156
• new-component.md ( translator: @afc163 ) Translate New Component doc ant-design-pro-site#157
• new-page.md ( translator: @valleykid )
• resource.md ( translator: @nikogu )
• router-and-nav.md ( translator: @ddcat1115 )
• server.md ( translator: @valleykid )
• style.md( translator: @yutingzhao1991 ) translate style.md ant-design-pro-site#148
• theme.md ( translator: @nikogu )
• ui-test.md ( translator: @yutingzhao1991 ) translate ui-test ant-design-pro-site#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.

[afc163]

@tmattio @Kikobeats @viztor @acomito

[viztor]

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

[viztor]

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

[gardner]

@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]

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]

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]

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

[priezz]

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]

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]

Can CET-6 have a try？