Fix links, typos, 'intro.md', 'finish.md' for Online Tutorials alibab…

…a#847 (alibaba#1453)
Schaudge · Aug 26, 2020 · d268306 · d268306
1 parent 9ae8862
commit d268306
Show file tree

Hide file tree

Showing 210 changed files with 1,027 additions and 655 deletions.
diff --git a/tutorials/katacoda/arthas-advanced-cn/finish.md b/tutorials/katacoda/arthas-advanced-cn/finish.md
@@ -4,9 +4,8 @@
 * Issues: https://github.com/alibaba/arthas/issues
 * 文档： https://arthas.aliyun.com/doc
 
+如果您在使用Arthas，请让我们知道。您的使用对我们非常重要：[查看](https://github.com/alibaba/arthas/issues/111)
 
-如果您在使用Arthas，请让我们知道，您的使用对我们非常重要：[查看](https://github.com/alibaba/arthas/issues/111)
-
-欢迎关注公众号，获取Arthas项目的信息，源码分析，案例实践。
+欢迎关注公众号，获取Arthas项目的信息、源码分析、案例实践。
 
 ![Arthas公众号](/arthas/scenarios/common-resources/assets/qrcode_gongzhonghao.jpg)
diff --git a/tutorials/katacoda/arthas-advanced-en/finish.md b/tutorials/katacoda/arthas-advanced-en/finish.md
@@ -1,8 +1,8 @@
 
-In the `Advanced Tutorial`, there are most of the advanced usages of Arthas and hope to help you troubleshoot the issue. If you have more tips or questions, please feel free to ask in Issue.
+In the `Advanced Tutorial`, there are most of the advanced usages of Arthas and hope to help you troubleshoot the issue. If you have more tips or questions, please feel free to tell or ask in Issue.
 
 * Issues: https://github.com/alibaba/arthas/issues
-* Documentation: https://arthas.aliyun.com/doc
+* Documentation: https://arthas.aliyun.com/doc/en
 
 
-If you are using Arthas, please let us know that your use is very important to us: [View](https://github.com/alibaba/arthas/issues/111)
+If you are using Arthas, please let us know that. Your use is very important to us: [View](https://github.com/alibaba/arthas/issues/111)
diff --git a/tutorials/katacoda/arthas-advanced-en/intro.md b/tutorials/katacoda/arthas-advanced-en/intro.md
@@ -8,4 +8,4 @@
 This tutorial takes a normal Spring Boot application as an example to demonstrate the advanced usage of the Arthas.
 
 * Github: https://github.com/alibaba/arthas
-* Docs: https://arthas.aliyun.com/doc/
+* Docs: https://arthas.aliyun.com/doc/en
diff --git a/tutorials/katacoda/arthas-basics-en/finish.md b/tutorials/katacoda/arthas-basics-en/finish.md
@@ -1,5 +1,5 @@
 
-Through this tutorial, you can know how to use Arthas. More advanced features can be found in the Advanced Guide below.
+Through this tutorial, now you know how to use Arthas. More advanced features can be found in the Advanced Guide below.
 
 * [Arthas Advanced](https://arthas.aliyun.com/doc/arthas-tutorials.html?language=en&id=arthas-advanced)
 * [Arthas Github](https://github.com/alibaba/arthas)

diff --git a/tutorials/katacoda/case-async-jobs-cn/finish.md b/tutorials/katacoda/case-async-jobs-cn/finish.md
@@ -1,10 +1,11 @@
 
-通过本教程基本掌握了Arthas后台异步任务。更多高级特性，可以在下面的进阶指南里继续了解。
+通过本教程基本掌握了Arthas后台异步任务。如果有更多的技巧或者使用疑问，欢迎在Issue里提出。
 
-* [Arthas进阶](https://arthas.aliyun.com/doc/arthas-tutorials?language=cn&id=arthas-advanced)
-* [Arthas Github](https://github.com/alibaba/arthas)
-* [Arthas 文档](https://arthas.aliyun.com/doc/)
+* Issues: https://github.com/alibaba/arthas/issues
+* 文档： https://arthas.aliyun.com/doc
 
-欢迎关注公众号，获取Arthas项目的信息，源码分析，案例实践。
+如果您在使用Arthas，请让我们知道。您的使用对我们非常重要：[查看](https://github.com/alibaba/arthas/issues/111)
+
+欢迎关注公众号，获取Arthas项目的信息、源码分析、案例实践。
 
 ![Arthas公众号](/arthas/scenarios/common-resources/assets/qrcode_gongzhonghao.jpg)
diff --git a/tutorials/katacoda/case-async-jobs-en/finish.md b/tutorials/katacoda/case-async-jobs-en/finish.md
@@ -1,6 +1,7 @@
 
-Through this tutorial, you can know Arthas Async Jobs. More advanced features can be found in the Advanced Guide below.
+Through this tutorial, now you know Arthas Async Jobs. If you have more tips or questions, please feel free to tell or ask in Issue.
 
-* [Arthas Advanced](https://arthas.aliyun.com/doc/arthas-tutorials?language=en&id=arthas-advanced)
-* [Arthas Github](https://github.com/alibaba/arthas)
-* [Arthas Documentation](https://arthas.aliyun.com/doc/en)
+* Issues: https://github.com/alibaba/arthas/issues
+* Documentation: https://arthas.aliyun.com/doc/en
+
+If you are using Arthas, please let us know that. Your use is very important to us: [View](https://github.com/alibaba/arthas/issues/111)
diff --git a/tutorials/katacoda/case-async-jobs-en/intro.md b/tutorials/katacoda/case-async-jobs-en/intro.md
@@ -36,5 +36,4 @@ Arthas is built to solve these issues. A developer can troubleshoot production i
 This tutorial takes a simple application as an example to demonstrate the the use case of Async Jobs.
 
 * Github: https://github.com/alibaba/arthas
-* Docs: https://arthas.aliyun.com/doc/
-
+* Docs: https://arthas.aliyun.com/doc/en
diff --git a/tutorials/katacoda/case-boot-details-cn/arthas-demo.md b/tutorials/katacoda/case-boot-details-cn/arthas-demo.md
@@ -0,0 +1,10 @@
+
+
+
+
+下载`arthas-demo.jar`，再用`java -jar`命令启动：
+
+`wget https://arthas.aliyun.com/arthas-demo.jar
+java -jar arthas-demo.jar`{{execute T1}}
+
+`arthas-demo`是一个很简单的程序，它随机生成整数，再执行因式分解，把结果打印出来。如果生成的随机数是负数，则会打印提示信息。
diff --git a/tutorials/katacoda/case-boot-details-cn/finish.md b/tutorials/katacoda/case-boot-details-cn/finish.md
@@ -1,10 +1,11 @@
 
-通过本教程基本掌握了Arthas boot支持的参数。更多高级特性，可以在下面的进阶指南里继续了解。
+通过本教程基本掌握了Arthas boot支持的参数。如果有更多的技巧或者使用疑问，欢迎在Issue里提出。
 
-* [Arthas进阶](https://arthas.aliyun.com/doc/arthas-tutorials?language=cn&id=arthas-advanced)
-* [Arthas Github](https://github.com/alibaba/arthas)
-* [Arthas 文档](https://arthas.aliyun.com/doc/)
+* Issues: https://github.com/alibaba/arthas/issues
+* 文档： https://arthas.aliyun.com/doc
 
-欢迎关注公众号，获取Arthas项目的信息，源码分析，案例实践。
+如果您在使用Arthas，请让我们知道。您的使用对我们非常重要：[查看](https://github.com/alibaba/arthas/issues/111)
+
+欢迎关注公众号，获取Arthas项目的信息、源码分析、案例实践。
 
 ![Arthas公众号](/arthas/scenarios/common-resources/assets/qrcode_gongzhonghao.jpg)
diff --git a/tutorials/katacoda/case-boot-details-cn/index.json b/tutorials/katacoda/case-boot-details-cn/index.json
@@ -6,8 +6,8 @@
   "details": {
     "steps": [
       {
-        "title": "Start demo",
-        "text": "start-demo.md"
+        "title": "Arthas demo",
+        "text": "arthas-demo.md"
       },
       {
         "title": "arthas-boot支持的参数",

diff --git a/tutorials/katacoda/case-boot-details-en/arthas-demo.md b/tutorials/katacoda/case-boot-details-en/arthas-demo.md
@@ -0,0 +1,11 @@
+
+
+
+
+Download `arthas-demo.jar` and start with the `java -jar` command:
+
+`wget https://arthas.aliyun.com/arthas-demo.jar
+java -jar arthas-demo.jar`{{execute T1}}
+
+`arthas-demo` is a very simple program that randomly generates integers, performs factorization, and prints the results.
+If the generated random number is negative, a error message will be printed.
diff --git a/tutorials/katacoda/case-boot-details-en/finish.md b/tutorials/katacoda/case-boot-details-en/finish.md
@@ -1,6 +1,7 @@
 
-Through this tutorial, you can know boot supported options. More advanced features can be found in the Advanced Guide below.
+Through this tutorial, now you know boot supported options. If you have more tips or questions, please feel free to tell or ask in Issue.
 
-* [Arthas Advanced](https://arthas.aliyun.com/doc/arthas-tutorials?language=en&id=arthas-advanced)
-* [Arthas Github](https://github.com/alibaba/arthas)
-* [Arthas Documentation](https://arthas.aliyun.com/doc/en)
+* Issues: https://github.com/alibaba/arthas/issues
+* Documentation: https://arthas.aliyun.com/doc/en
+
+If you are using Arthas, please let us know that. Your use is very important to us: [View](https://github.com/alibaba/arthas/issues/111)
diff --git a/tutorials/katacoda/case-boot-details-en/index.json b/tutorials/katacoda/case-boot-details-en/index.json
@@ -6,8 +6,8 @@
   "details": {
     "steps": [
       {
-        "title": "Start demo",
-        "text": "start-demo.md"
+        "title": "Arthas demo",
+        "text": "arthas-demo.md"
       },
       {
         "title": "arthas-boot supported options",

diff --git a/tutorials/katacoda/case-boot-details-en/intro.md b/tutorials/katacoda/case-boot-details-en/intro.md
@@ -33,8 +33,7 @@ Arthas is built to solve these issues. A developer can troubleshoot production i
 - Supports JDK 6+
 - Supports Linux/Mac/Windows
 
-This tutorial takes a simple application as an example to demonstrate the the use case of Arthas boot supported options.
+This tutorial takes a simple application as an example to demonstrate the use case of Arthas boot supported options.
 
 * Github: https://github.com/alibaba/arthas
-* Docs: https://arthas.aliyun.com/doc/
-
+* Docs: https://arthas.aliyun.com/doc/en
diff --git a/tutorials/katacoda/case-boot-details-en/start-demo.md b/tutorials/katacoda/case-boot-details-en/start-demo.md
diff --git a/tutorials/katacoda/case-classloader-cn/arthas-boot.md b/tutorials/katacoda/case-classloader-cn/arthas-boot.md
@@ -4,7 +4,7 @@
 
 在新的`Terminal 2`里，下载`arthas-boot.jar`，再用`java -jar`命令启动：
 
-`wget https://arthas.aliyun.com/doc/arthas-boot.jar
+`wget https://arthas.aliyun.com/arthas-boot.jar
 java -jar arthas-boot.jar`{{execute T2}}
 
 `arthas-boot`是`Arthas`的启动程序，它启动后，会列出所有的Java进程，用户可以选择需要诊断的目标进程。

diff --git a/tutorials/katacoda/case-classloader-cn/finish.md b/tutorials/katacoda/case-classloader-cn/finish.md
@@ -1,10 +1,11 @@
 
-通过本教程基本掌握了Arthas Spring Boot应用的ClassLoader结构。更多高级特性，可以在下面的进阶指南里继续了解。
+通过本教程基本掌握了Arthas Spring Boot应用的ClassLoader结构。如果有更多的技巧或者使用疑问，欢迎在Issue里提出。
 
-* [Arthas进阶](https://arthas.aliyun.com/doc/arthas-tutorials?language=cn&id=arthas-advanced)
-* [Arthas Github](https://github.com/alibaba/arthas)
-* [Arthas 文档](https://arthas.aliyun.com/doc/)
+* Issues: https://github.com/alibaba/arthas/issues
+* 文档： https://arthas.aliyun.com/doc
 
-欢迎关注公众号，获取Arthas项目的信息，源码分析，案例实践。
+如果您在使用Arthas，请让我们知道。您的使用对我们非常重要：[查看](https://github.com/alibaba/arthas/issues/111)
+
+欢迎关注公众号，获取Arthas项目的信息、源码分析、案例实践。
 
 ![Arthas公众号](/arthas/scenarios/common-resources/assets/qrcode_gongzhonghao.jpg)
diff --git a/tutorials/katacoda/case-classloader-cn/intro.md b/tutorials/katacoda/case-classloader-cn/intro.md
@@ -7,5 +7,17 @@
 
 `Arthas` 支持JDK 6+，支持Linux/Mac/Windows，采用命令行交互模式，同时提供丰富的 `Tab` 自动补全功能，进一步方便进行问题的定位和诊断。
 
+当你遇到以下类似问题而束手无策时，Arthas可以帮助你解决：
+
+- 这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
+- 我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
+- 遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
+- 线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！
+- 是否有一个全局视角来查看系统的运行状况？
+- 有什么办法可以监控到JVM的实时运行状态？
+- 怎么快速定位应用的热点，生成火焰图？
+
+本教程会以一个普通的Spring Boot应用为例，演示Arthas Spring Boot应用的ClassLoader结构。
+
 * Github: https://github.com/alibaba/arthas
-* 文档: https://arthas.aliyun.com/doc/
+* 文档: https://arthas.aliyun.com/doc/
diff --git a/tutorials/katacoda/case-classloader-cn/start-demo.md b/tutorials/katacoda/case-classloader-cn/start-demo.md
diff --git a/tutorials/katacoda/case-classloader-en/arthas-boot.md b/tutorials/katacoda/case-classloader-en/arthas-boot.md
@@ -4,7 +4,7 @@
 
 In the new `Terminal 2`, download `arthas-boot.jar` and start with the `java -jar` command:
 
-`wget https://arthas.aliyun.com/doc/arthas-boot.jar
+`wget https://arthas.aliyun.com/arthas-boot.jar
 java -jar arthas-boot.jar`{{execute T2}}
 
 `arthas-boot` is the launcher for `Arthas`. It lists all the Java processes, and the user can select the target process to be diagnosed.

diff --git a/tutorials/katacoda/case-classloader-en/finish.md b/tutorials/katacoda/case-classloader-en/finish.md
@@ -1,6 +1,7 @@
 
-Through this tutorial, you can know The ClassLoaders in Spring Boot application. More advanced features can be found in the Advanced Guide below.
+Through this tutorial, now you know The ClassLoaders in Spring Boot application. If you have more tips or questions, please feel free to tell or ask in Issue.
 
-* [Arthas Advanced](https://arthas.aliyun.com/doc/arthas-tutorials?language=en&id=arthas-advanced)
-* [Arthas Github](https://github.com/alibaba/arthas)
-* [Arthas Documentation](https://arthas.aliyun.com/doc/en)
+* Issues: https://github.com/alibaba/arthas/issues
+* Documentation: https://arthas.aliyun.com/doc/en
+
+If you are using Arthas, please let us know that. Your use is very important to us: [View](https://github.com/alibaba/arthas/issues/111)
diff --git a/tutorials/katacoda/case-classloader-en/intro.md b/tutorials/katacoda/case-classloader-en/intro.md
@@ -7,5 +7,33 @@
 
 `Arthas` supports JDK 6+, supports Linux/Mac/Windows.
 
+## Background
+
+Oftentimes the production system network is inaccessible from local development environment. If issues are encountered in production systems, it is impossible to use IDE to debug the application remotely. What’s even worse, debugging in production environment is unacceptable, as it will suspend all the threads, leading to services downtime.
+
+Developers could always try to reproduce the same issue on the test/staging environment. However, this is tricky as some issues cannot be reproduced easily in a different environment, or even disappear once restarted.
+
+And if you’re thinking of adding some logs to your code to help trouble-shoot the issue, you will have to go through the following lifecycle: test, staging, and then to production. Time is money! This approach is inefficient! Worse still, the issue may not be fixed since it might be irreproducible once the JVM is restarted, as described above.
+
+Arthas is built to solve these issues. A developer can troubleshoot production issues on the fly. No JVM restart, no additional code changes. Arthas works as an observer, that is, it will never suspend your running threads.
+
+## Key features
+
+- Check whether a class is loaded? Or where the class is loaded from? (Useful for trouble-shooting jar file conflicts)
+- Decompile a class to ensure the code is running as expected.
+- Check classloader statistics, e.g. the number of classloaders, the number of classes loaded per classloader, the classloader hierarchy, possible classloader leaks, etc.
+- Check the method invocation details, e.g. method parameter, returned values, exceptions and etc.
+- Check the stack trace of specified method invocation. This is useful when a developer wants to know the caller of the method.
+- Trace the method invocation to find slow sub-invocations.
+- Monitor method invocation statistics, e.g. QPS (Query Per Second), RT (Return Time), success rate and etc.
+- Monitor system metrics, thread states and CPU usage, GC statistics and etc.
+- Supports command line interactive mode, with auto-complete feature enabled.
+- Supports telnet and WebSocket, which enables both local and remote diagnostics with command line and browsers.
+- Supports profiler/Flame Graph
+- Supports JDK 6+
+- Supports Linux/Mac/Windows
+
+This tutorial takes a normal Spring Boot application as an example to demonstrate the ClassLoaders in Spring Boot application.
+
 * Github: https://github.com/alibaba/arthas
-* Documentation: https://arthas.aliyun.com/doc/en
+* Docs: https://arthas.aliyun.com/doc/en
diff --git a/tutorials/katacoda/case-get-spring-context-cn/finish.md b/tutorials/katacoda/case-get-spring-context-cn/finish.md
@@ -1,10 +1,11 @@
 
-通过本教程基本掌握了Arthas获取Spring Context。更多高级特性，可以在下面的进阶指南里继续了解。
+通过本教程基本掌握了Arthas获取Spring Context。如果有更多的技巧或者使用疑问，欢迎在Issue里提出。
 
-* [Arthas进阶](https://arthas.aliyun.com/doc/arthas-tutorials?language=cn&id=arthas-advanced)
-* [Arthas Github](https://github.com/alibaba/arthas)
-* [Arthas 文档](https://arthas.aliyun.com/doc/)
+* Issues: https://github.com/alibaba/arthas/issues
+* 文档： https://arthas.aliyun.com/doc
 
-欢迎关注公众号，获取Arthas项目的信息，源码分析，案例实践。
+如果您在使用Arthas，请让我们知道。您的使用对我们非常重要：[查看](https://github.com/alibaba/arthas/issues/111)
+
+欢迎关注公众号，获取Arthas项目的信息、源码分析、案例实践。
 
 ![Arthas公众号](/arthas/scenarios/common-resources/assets/qrcode_gongzhonghao.jpg)
diff --git a/tutorials/katacoda/case-get-spring-context-cn/intro.md b/tutorials/katacoda/case-get-spring-context-cn/intro.md
@@ -7,5 +7,17 @@
 
 `Arthas` 支持JDK 6+，支持Linux/Mac/Windows，采用命令行交互模式，同时提供丰富的 `Tab` 自动补全功能，进一步方便进行问题的定位和诊断。
 
+当你遇到以下类似问题而束手无策时，Arthas可以帮助你解决：
+
+- 这个类从哪个 jar 包加载的？为什么会报各种类相关的 Exception？
+- 我改的代码为什么没有执行到？难道是我没 commit？分支搞错了？
+- 遇到问题无法在线上 debug，难道只能通过加日志再重新发布吗？
+- 线上遇到某个用户的数据处理有问题，但线上同样无法 debug，线下无法重现！
+- 是否有一个全局视角来查看系统的运行状况？
+- 有什么办法可以监控到JVM的实时运行状态？
+- 怎么快速定位应用的热点，生成火焰图？
+
+本教程会以一个普通的Spring Boot应用为例，演示获取Spring Context 案例。
+
 * Github: https://github.com/alibaba/arthas
-* 文档: https://arthas.aliyun.com/doc/
+* 文档: https://arthas.aliyun.com/doc/
diff --git a/tutorials/katacoda/case-get-spring-context-en/finish.md b/tutorials/katacoda/case-get-spring-context-en/finish.md
@@ -1,6 +1,7 @@
 
-Through this tutorial, you can know how to Get the Spring Context. More advanced features can be found in the Advanced Guide below.
+Through this tutorial, now you know how to Get the Spring Context. If you have more tips or questions, please feel free to tell or ask in Issue.
 
-* [Arthas Advanced](https://arthas.aliyun.com/doc/arthas-tutorials?language=en&id=arthas-advanced)
-* [Arthas Github](https://github.com/alibaba/arthas)
-* [Arthas Documentation](https://arthas.aliyun.com/doc/en)
+* Issues: https://github.com/alibaba/arthas/issues
+* Documentation: https://arthas.aliyun.com/doc/en
+
+If you are using Arthas, please let us know that. Your use is very important to us: [View](https://github.com/alibaba/arthas/issues/111)