chaosblade-io / chaosblade

An easy to use and powerful chaos engineering experiment toolkit.(阿里巴巴开源的一款简单易用、功能强大的混沌实验注入工具)
https://chaosblade.io
Apache License 2.0
5.92k stars 943 forks source link

docs: Chaosblade documentation improvement program. #722

Open Super-long opened 2 years ago

Super-long commented 2 years ago

Issue Description

The chaosblade documentation has received a lot of flack for lacking a good documentation for a tool that is known for its simplicity and power.

  1. https://harness.io/blog/devops/chaos-engineering-tools/
  2. https://www.gremlin.com/community/tutorials/chaos-engineering-tools-comparison/#chaosblade
  3. ...

Many times I've tried to use certain experimental scenarios without adequate documentation and had to extrapolate through the code to see how the commands might be used.

It's a long process that can't be done by one person in a few days. Everyone who uses a command that doesn't exist in the documentation can contribute and together we can make chaosblade easy to use and powerful!

  1. Translation of existing documents into English: #721

The current idea is this: create a cmd directory under docs, each action is a separate file, the file describes the role of each parameter and gives a simple example

MandssS commented 2 years ago

I'm very glad to see the issue you raised, which coincides with what we want to do, but we hope that the form of presentation may be different from yours, you can pay attention this issue and participate: https://github.com/chaosblade-io/chaosblade-website/issues/49

MandssS commented 2 years ago

We have made a very exhaustive list. If you are interested, you are welcome to contribute : chaosblade-io/community/issues/3