Skip to content

Commit

Permalink
docs: update install guide (kubernetes#4)
Browse files Browse the repository at this point in the history
* update document

Signed-off-by: cwen0 <cwenyin0@gmail.com>

* fix develop guide

Signed-off-by: cwen0 <cwenyin0@gmail.com>
  • Loading branch information
cwen0 authored Nov 5, 2020
1 parent dbca98b commit 542e8e0
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 16 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
.cache-loader

# Misc
.idea
.DS_Store
.env.local
.env.development.local
Expand Down
6 changes: 3 additions & 3 deletions docs/development_guides/setup_env.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: set_up_the_development_environment
id: set_up_the_development_environment
title: Set up the development environment
sidebar_label: Set up the development environment
---
Expand Down Expand Up @@ -41,7 +41,7 @@ Make sure you have the above prerequisites met. Now follow the steps below to pr
```

```bash
source ~/. bash_profile
source ~/.bash_profile
```

> **Note:**
Expand All @@ -64,7 +64,7 @@ With the toolchain ready, you still need a local Kubernetes cluster as the deplo
hack/kind-cluster-build.sh
```

The above script will create a Kubernetes cluster by kind. When you don't need this cluster, you can run the following command to delete it:
The above script will create a Kubernetes cluster by kind. When you don't need this cluster, you can run the following command to delete it:
```bash
kind delete cluster --name=kind
Expand Down
2 changes: 1 addition & 1 deletion docs/get_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Before you start running a chaos experiment, verify if Chaos Mesh is installed c
If you are using k3s or k3d, please also specify `--k3s` flag.

<PickVersion className="language-bash">
curl -sSL https://mirrors.chaos-mesh.org/latest/install.sh --k3s | bash
curl -sSL https://mirrors.chaos-mesh.org/latest/install.sh | bash -s -- --k3s
</PickVersion>

### Verify your installation
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-0.9.1/development_guides/setup_env.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: set_up_the_development_environment
id: set_up_the_development_environment
title: Set up the development environment
sidebar_label: Set up the development environment
---
Expand Down Expand Up @@ -41,7 +41,7 @@ Make sure you have the above prerequisites met. Now follow the steps below to pr
```

```bash
source ~/. bash_profile
source ~/.bash_profile
```

> **Note:**
Expand All @@ -64,7 +64,7 @@ With the toolchain ready, you still need a local Kubernetes cluster as the deplo
hack/kind-cluster-build.sh
```

The above script will create a Kubernetes cluster by kind. When you don't need this cluster, you can run the following command to delete it:
The above script will create a Kubernetes cluster by kind. When you don't need this cluster, you can run the following command to delete it:
```bash
kind delete cluster --name=kind
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-0.9.1/installation/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Before you start running a chaos experiment, verify if Chaos Mesh is installed c
If you are using k3s or k3d, please also specify `--k3s` flag.

<PickVersion className="language-bash">
curl -sSL https://mirrors.chaos-mesh.org/latest/install.sh --k3s | bash
curl -sSL https://mirrors.chaos-mesh.org/latest/install.sh | bash -s -- --k3s
</PickVersion>

### Verify your installation
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-1.0.0/development_guides/setup_env.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: set_up_the_development_environment
id: set_up_the_development_environment
title: Set up the development environment
sidebar_label: Set up the development environment
---
Expand Down Expand Up @@ -41,7 +41,7 @@ Make sure you have the above prerequisites met. Now follow the steps below to pr
```

```bash
source ~/. bash_profile
source ~/.bash_profile
```

> **Note:**
Expand All @@ -64,7 +64,7 @@ With the toolchain ready, you still need a local Kubernetes cluster as the deplo
hack/kind-cluster-build.sh
```

The above script will create a Kubernetes cluster by kind. When you don't need this cluster, you can run the following command to delete it:
The above script will create a Kubernetes cluster by kind. When you don't need this cluster, you can run the following command to delete it:
```bash
kind delete cluster --name=kind
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-1.0.0/installation/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Before you start running a chaos experiment, verify if Chaos Mesh is installed c
If you are using k3s or k3d, please also specify `--k3s` flag.

<PickVersion className="language-bash">
curl -sSL https://mirrors.chaos-mesh.org/latest/install.sh --k3s | bash
curl -sSL https://mirrors.chaos-mesh.org/latest/install.sh | bash -s -- --k3s
</PickVersion>

### Verify your installation
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-1.0.1/development_guides/setup_env.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: set_up_the_development_environment
id: set_up_the_development_environment
title: Set up the development environment
sidebar_label: Set up the development environment
---
Expand Down Expand Up @@ -41,7 +41,7 @@ Make sure you have the above prerequisites met. Now follow the steps below to pr
```

```bash
source ~/. bash_profile
source ~/.bash_profile
```

> **Note:**
Expand All @@ -64,7 +64,7 @@ With the toolchain ready, you still need a local Kubernetes cluster as the deplo
hack/kind-cluster-build.sh
```

The above script will create a Kubernetes cluster by kind. When you don't need this cluster, you can run the following command to delete it:
The above script will create a Kubernetes cluster by kind. When you don't need this cluster, you can run the following command to delete it:
```bash
kind delete cluster --name=kind
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-1.0.1/get_started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Before you start running a chaos experiment, verify if Chaos Mesh is installed c
If you are using k3s or k3d, please also specify `--k3s` flag.

<PickVersion className="language-bash">
curl -sSL https://mirrors.chaos-mesh.org/latest/install.sh --k3s | bash
curl -sSL https://mirrors.chaos-mesh.org/latest/install.sh | bash -s -- --k3s
</PickVersion>

### Verify your installation
Expand Down

0 comments on commit 542e8e0

Please sign in to comment.