Arthas: Call for document translation

Created on 18 Sep 2018  ·  23Comments  ·  Source: alibaba/arthas

The current document is written only in Chinese.
I am planning to translate them into English.

Any volunteer who is willing to help on this?

|Table of content| Assignee | Status |
| -------------- | --------- | --------- |
|README|@ralf0131| DONE|
|Installatoin| @Hearen| DONE|
|Quick start |@Hearen| DONE|
|Advanced usage| @Hearen| DONE|
|Commands| @Hearen| DONE|
|Commands/dashboard |@Hearen| DONE|
|Commands/thread |@Hearen| DONE|
|Commands/jvm |@Hearen| DONE|
|Commands/sysprop |@Hearen| DONE|
|Commands/getstatic |@Hearen| DONE|
|Commands/sc |@Hearen| DONE|
|Commands/sm |@Hearen| DONE|
|Commands/dump |@Hearen| DONE|
|Commands/jad |@Hearen| DONE|
|Commands/classloader |@Hearen| DONE|
|Commands/redefine |@Hearen| DONE|
|Commands/monitor |@Hearen| DONE|
|Commands/watch |@Hearen| DONE|
|Commands/trace |@Hearen| DONE|
|Commands/stack |@Hearen| DONE|
|Commands/tt |@Hearen| DONE|
|Commands/options |@alfredzouang| DONE|
|Commands/Basic commands |@Hearen| DONE|
User cases
|Release note |@Hearen| Done #138 |
Questions and Answers
|CONTRIBUTING |@Hearen| Done #139 |

help wanted

Most helpful comment

@hengyunabc Got it, I will start from the Installation section first.

All 23 comments

Great idea, seems like a cool tool

@alaptseu Welcome, please give it a try and provide your feedback. I am happy to help!

@ralf0131 It looks cool, shall we split upthe translation work for efficiency? I'd like to have a try too :smile:

By the way, the translation includes ToDo and CONTRIBUTING? If so, I will start from them first.

@Hearen Cool, let's discuss how to make it happen. For example, we can create a project to track this, and create one issue for each pages, so that everyone could be easy to participate.

How does that sounds like?

@ralf0131 Sounds good to me, however it seems little bit too much how about we just use google spread sheet to record the process as this:

image

If it's good to you, we can then just start it.

I have a concern that not all the users in China could have access to Google spreadsheet. Let's stay on Github.

@ralf0131 Please let us know HOW when it's ready, let's do it :sunglasses:

Hi, English doc directory is site/src/site/sphinx/en, Translation PR is welcome. see also #56

@Hearen The pages can be visited in https://alibaba.github.io/arthas/ need translate. Other pages do not need, such as TODO.

@hengyunabc Got it, I will start from the Installation section first.

@hengyunabc To whom it may concern, I am translating the Quick Start now.

Translated and Translating List:

  • [x] [README](https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/README.md) #57
  • [x] [installation](https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/install-detail.md) #57
  • [x] [quick-start](https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/quick-start.md) #68
  • [x] [advanced usage](https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/advanced-use.md) #68
  • [x] [commands] #88
  • [x] [Dashboard] #88
  • [x] [command-thread] #99
  • [x] [command-jvm] #103
  • [x] [command-sysprop] #104
  • [x] [command-getstatic] #105
  • [x] [command-sc] #106
  • [x] [command-sm] #107
  • [x] [command-dump] #108
  • [x] [command-jad] #109
  • [x] [command-classloader] #110

Please also for:

Now English website can be visited: https://alibaba.github.io/arthas/en/ , but there are still some commands that need to be translated.

Please comment if you would like take the any of the translation tasks.

Hi, I can take some of the translation tasks, please assign some to me. Thanks.

Hi, I can take some of the translation tasks, please assign some to me. Thanks.

@alfredzouang 😎 How about starting from this: https://alibaba.github.io/arthas/options.html and backwards?

Soft Reminder:

  1. Once you have a MR, you record it here to remind others about your progress
  2. Each file/page be an independent MR.

The current document is written only in Chinese.
I am planning to translate them into English.

Any volunteer who is willing to help on this?

List updated further here:

|Table of content| Assignee | Status |
| -------------- | --------- | --------- |
|README|@ralf0131| DONE|
|Installatoin| @Hearen| DONE|
|Quick start |@Hearen| DONE|
|Advanced usage| @Hearen| DONE|
|Commands| @Hearen| DONE|
|Commands/dashboard |@Hearen| DONE|
|Commands/thread |@Hearen| DONE|
|Commands/jvm |@Hearen| DONE|
|Commands/sysprop |@Hearen| DONE|
|Commands/getstatic |@Hearen| DONE|
|Commands/sc |@Hearen| DONE|
|Commands/sm |@Hearen| DONE|
|Commands/dump |@Hearen| DONE|
|Commands/jad |@Hearen| DONE|
|Commands/classloader |@Hearen| DONE|
|Commands/redefine |@Hearen| DONE|
|Commands/monitor |@Hearen| DONE|
|Commands/watch |@Hearen| DONE|
|Commands/trace |@Hearen| DONE|
|Commands/stack |@Hearen| DONE|
|Commands/tt |@Hearen| DONE|
|Commands/options |@alfredzouang| DONE|
|Commands/Basic commands |@Hearen| DONE|
User cases
|Release note |@Hearen| Done #138 |
Questions and Answers
|CONTRIBUTING |@Hearen| Done #139 |
|manual-install |@Hearen | Done #150 |
|advice-class |@Hearen| Done #151 |
|save-log | @Hearen |Done #145 |
|batch | @Hearen | Done #148 |

@ralf0131

@Hearen Thanks for the heads up. I've updated status.

I like it ,I want to try

I like it ,I want to try

@dongqiangqiang Perhaps you can start with User cases :smile:

The index.md needs some work. I would like to make some grammatical corrections.

The translation work is almost complete, very grateful to every contributor involved in the translation work: @0xflotus, @Hearen, @Huxing Zhang, @beiwei30, @LHearen, @Nithyanandan, @Nitish, @bohr.qiu, @garenchan, @静宏, @alfredzouang, @dongqiangqiang, @anand1st, and many contributors not mentioned.
Special thanks to @Hearen, who translated most of the documentation and made a lot of improvements.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

hengyunabc picture hengyunabc  ·  4Comments

paulqi picture paulqi  ·  4Comments

wenbeicai picture wenbeicai  ·  5Comments

joey-happy picture joey-happy  ·  3Comments

hezhiqiang picture hezhiqiang  ·  6Comments