update doc

eodiandie · Dec 14, 2018 · 2698143 · 2698143
1 parent 4d4acdf
commit 2698143
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 27 deletions.
diff --git a/site/src/site/sphinx/en/install-detail.md b/site/src/site/sphinx/en/install-detail.md
@@ -9,14 +9,14 @@ Install Arthas
 Download`arthas-boot.jar`，Start with `java` command:
 
 ```bash
-$ wget https://alibaba.github.io/arthas/arthas-boot.jar
-$ java -jar arthas-boot.jar
+wget https://alibaba.github.io/arthas/arthas-boot.jar
+java -jar arthas-boot.jar
 ```
 
 Print usage:
 
 ```bash
-$ java -jar arthas-boot.jar -h
+java -jar arthas-boot.jar -h
 ```
 
 
@@ -25,7 +25,7 @@ $ java -jar arthas-boot.jar -h
 You can install Arthas with one single line command on Linux, Unix, and Mac. Pls. copy the following command and paste it into the command line, then press *Enter* to run:
 
 ```bash
-$ curl -L https://alibaba.github.io/arthas/install.sh | sh
+curl -L https://alibaba.github.io/arthas/install.sh | sh
 ```
 
 The command above will download the bootstrap script `as.sh` to the current directory. You can move it the any other place you want, or put its location in `$PATH`.
@@ -40,13 +40,13 @@ Latest Version, Click To Download: [![Arthas](https://img.shields.io/maven-centr
 Download and unzip, find `arthas-boot.jar` in the directory. Start with `java` command:
 
 ```bash
-$ java -jar arthas-boot.jar
+java -jar arthas-boot.jar
 ```
 
 Print usage:
 
 ```bash
-$ java -jar arthas-boot.jar -h
+java -jar arthas-boot.jar -h
 ```
 
 ## Manual Installation
@@ -64,7 +64,8 @@ Latest Version, Click To Download:[![Arthas](https://img.shields.io/maven-centra
 * On Linux/Unix/Mac, delete the files with the following command:
 
     ```bash
-    $ rm -rf ~/.arthas/
+    rm -rf ~/.arthas/
+    rm -rf ~/logs/arthas/
     ```
 
-* On Windows, delete `.arthas` directory under user home.
+* On Windows, delete `.arthas` and `logs/arthas` directory under user home.
diff --git a/site/src/site/sphinx/en/quick-start.md b/site/src/site/sphinx/en/quick-start.md
@@ -4,8 +4,8 @@ Quick Start
 ## 1. Start Demo Application
 
 ```bash
-$ wget https://alibaba.github.io/arthas/arthas-demo.jar
-$ java -jar arthas-demo.jar
+wget 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.
@@ -19,8 +19,8 @@ The source code of `arthas-demo`: [View](https://github.com/alibaba/arthas/blob/
 Execute the following command in the command line:
 
 ```bash
-$ wget https://alibaba.github.io/arthas/arthas-boot.jar
-$ java -jar arthas-boot.jar
+wget https://alibaba.github.io/arthas/arthas-boot.jar
+java -jar arthas-boot.jar
 ```
 
 * The user to run this command *MUST* have the same privilege as the owner of the target process, as a simple example you can try the following command if the target process is managed by user `admin`: `sudo su admin && java -jar arthas-boot.jar` or `sudo -u admin -EH java -jar arthas-boot.jar`

diff --git a/site/src/site/sphinx/install-detail.md b/site/src/site/sphinx/install-detail.md
@@ -8,24 +8,26 @@ Arthas Install
 下载`arthas-boot.jar`，然后用`java -jar`的方式启动：
 
 ```bash
-$ wget https://alibaba.github.io/arthas/arthas-boot.jar
-$ java -jar arthas-boot.jar
+wget https://alibaba.github.io/arthas/arthas-boot.jar
+java -jar arthas-boot.jar
 ```
 
 打印帮助信息：
 
 ```bash
-$ java -jar arthas-boot.jar -h
+java -jar arthas-boot.jar -h
 ```
 
 * 如果下载速度比较慢，可以使用aliyun的镜像：
 
-    `java -jar arthas-boot.jar --repo-mirror aliyun --use-http`
+    ```bash
+    java -jar arthas-boot.jar --repo-mirror aliyun --use-http
+    ```
 
 * 如果从github下载有问题，可以使用gitee镜像
 
     ```bash
-    $ wget https://arthas.gitee.io/arthas-boot.jar
+    wget https://arthas.gitee.io/arthas-boot.jar
     ```
 
 
@@ -34,7 +36,7 @@ $ java -jar arthas-boot.jar -h
 Arthas 支持在 Linux/Unix/Mac 等平台上一键安装，请复制以下内容，并粘贴到命令行中，敲 `回车` 执行即可：
 
 ```bash
-$ curl -L https://alibaba.github.io/arthas/install.sh | sh
+curl -L https://alibaba.github.io/arthas/install.sh | sh
 ```
 
 上述命令会下载启动脚本文件 `as.sh` 到当前目录，你可以放在任何地方或将其加入到 `$PATH` 中。
@@ -46,7 +48,7 @@ $ curl -L https://alibaba.github.io/arthas/install.sh | sh
 * 如果从github下载有问题，可以使用gitee镜像
 
     ```bash
-    $ curl -L https://arthas.gitee.io/install.sh | sh
+    curl -L https://arthas.gitee.io/install.sh | sh
     ```
 
 ## 全量安装
@@ -56,13 +58,13 @@ $ curl -L https://alibaba.github.io/arthas/install.sh | sh
 解压后，在文件夹里有`arthas-boot.jar`，直接用`java -jar`的方式启动：
 
 ```bash
-$ java -jar arthas-boot.jar
+java -jar arthas-boot.jar
 ```
 
 打印帮助信息：
 
 ```bash
-$ java -jar arthas-boot.jar -h
+java -jar arthas-boot.jar -h
 ```
 
 
@@ -80,7 +82,8 @@ $ java -jar arthas-boot.jar -h
 
     删除下面文件：
     ```bash
-    $ rm -rf ~/.arthas/
+    rm -rf ~/.arthas/
+    rm -rf ~/logs/arthas
     ```
 
-* Windows平台直接删除user home下面的`.arthas`目录
+* Windows平台直接删除user home下面的`.arthas`和`logs/arthas`目录
diff --git a/site/src/site/sphinx/quick-start.md b/site/src/site/sphinx/quick-start.md
@@ -4,8 +4,8 @@
 ## 1. 启动Demo
 
 ```bash
-$ wget https://alibaba.github.io/arthas/arthas-demo.jar
-$ java -jar arthas-demo.jar
+wget https://alibaba.github.io/arthas/arthas-demo.jar
+java -jar arthas-demo.jar
 ```
 
 `arthas-demo`是一个简单的程序，每隔一秒生成一个随机数，再执行质因式分解，并打印出分解结果。
@@ -18,8 +18,8 @@ $ java -jar arthas-demo.jar
 在命令行下面执行：
 
 ```bash
-$ wget https://alibaba.github.io/arthas/arthas-boot.jar
-$ java -jar arthas-boot.jar
+wget https://alibaba.github.io/arthas/arthas-boot.jar
+java -jar arthas-boot.jar
 ```
 
 * 执行该程序的用户需要和目标进程具有相同的权限。比如以`admin`用户来执行：`sudo su admin && java -jar arthas-boot.jar` 或 `sudo -u admin -EH java -jar arthas-boot.jar`。