From 542e8e02148bf99de12b5a347e025c7b54eb4f4d Mon Sep 17 00:00:00 2001 From: CWen Date: Thu, 5 Nov 2020 11:54:57 +0800 Subject: [PATCH] docs: update install guide (#4) * update document Signed-off-by: cwen0 * fix develop guide Signed-off-by: cwen0 --- .gitignore | 1 + docs/development_guides/setup_env.md | 6 +++--- docs/get_started/installation.md | 2 +- .../version-0.9.1/development_guides/setup_env.md | 6 +++--- versioned_docs/version-0.9.1/installation/installation.md | 2 +- .../version-1.0.0/development_guides/setup_env.md | 6 +++--- versioned_docs/version-1.0.0/installation/installation.md | 2 +- .../version-1.0.1/development_guides/setup_env.md | 6 +++--- versioned_docs/version-1.0.1/get_started/installation.md | 2 +- 9 files changed, 17 insertions(+), 16 deletions(-) diff --git a/.gitignore b/.gitignore index b2d6de30624f6..a36d2b4570127 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,7 @@ .cache-loader # Misc +.idea .DS_Store .env.local .env.development.local diff --git a/docs/development_guides/setup_env.md b/docs/development_guides/setup_env.md index 9b6c8358c2a07..aaf583be73694 100644 --- a/docs/development_guides/setup_env.md +++ b/docs/development_guides/setup_env.md @@ -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 --- @@ -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:** @@ -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 diff --git a/docs/get_started/installation.md b/docs/get_started/installation.md index 6b6ca32491ca5..a6a2b65621634 100644 --- a/docs/get_started/installation.md +++ b/docs/get_started/installation.md @@ -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. - 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 ### Verify your installation diff --git a/versioned_docs/version-0.9.1/development_guides/setup_env.md b/versioned_docs/version-0.9.1/development_guides/setup_env.md index 9b6c8358c2a07..aaf583be73694 100644 --- a/versioned_docs/version-0.9.1/development_guides/setup_env.md +++ b/versioned_docs/version-0.9.1/development_guides/setup_env.md @@ -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 --- @@ -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:** @@ -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 diff --git a/versioned_docs/version-0.9.1/installation/installation.md b/versioned_docs/version-0.9.1/installation/installation.md index ce2f9052187cb..bafd0f2bcaa29 100644 --- a/versioned_docs/version-0.9.1/installation/installation.md +++ b/versioned_docs/version-0.9.1/installation/installation.md @@ -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. - 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 ### Verify your installation diff --git a/versioned_docs/version-1.0.0/development_guides/setup_env.md b/versioned_docs/version-1.0.0/development_guides/setup_env.md index 9b6c8358c2a07..aaf583be73694 100644 --- a/versioned_docs/version-1.0.0/development_guides/setup_env.md +++ b/versioned_docs/version-1.0.0/development_guides/setup_env.md @@ -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 --- @@ -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:** @@ -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 diff --git a/versioned_docs/version-1.0.0/installation/installation.md b/versioned_docs/version-1.0.0/installation/installation.md index cd2c63bae0f9e..989a5745d763e 100644 --- a/versioned_docs/version-1.0.0/installation/installation.md +++ b/versioned_docs/version-1.0.0/installation/installation.md @@ -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. - 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 ### Verify your installation diff --git a/versioned_docs/version-1.0.1/development_guides/setup_env.md b/versioned_docs/version-1.0.1/development_guides/setup_env.md index 9b6c8358c2a07..aaf583be73694 100644 --- a/versioned_docs/version-1.0.1/development_guides/setup_env.md +++ b/versioned_docs/version-1.0.1/development_guides/setup_env.md @@ -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 --- @@ -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:** @@ -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 diff --git a/versioned_docs/version-1.0.1/get_started/installation.md b/versioned_docs/version-1.0.1/get_started/installation.md index cd2c63bae0f9e..989a5745d763e 100644 --- a/versioned_docs/version-1.0.1/get_started/installation.md +++ b/versioned_docs/version-1.0.1/get_started/installation.md @@ -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. - 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 ### Verify your installation