From 5d2854b747d34759a66093e0026643cd4a58aecc Mon Sep 17 00:00:00 2001 From: Long Dai Date: Fri, 14 May 2021 09:10:01 +0800 Subject: [PATCH] docs: clean up whitenoise Signed-off-by: Long Dai --- CONTRIBUTING.md | 14 +++++++------- README.md | 8 ++++---- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4f0b82a9129..8f943d0c62f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ Please make sure to read and observe our [Code of Conduct](/CODE_OF_CONDUCT.md). ## Community Expectations Karmada is a community project driven by its community which strives to promote a healthy, friendly and productive environment. -Karmada aims to provide turnkey automation for multi-cluster application management in multi-cloud and hybrid cloud scenarios, +Karmada aims to provide turnkey automation for multi-cluster application management in multi-cloud and hybrid cloud scenarios, and intended to realize multi-cloud centralized management, high availability, failure recovery and traffic scheduling. # Getting started @@ -37,10 +37,10 @@ and intended to realize multi-cloud centralized management, high availability, f # Your First Contribution -We will help you to contribute in different areas like filing issues, developing features, fixing critical bugs and +We will help you to contribute in different areas like filing issues, developing features, fixing critical bugs and getting your work reviewed and merged. -If you have questions about the development process, +If you have questions about the development process, feel free to [file an issue](https://github.com/karmada-io/karmada/issues/new/choose). ## Find something to work on @@ -53,13 +53,13 @@ Here is how you get started. There are [multiple repositories](https://github.com/karmada-io/) within the Karmada organization. Each repository has beginner-friendly issues that provide a good first issue. -For example, [karmada-io/karmada](https://github.com/karmada-io/karmada) has -[help wanted](https://github.com/karmada-io/karmada/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) and -[good first issue](https://github.com/karmada-io/karmada/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) +For example, [karmada-io/karmada](https://github.com/karmada-io/karmada) has +[help wanted](https://github.com/karmada-io/karmada/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) and +[good first issue](https://github.com/karmada-io/karmada/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) labels for issues that should not need deep knowledge of the system. We can help new contributors who wish to work on such issues. -Another good way to contribute is to find a documentation improvement, such as a missing/broken link. +Another good way to contribute is to find a documentation improvement, such as a missing/broken link. Please see [Contributing](#contributing) below for the workflow. #### Work on an issue diff --git a/README.md b/README.md index dca55f3de5aa..a5629b95dd50 100644 --- a/README.md +++ b/README.md @@ -141,11 +141,11 @@ The two `KUBECONFIG` files after the script run are: The `karmada-apiserver.config` is the **main kubeconfig** to be used when interacting with karamda control plane, while `karmada-host.config` is only used for debuging karmada installation with host cluster. ### Join member cluster -In the following steps, we are going to create a member cluster and then join the cluster to +In the following steps, we are going to create a member cluster and then join the cluster to karmada control plane. #### 1. Create member cluster -We are going to create a cluster named `member1` and we want the `KUBECONFIG` file +We are going to create a cluster named `member1` and we want the `KUBECONFIG` file in `/root/.kube/member1.config`. Run following command: ``` # hack/create-cluster.sh member1 /root/.kube/member1.config @@ -153,7 +153,7 @@ in `/root/.kube/member1.config`. Run following command: The script `hack/create-cluster.sh` will create a standalone cluster. #### 2. Join member cluster to karmada control plane -The command `karmadactl` will help to join the member cluster to karmada control plane, +The command `karmadactl` will help to join the member cluster to karmada control plane, before that, we should set `KUBECONFIG` to karmada apiserver: ``` # export KUBECONFIG=/var/run/karmada/karmada-apiserver.config @@ -187,7 +187,7 @@ First, create a [deployment](samples/nginx/deployment.yaml) named `nginx`: Then, we need create a policy to drive the deployment to our member cluster. ``` # kubectl create -f samples/nginx/propagationpolicy.yaml -``` +``` #### 3. Check the deployment status from karmada You can check deployment status from karmada, don't need to access member cluster: