From e63e0cfc6aaec1fcf001f0b3728aecf675548efb Mon Sep 17 00:00:00 2001 From: Hollow Man Date: Wed, 26 Aug 2020 11:21:53 +0800 Subject: [PATCH] Add guides for using and contributing (#1455) --- CONTRIBUTING.md | 8 +++++++ README.md | 5 ++--- README_CN.md | 5 ++--- tutorials/katacoda/README.md | 39 ++++++++++++++++++++++++++++----- tutorials/katacoda/README_CN.md | 39 +++++++++++++++++++++++++++++++++ 5 files changed, 85 insertions(+), 11 deletions(-) create mode 100644 tutorials/katacoda/README_CN.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 506cb3217e2..b8c0fa23326 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,10 @@ Welcome to use [issue tracker](https://github.com/alibaba/arthas/issues) to give Welcome PR to further improve English [documentation](https://github.com/alibaba/arthas/tree/master/site/src/site/sphinx/en). +## Online Tutorials + +Please refer to [README.MD at tutorials/katacoda](tutorials/katacoda/README.md#contribution-guide) + ## Developer * Arthas runtime supports JDK6+ @@ -74,6 +78,10 @@ Tip: you can use `--versions` to list all available versions. 英文文档在`site/src/site/sphinx/en`目录下，欢迎提交翻译PR。 +## 改进在线教程 + +请参考[tutorials/katacoda下的说明](tutorials/katacoda/README_CN.md#贡献指南) + ## 开发者相关 * Arthas运行支持JDK6+ diff --git a/README.md b/README.md index 041f4a6d96b..1b69178417d 100644 --- a/README.md +++ b/README.md @@ -42,10 +42,9 @@ Arthas was built to solve these issues. A developer can troubleshoot your produc * Supports Linux/Mac/Windows. -### Online Tutorials(Recommended) +### [Online Tutorials(Recommended)](https://arthas.aliyun.com/doc/arthas-tutorials.html?language=en) -* [Arthas Basics](https://arthas.aliyun.com/doc/arthas-tutorials.html?language=en&id=arthas-basics) -* [Arthas Advanced](https://arthas.aliyun.com/doc/arthas-tutorials.html?language=en&id=arthas-advanced) +* [Usages](tutorials/katacoda/README.md#online-tutorial-usages) ### Quick start diff --git a/README_CN.md b/README_CN.md index 14e1a7b0378..aac2737eace 100644 --- a/README_CN.md +++ b/README_CN.md @@ -28,10 +28,9 @@ English version goes [here](README.md). `Arthas`支持JDK 6+，支持Linux/Mac/Windows，采用命令行交互模式，同时提供丰富的 `Tab` 自动补全功能，进一步方便进行问题的定位和诊断。 -### 在线教程(推荐) +### [在线教程(推荐)](https://arthas.aliyun.com/doc/arthas-tutorials.html?language=cn) -* [基础教程](https://arthas.aliyun.com/doc/arthas-tutorials.html?language=cn&id=arthas-basics) -* [进阶教程](https://arthas.aliyun.com/doc/arthas-tutorials.html?language=cn&id=arthas-advanced) +* [Usages](tutorials/katacoda/README_CN.md#在线教程使用方法) ### 快速开始 diff --git a/tutorials/katacoda/README.md b/tutorials/katacoda/README.md index ea59158698f..35d0eebff63 100644 --- a/tutorials/katacoda/README.md +++ b/tutorials/katacoda/README.md @@ -1,10 +1,39 @@ -# Interactive Katacoda Scenarios +# Interactive Katacoda Online Tutorials for Arthas [![](http://shields.katacoda.com/katacoda/arthas/count.svg)](https://www.katacoda.com/arthas "Get your profile on Katacoda.com") -Visit https://www.katacoda.com/arthas to view the profile and interactive scenarios +[中文说明/Chinese Documentation](README_CN.md) -### Writing Scenarios -Visit https://www.katacoda.com/docs to learn more about creating Katacoda scenarios +Visit https://www.katacoda.com/arthas to view the profile and interactive scenarios. -For examples, visit https://github.com/katacoda/scenario-example +## Online Tutorial Usages + +1. First visit the online tutorial: https://arthas.aliyun.com/doc/arthas-tutorials.html?language=en , select the course you want to study from the menu: +![](https://user-images.githubusercontent.com/43995067/90310125-2a9bf480-df21-11ea-819d-2713f22f4145.png) + +2. The course introduction page will indicate the difficulty of the course and the time required to help you understand the basic information of the course. click `START SCENARIO` to start learning. +![](https://user-images.githubusercontent.com/43995067/90310168-9ed69800-df21-11ea-93cf-a01b4a41c66b.png) + +3. Enter the course, the left side is the description of this step, and the right side is a ready terminal, which can be used directly. Click the black blocks on the left to execute commands in the right: +![](https://user-images.githubusercontent.com/43995067/90310223-3d62f900-df22-11ea-936c-deb950e61f9e.png) + +4. Click the tab on the right to switch between terminals. Then follow the step-by-step instructions to complete the learning step by step: +![](https://user-images.githubusercontent.com/43995067/90310282-b8c4aa80-df22-11ea-8052-3799277b748e.png) + +## Contribution Guide + +If you want to contribute to the Arthas online tutorials, you are welcome to submit pull requests for the Arthas online tutorials. + +Visit https://www.katacoda.com/docs to learn more about creating Katacoda scenarios. You can also refer to the article of Alibaba cloud developer community here(In Chinese): https://developer.aliyun.com/article/752183 + +For examples of the scenarios folder, visit https://github.com/katacoda/scenario-example + +After that, if you have finished doing writing jobs, You just need to put your scenarios folder here in this folder, and add links in the related pages, that's all. + +Menu page source code is at https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/_include_html/arthas-tutorials.html + +## About + +This project is a part of [Alibaba Summer of Code 2020](https://www.alibabacloud.com/campaign/summerofcode2020) done by [@HollowMan6](https://github.com/HollowMan6), for more information please visit: https://github.com/HollowMan6/My-Alibaba-Summer-of-Code + +Issue: [#847](https://github.com/alibaba/arthas/issues/847) diff --git a/tutorials/katacoda/README_CN.md b/tutorials/katacoda/README_CN.md new file mode 100644 index 00000000000..3911642db2f --- /dev/null +++ b/tutorials/katacoda/README_CN.md @@ -0,0 +1,39 @@ +# Arthas交互式Katacoda在线教程 + +[![](http://shields.katacoda.com/katacoda/arthas/count.svg)](https://www.katacoda.com/arthas "Get your profile on Katacoda.com") + +English version goes [here](README.md). + +访问 https://www.katacoda.com/arthas 来查看Arthas所有的在线教程。 + +## 在线教程使用方法 + +1. 首先访问在线教程：https://arthas.aliyun.com/doc/arthas-tutorials.html?language=cn ，从菜单中选择你想要学习的课程： +![](https://images.gitee.com/uploads/images/2020/0814/211330_e71ef0ca_7637131.png) + +2. 课程介绍页面会标明课程的难度和需要的时间，帮助你了解该课程的基本信息。点击`START SCENARIO`开始学习。 +![](https://images.gitee.com/uploads/images/2020/0814/212507_4a02d8aa_7637131.png) + +3. 进入课程，左侧是该步骤说明，右侧是一个已经准备好的终端，直接可以使用。点击左侧黑块部分就可以在右侧执行： +![](https://images.gitee.com/uploads/images/2020/0814/213005_62d85818_7637131.png) + +4. 点击右侧标签可以切换终端。之后就是跟着步骤说明，一步步的完成学习即可： +![](https://images.gitee.com/uploads/images/2020/0814/213458_43bb4e3f_7637131.png) + +## 贡献指南 + +如果你想为Arthas在线教程做出贡献，欢迎为Arthas在线教程提交Pull Request。 + +访问https://www.katacoda.com/docs 来了解更多创建Katacoda教程的信息，也可以参考这里的一篇阿里云开发者社区的推送：https://developer.aliyun.com/article/752183 + +Katacoda教程文件夹的示例：https://github.com/katacoda/scenario-example + +之后，如果你已经完成了编写，你只需要把你的教程文件夹放在此文件夹，并在相关页面中添加链接。 + +菜单页面源代码位于：https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/_include_html/arthas-tutorials.html + +## 关于 + +此项目为[阿里巴巴编程之夏2020](https://developer.aliyun.com/topic/summerofcode2020)的一部分，由[@HollowMan6](https://github.com/HollowMan6)完成，更多信息请参见https://github.com/HollowMan6/My-Alibaba-Summer-of-Code + +Issue: [#847](https://github.com/alibaba/arthas/issues/847)