diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e197d32a2..38b7418e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,7 +62,7 @@ Tip: you can use `--versions` to list all available versions. -## issue +## Issue 欢迎在issue里对arthas做反馈，分享使用技巧，排查问题的经历。 diff --git a/README.md b/README.md index 2f439c102..cb3d62db2 100644 --- a/README.md +++ b/README.md @@ -42,14 +42,14 @@ Arthas was built to solve these issues. A developer can troubleshoot your produc * Supports Linux/Mac/Windows. -### Online Tutorials(Recommend) +### Online Tutorials(Recommended) * [Arthas Basics](https://alibaba.github.io/arthas/arthas-tutorials?language=en&id=arthas-basics) * [Arthas Advanced](https://alibaba.github.io/arthas/arthas-tutorials?language=en&id=arthas-advanced) ### Quick start -#### Use `arthas-boot`(Recommend) +#### Use `arthas-boot`(Recommended) Download`arthas-boot.jar`，Start with `java` command: @@ -79,7 +79,7 @@ You can enter its interactive interface by executing `as.sh`, or execute `as.sh ### Documentation -* [Online Tutorials(Recommend)](https://alibaba.github.io/arthas/arthas-tutorials?language=en) +* [Online Tutorials(Recommended)](https://alibaba.github.io/arthas/arthas-tutorials?language=en) * [User manual](https://alibaba.github.io/arthas/en) * [Installation](https://alibaba.github.io/arthas/en/install-detail.html) * [Download](https://alibaba.github.io/arthas/en/download.html) @@ -106,7 +106,7 @@ You can enter its interactive interface by executing `as.sh`, or execute `as.sh * https://alibaba.github.io/arthas/en/thread -See what is eating your cpu (ranked by top cpu usage) and what is going on there in one glance: +See what is eating your CPU (ranked by top CPU usage) and what is going on there in one glance: ```bash $ thread -n 3 @@ -516,11 +516,11 @@ Welcome to register the company name in this issue: https://github.com/alibaba/a * [Bistoury: A project that integrates Arthas](https://github.com/qunarcorp/bistoury) * [A fork of arthas using MVEL](https://github.com/XhinLiang/arthas) -### Credit +### Credits #### Contributors -This project exists thanks to all the people who contribute. +This project exists, thanks to all the people who contributed. diff --git a/site/src/site/sphinx/en/advanced-use.md b/site/src/site/sphinx/en/advanced-use.md index 302d3c3a2..39ee7589a 100644 --- a/site/src/site/sphinx/en/advanced-use.md +++ b/site/src/site/sphinx/en/advanced-use.md @@ -45,7 +45,7 @@ Advanced Usage ## monitor/watch/trace - related -> **Attention**: commands here are taking advantage of byte-code-injection, which means we are injecting some [aspects](https://en.wikipedia.org/wiki/Aspect-oriented_programming) into the current classes for monitoring and statistics purpose. Therefore when use it for online troubleshooting in your production environment, you'd better **explicitly specify** classes/methods/criteria, and remember to remove the injected code by `stop` or `reset`. +> **Attention**: commands here are taking advantage of byte-code-injection, which means we are injecting some [aspects](https://en.wikipedia.org/wiki/Aspect-oriented_programming) into the current classes for monitoring and statistics purpose. Therefore, when using it for online troubleshooting in your production environment, you'd better **explicitly specify** classes/methods/criteria, and remember to remove the injected code by `stop` or `reset`. * [monitor](monitor.md) - monitor method execution statistics * [watch](watch.md) - display the input/output parameter, return object, and thrown exception of specified method invocation diff --git a/site/src/site/sphinx/en/async.md b/site/src/site/sphinx/en/async.md index c95850b08..ec32bf510 100644 --- a/site/src/site/sphinx/en/async.md +++ b/site/src/site/sphinx/en/async.md @@ -40,8 +40,8 @@ You can see that there is currently a background job executing: When the job is executing in the foreground, for example, directly executing the command `trace Test t`, or executing the background job command `trace Test t &`, then putting the job back to the foreground via `fg` command, the console cannot continue to execute other command, but can receive and process the following keyboard events: -* ‘ctrl + z’: Suspend the job, the job status will change to `Stopped`, and the job can be restarted by `bg ` or `fg ` -* ‘ctrl + c’: Stop the job +* ‘ctrl + z’: Suspends the job, the job status will change to `Stopped`, and the job can be restarted by `bg ` or `fg ` +* ‘ctrl + c’: Stops the job * ‘ctrl + d’: According to linux semantics this should lead to exit the terminal, right now Arthas has not implemented this yet, therefore simply ignore this keystroke. ## 4. fg/bg, switch the job from the foreground to the background, and vise verse @@ -60,7 +60,7 @@ $ trace Test t >> test.out & The trace command will be running in the background and the output will be redirect to `~/logs/arthas-cache/test.out`. You can continue to execute other commands in the console, at the same time, you can also examine the execution result from the output file. -When connect to a remote Arthas server, you may not be able to view the output file on the remote machine. In this case, Arthas also supports automatically redirecting the output to the local cache file. Examples are as follows: +When connected to a remote Arthas server, you may not be able to view the output file on the remote machine. In this case, Arthas also supports automatically redirecting the output to the local cache file. Examples are as follows: ```bash $ trace Test t >> & diff --git a/site/src/site/sphinx/en/batch-support.md b/site/src/site/sphinx/en/batch-support.md index c2bcc4e92..0afca2df5 100644 --- a/site/src/site/sphinx/en/batch-support.md +++ b/site/src/site/sphinx/en/batch-support.md @@ -38,7 +38,7 @@ Use `-c` also can specify the commands, like this: ./as.sh -c 'sysprop; thread' 56328 > test.out ``` -#### Step 3: Check the outputs +#### Step 3: Check the output ```bash cat test.out diff --git a/site/src/site/sphinx/en/classloader.md b/site/src/site/sphinx/en/classloader.md index 5cbe19a29..e67ffeae6 100644 --- a/site/src/site/sphinx/en/classloader.md +++ b/site/src/site/sphinx/en/classloader.md @@ -3,7 +3,7 @@ classloader View hierarchy, urls and classes-loading info for the class-loaders. -`classloader` can search and print out the URLs for a specified resource from one particular classloader. It is quite handy when analyze `ResourceNotFoundException`. +`classloader` can search and print out the URLs for a specified resource from one particular classloader. It is quite handy when analyzing `ResourceNotFoundException`. ### Options diff --git a/site/src/site/sphinx/en/commands.md b/site/src/site/sphinx/en/commands.md index 3a3b1060a..f60729ee3 100644 --- a/site/src/site/sphinx/en/commands.md +++ b/site/src/site/sphinx/en/commands.md @@ -42,15 +42,15 @@ All Commands ### Basic Arthas Commands -* help - examine help information -* cls - clear out the screen -* session - examine the current session -* [reset](reset.md) - reset enhanced classes. All enhanced classes will be reset to their original states. When Arthas server closes, all these enhanced classes will be reset too -* version - print out Arthas's version +* help - examines help information +* cls - clears out the screen +* session - examines the current session +* [reset](reset.md) - resets enhanced classes. All enhanced classes will be reset to their original states. When Arthas server closes, all these enhanced classes will be reset too +* version - prints out Arthas's version * history - view command history * quit - exit the current Arthas client without affecting other clients -* stop - terminate the Arthas server, all the Arthas clients connecting to this server will be disconnected -* [keymap](keymap.md) - list all Arthas keyboard shortcuts and shortcut customizations. +* stop - terminates the Arthas server, all the Arthas clients connecting to this server will be disconnected +* [keymap](keymap.md) - lists all Arthas keyboard shortcuts and shortcut customizations. diff --git a/site/src/site/sphinx/en/download.md b/site/src/site/sphinx/en/download.md index 9ee6ae54a..faa46b9b0 100644 --- a/site/src/site/sphinx/en/download.md +++ b/site/src/site/sphinx/en/download.md @@ -3,7 +3,7 @@ Download ## Download full package -### Dwonload from maven central +### Download from maven central Latest Version, Click To Download: [![](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.taobao.arthas&a=arthas-packaging&e=zip&c=bin&v=LATEST) diff --git a/site/src/site/sphinx/en/getstatic.md b/site/src/site/sphinx/en/getstatic.md index be3a430f4..fcf5775e6 100644 --- a/site/src/site/sphinx/en/getstatic.md +++ b/site/src/site/sphinx/en/getstatic.md @@ -1,7 +1,7 @@ getstatic ========= -* It is recommended to use the [OGNL] (ognl.md) command, which will be more flexibility. +* It is recommended to use the [OGNL] (ognl.md) command, which will be more flexible. Check the static fields of classes conveniently, the usage is `getstatic class_name field_name`. diff --git a/site/src/site/sphinx/en/groovy.md b/site/src/site/sphinx/en/groovy.md index 991adff8c..eb1dc16bb 100644 --- a/site/src/site/sphinx/en/groovy.md +++ b/site/src/site/sphinx/en/groovy.md @@ -6,7 +6,7 @@ groovy ### Limitations 1. Prohibit from alternating the original logic. Like `watch` command, The major purpose of scripting is monitoring and observing. -1. Only allow to monitor at the stages of before/success/exception/finish on one method. +2. Only allow to monitor at the stages of before/success/exception/finish on one method. ### Parameters diff --git a/site/src/site/sphinx/en/index.md b/site/src/site/sphinx/en/index.md index 405c805cb..e9c5ea4ae 100644 --- a/site/src/site/sphinx/en/index.md +++ b/site/src/site/sphinx/en/index.md @@ -34,7 +34,7 @@ Arthas is built to solve these issues. A developer can troubleshoot production i * Supports Linux/Mac/Windows -**If you are using Arthas, please let us know. Your use is very important to us: [View](https://github.com/alibaba/arthas/issues/111)** +**If you are using Arthas, please let us know. Your feedback is very important to us: [View](https://github.com/alibaba/arthas/issues/111)** Contents -------- diff --git a/site/src/site/sphinx/en/install-detail.md b/site/src/site/sphinx/en/install-detail.md index 5d34b6b85..10fb6aa92 100644 --- a/site/src/site/sphinx/en/install-detail.md +++ b/site/src/site/sphinx/en/install-detail.md @@ -4,7 +4,7 @@ Install Arthas ## Quick installation -### Use `arthas-boot`(Recommend) +### Use `arthas-boot`(Recommended) Download`arthas-boot.jar`，Start with `java` command: diff --git a/site/src/site/sphinx/en/keymap.md b/site/src/site/sphinx/en/keymap.md index e98456f1c..f02b2462b 100644 --- a/site/src/site/sphinx/en/keymap.md +++ b/site/src/site/sphinx/en/keymap.md @@ -62,8 +62,8 @@ then replace `"\C-h": backward-delete-char` with `"\C-h": backward-char`, then r #### Shortcuts for jobs -* `ctrl + c`: Terminate current command -* `ctrl + z`: Suspend the current command, you can restore this command with `bg`/`fg`, or `kill` it. +* `ctrl + c`: Terminates current command +* `ctrl + z`: Suspends the current command, you can restore this command with `bg`/`fg`, or `kill` it. * `ctrl + a`: Go to the beginning the line * `ctrl + e`: Go to the end of the line diff --git a/site/src/site/sphinx/en/quick-start.md b/site/src/site/sphinx/en/quick-start.md index fa68cbe03..7d47b7162 100644 --- a/site/src/site/sphinx/en/quick-start.md +++ b/site/src/site/sphinx/en/quick-start.md @@ -8,7 +8,7 @@ curl -O https://alibaba.github.io/arthas/arthas-demo.jar java -jar arthas-demo.jar ``` -`arthas-demo` is a simple program that generates a random number every second, then find all prime factors of the number. +`arthas-demo` is a simple program that generates a random number every second, then it finds all prime factors of that number. The source code of `arthas-demo`: [View](https://github.com/alibaba/arthas/blob/master/demo/src/main/java/demo/MathGame.java)