Add Chaos Dashboard articles in Run Chaos Experiment #830
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Yue Yang <[email protected]>
Signed-off-by: Yue Yang <[email protected]>
g1eny0ung
changed the title
fewdan
previously requested changes
Aug 24, 2020
Signed-off-by: Yue Yang <[email protected]>
|
@fewdan Thx for the correction! All typos have already been resolved. |
lilin90
reviewed
Aug 25, 2020
| title: Overview of Chaos Dashboard | ||
| --- | ||
|
|
||
| This document will give you an overview of Chaos Dashboard. We will simplify some of the steps we saw in [Run Chaos Experiment](run_chaos_experiment) and guide you to use the visual interface based on our existing features. |
There was a problem hiding this comment.
Suggested change
| This document will give you an overview of Chaos Dashboard. We will simplify some of the steps we saw in [Run Chaos Experiment](run_chaos_experiment) and guide you to use the visual interface based on our existing features. | |
| Chaos Dashboard is a Web UI for managing, designing, monitoring chaos experiments. This document introduces how to use Chaos Dashboard, the visual interface of Chaos Mesh. |
There was a problem hiding this comment.
The overview runs the same experiment as in the doc of Run Chaos Experiment. Maybe we should keep these two paragraphs at the same time?
Because I wanna show through comparison that some parts of the dashboard are easy to use.
Comment on lines
19
to
29
| The pre-setup of this overview is: | ||
|
|
||
| ```bash | ||
| minikube start # You can also use Kind | ||
|
|
||
| kubectl create deployment hello-minikube --image=registry.cn-hangzhou.aliyuncs.com/google_containers/echoserver:1.10 | ||
|
|
||
| curl -sSL https://mirrors.chaos-mesh.org/latest/install.sh | bash | ||
|
|
||
| kubectl port-forward -n chaos-testing svc/chaos-dashboard 2333:2333 | ||
| ``` |
There was a problem hiding this comment.
If this is about how to set up Chaos Dashboard, I'd suggest adding a section named like "Set up" or "Setting up".
There was a problem hiding this comment.
This is a preview environment of the overview. If needed, I can split it into a section.
|
|
||
| Let's get started. | ||
|
|
||
| ## Status of Experiments |
There was a problem hiding this comment.
For all headings in the body of this doc, please use the sentence-style capitalization (only capitalize the first word) to keep it consistent with existing documents. See https://chaos-mesh.org/docs/user_guides/run_chaos_experiment.
There was a problem hiding this comment.
Know about it. Already resolved.
|
|
||
| #### Scope | ||
|
|
||
| In the second step, we call it scope. In this example, I create a simple `deployment` named `hello-minikube`. So this page is what you will see: |
There was a problem hiding this comment.
- Please limit the use of "I" in user documentation.
- If these are clear steps, please add words like "Step 1". See https://chaos-mesh.org/docs/user_guides/run_chaos_experiment.
|
|
||
| And you can recover(duplicate) the archive anytime. | ||
|
|
||
| ## At Last |
There was a problem hiding this comment.
This heading is a little bit weird to me. Generally we won't use such a heading.
Comment on lines
144
to
148
| The overview is ended. | ||
|
|
||
| We hope this overview can give you a general understanding of the dashboard. | ||
|
|
||
| For now, we are still constantly improving the entire dashboard. Through this overview, I think we have conveyed some important concepts of the dashboard to you, even though the entire dashboard interface may have major changes in the future, we think you can also adapt to it quickly. |
There was a problem hiding this comment.
This section is more like words in a blog post, not user documentation.
|
|
||
| For now, we are still constantly improving the entire dashboard. Through this overview, I think we have conveyed some important concepts of the dashboard to you, even though the entire dashboard interface may have major changes in the future, we think you can also adapt to it quickly. | ||
|
|
||
| If you have any questions or suggestions about Chaos Dashboard, please submit [issues](https://github.com/chaos-mesh/chaos-mesh/issues) to our repo. All of our maintainers are glad to help you.~ |
There was a problem hiding this comment.
Suggested change
| If you have any questions or suggestions about Chaos Dashboard, please submit [issues](https://github.com/chaos-mesh/chaos-mesh/issues) to our repo. All of our maintainers are glad to help you.~ | |
| If you have any questions or suggestions about Chaos Dashboard, [submit an issue](https://github.com/chaos-mesh/chaos-mesh/issues/new/choose) to the chaos-mesh repository. |
Signed-off-by: Yue Yang <[email protected]>
Signed-off-by: Yue Yang <[email protected]>
g1eny0ung
changed the title
dcalvin
approved these changes
Aug 25, 2020
Comment on lines
19
to
29
| The pre-setup of this overview is: | ||
|
|
||
| ```bash | ||
| minikube start # You can also use Kind | ||
|
|
||
| kubectl create deployment hello-minikube --image=registry.cn-hangzhou.aliyuncs.com/google_containers/echoserver:1.10 | ||
|
|
||
| curl -sSL https://mirrors.chaos-mesh.org/latest/install.sh | bash | ||
|
|
||
| kubectl port-forward -n chaos-testing svc/chaos-dashboard 2333:2333 | ||
| ``` |
sjwsl
pushed a commit
to sjwsl/chaos-mesh
that referenced
this pull request
May 6, 2021
* chore: update Signed-off-by: Yue Yang <[email protected]> * chore: update Signed-off-by: Yue Yang <[email protected]> * fix: typo Signed-off-by: Yue Yang <[email protected]> * chore: remove this doc temporarily Signed-off-by: Yue Yang <[email protected]> * fix: typo Signed-off-by: Yue Yang <[email protected]> Co-authored-by: CWen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Yue Yang [email protected]
What problem does this PR solve?
As the title.
Also, bump docusaras' version.
What is changed and how does it work?
Checklist
Tests
Side effects
Related changes
Does this PR introduce a user-facing change?