Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a separate tutorial for each command/ Arthas在线教程重新编排,每个命令一个小教程 #847

Closed
hengyunabc opened this issue Sep 9, 2019 · 31 comments
Labels
help wanted Extra attention is needed SoC2020

Comments

@hengyunabc
Copy link
Collaborator

hengyunabc commented Sep 9, 2019

There are currently two parts to the online tutorial: basic and advanced

https://alibaba.github.io/arthas/arthas-tutorials?language=en&id=arthas-basics
https://alibaba.github.io/arthas/arthas-tutorials?language=en&id=arthas-advanced

  • Each little tutorial is longer, and adding new content will cause the tutorial to get longer and longer
    Users tend to lose patience.
  • It's hard to find what you need.
  • More users want to see the usage of a command directly
    So consider.

Provide a separate tutorial for each command, such as a separate tutorial for the watch command, so that many tips can be written in.

One tutorial per case to make it easier for users to learn to use Arthas.

What we need to:

  1. Register an account here and write a tutorial for Arthas' single command: https://www.katacoda.com/.
  2. Test the tutorial, then send the PR merge to https://github.com/alibaba/arthas/tree/master/tutorials/katacoda
  3. Update the web packe: https://github.com/alibaba/arthas/blob/master/site/src/site/sphinx/_include_html/arthas-tutorials.html

目前在线教程有两部分:基础和进阶

之前的一些调查结果: #742

目前在线教程有两部分:基础 和 进阶。

  • 每个小教程都是比较长,再增加新的内容会导致教程越来越长
  • 用户容易失去耐心
  • 不好找到需要的内容
  • 更多的用户是想直接看某个命令的用法

所以考虑

  • 每个命令一个教程,比如watch命令单独一个教程,这样子很多小技巧都可以写进去
  • 每一个案例一个教程,方便用户对应问题学习

需要做的事情:

@hengyunabc hengyunabc added this to the 3.1.3 milestone Sep 9, 2019
@hengyunabc hengyunabc pinned this issue Sep 9, 2019
@hengyunabc hengyunabc modified the milestones: 3.1.3, 3.1.4, 3.1.5 Sep 19, 2019
@hengyunabc hengyunabc unpinned this issue Nov 21, 2019
@hengyunabc hengyunabc modified the milestones: 3.1.5, 3.1.6 Nov 25, 2019
@hengyunabc hengyunabc modified the milestones: 3.1.6, 3.1.7 Dec 3, 2019
@hengyunabc hengyunabc modified the milestones: 3.1.8, 3.1.9 Mar 27, 2020
@hengyunabc hengyunabc modified the milestones: 3.2.0, 3.2.1 Apr 11, 2020
@hengyunabc hengyunabc removed this from the 3.3.0 milestone May 27, 2020
@hengyunabc hengyunabc added help wanted Extra attention is needed SoC2020 labels May 27, 2020
@HollowMan6
Copy link
Contributor

您好,我对这个SoC2020项目感兴趣,希望能参与这个项目,请问应该如何与社区联系来进一步讨论项目细节?

@arteevraina
Copy link
Contributor

@hengyunabc Can you add english translation for this idea. So I can get proper understanding of this idea.

@hengyunabc
Copy link
Collaborator Author

您好,我对这个SoC2020项目感兴趣,希望能参与这个项目,请问应该如何与社区联系来进一步讨论项目细节?

  1. 可以在这里注册帐号,然后编写自己的教程: https://www.katacoda.com/
  2. 创建好示例,测试没有问题之后,再提PR合并到 https://github.com/hengyunabc/katacoda-scenarios

@hengyunabc hengyunabc changed the title Arthas在线教程重新编排,每个命令一个小教程 Arthas在线教程重新编排,每个命令一个小教程/ Provide a separate tutorial for each command Jun 3, 2020
@hengyunabc hengyunabc changed the title Arthas在线教程重新编排,每个命令一个小教程/ Provide a separate tutorial for each command Provide a separate tutorial for each command/ Arthas在线教程重新编排,每个命令一个小教程 Jun 3, 2020
@hengyunabc
Copy link
Collaborator Author

@hengyunabc Can you add english translation for this idea. So I can get proper understanding of this idea.

Updated.

@HollowMan6
Copy link
Contributor

@hengyunabc 我已经按照要求将中文高级教程进行了初步拆分,并且提了一个PR #2,这是一个Demo,您看看这符不符合您的意思?

教程地址:https://www.katacoda.com/hollowman/courses/arthas-command-cn

English Version is still under construction.

如果您认为我这样可以的话我后面再把英文的按这样做了。

后面长期计划将用户文档命令列表里的命令进一步加入教程。

@arteevraina
Copy link
Contributor

@hengyunabc Are these commands for which we need to create separate scenarios for? or Am I getting it wrong?

@HollowMan6
Copy link
Contributor

@hengyunabc Are these commands for which we need to create separate scenarios for? or Am I getting it wrong?

Well, I guess we have to create separate scenarios for each command, otherwise users can hardly find the specified command since you can't see what's included in the scenarios. And the requirements:

So consider.
Provide a separate tutorial for each command, such as a separate tutorial for the watch command, so that many tips can be written in.

One tutorial per case to make it easier for users to learn to use Arthas.

@arteevraina
Copy link
Contributor

@HollowMan6 It does makes complete sense. Thanks a bunch!

kylixs pushed a commit that referenced this issue Aug 6, 2020
kylixs pushed a commit that referenced this issue Aug 6, 2020
kylixs pushed a commit that referenced this issue Aug 6, 2020
kylixs pushed a commit that referenced this issue Aug 6, 2020
kylixs pushed a commit that referenced this issue Aug 6, 2020
kylixs pushed a commit that referenced this issue Aug 6, 2020
kylixs pushed a commit that referenced this issue Aug 7, 2020
kylixs pushed a commit that referenced this issue Aug 7, 2020
kylixs pushed a commit that referenced this issue Aug 7, 2020
kylixs pushed a commit that referenced this issue Aug 7, 2020
kylixs pushed a commit that referenced this issue Aug 7, 2020
kylixs pushed a commit that referenced this issue Aug 7, 2020
kylixs pushed a commit that referenced this issue Aug 7, 2020
kylixs pushed a commit that referenced this issue Aug 12, 2020
kylixs pushed a commit that referenced this issue Aug 13, 2020
kylixs pushed a commit that referenced this issue Aug 13, 2020
kylixs pushed a commit that referenced this issue Aug 13, 2020
kylixs pushed a commit that referenced this issue Aug 14, 2020
hengyunabc pushed a commit that referenced this issue Aug 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed SoC2020
Projects
None yet
Development

No branches or pull requests

4 participants