Merge pull request honojs#416 from calvin-puram/fix-typos

fix typos

Author: karmada-bot

docs/administrator/backup/working-with-velero.md

@@ -2,7 +2,7 @@
 title: Integrate Velero to back up and restore Karmada resources
 ---
 
-[Velero](https://github.com/vmware-tanzu/velero) gives you tools to back up and restore 
+[Velero](https://github.com/vmware-tanzu/velero) gives you tools to back up and restore
 your Kubernetes cluster resources and persistent volumes. You can run Velero with a public
 cloud platform or on-premises.
 
@@ -48,9 +48,9 @@ Run this command to start `MinIO`:
 ./minio server /data --console-address="0.0.0.0:20001" --address="0.0.0.0:9000"
 ```
 
-Replace `/data` with the path to the drive or directory in which you want `MinIO` to store data. And now we can visit 
+Replace `/data` with the path to the drive or directory in which you want `MinIO` to store data. And now we can visit
 `http://{SERVER_EXTERNAL_IP}/20001` in the browser to visit `MinIO` console UI. And `Velero` can use
-`http://{SERVER_EXTERNAL_IP}/9000` to connect `MinIO`. The two configuration will make our follow-up work easier and more convenient.
+`http://{SERVER_EXTERNAL_IP}/9000` to connect `MinIO`. The two configurations will make our follow-up work easier and more convenient.
 
 Please visit `MinIO` console to create region `minio` and bucket `velero`, these will be used by `Velero`.
 
@@ -64,32 +64,32 @@ Velero consists of two components:
   ```shell
   wget https://github.com/vmware-tanzu/velero/releases/download/v1.7.0/velero-v1.7.0-linux-amd64.tar.gz
   ```
-  
+
   2. Extract the tarball:
   ```shell
   tar -zxvf velero-v1.7.0-linux-amd64.tar.gz
   ```
-  
+
   3. Move the extracted velero binary to somewhere in your $PATH (/usr/local/bin for most users).
   ```shell
   cp velero-v1.7.0-linux-amd64/velero /usr/local/bin/
   ```
 
 - ### A server that runs on your cluster
    We will use `velero install` to set up server components.
-  
+
    For more details about how to use `MinIO` and `Velero` to backup resources, please ref: https://velero.io/docs/v1.7/contributions/minio/
-  
+
    1. Create a Velero-specific credentials file (credentials-velero) in your local directory:
    ```shell
    [default]
    aws_access_key_id = minio
    aws_secret_access_key = minio123
    ```
    The two values should keep the same with `MinIO` username and password that we set when we install `MinIO`
-  
+
    2. Start the server.
-   
+
    We need to install `Velero` in both `member1` and `member2`, so we should run the below command in shell for both two clusters,
    this will start Velero server. Please run `kubectl config use-context member1` and `kubectl config use-context member2`
    to switch to the different member clusters: `member1` or `member2`.
@@ -104,13 +104,13 @@ Velero consists of two components:
    ```
    Replace `{SERVER_EXTERNAL_IP}` with your own server external IP.
 
-   3. Deploy the nginx application to cluster `member1`: 
-  
+   3. Deploy the nginx application to cluster `member1`:
+
    Run the below command in the Karmada directory.
    ```shell
    kubectl apply -f samples/nginx/deployment.yaml
    ```
-  
+
    And then you will find nginx is deployed successfully.
    ```shell
    # kubectl get deployment.apps
@@ -152,7 +152,7 @@ NAME                          BACKUP         STATUS      STARTED
 nginx-backup-20211210151807   nginx-backup   Completed   2021-12-10 15:18:07 +0800 CST   2021-12-10 15:18:07 +0800 CST   0        0          2021-12-10 15:18:07 +0800 CST   <none>
 ```
 
-And then you can find deployment nginx will be restored successfully. 
+And then you can find deployment nginx will be restored successfully.
 ```shell
 # kubectl get deployment.apps/nginx
 NAME    READY   UP-TO-DATE   AVAILABLE   AGE
@@ -161,9 +161,9 @@ nginx   2/2     2            2           21s
 
 ### Backup and restore of kubernetes resources through Velero combined with karmada
 
-In Karmada control plane, we need to install velero crds but do not need controllers to reconcile them. They are treated as resource templates, not specific resource instances.Based on work API here, they will be encapsulated as a work object deliverd to member clusters and reconciled by velero controllers in member clusters finally.
+In Karmada control plane, we need to install velero crds but do not need controllers to reconcile them. They are treated as resource templates, not specific resource instances. Based on work API here, they will be encapsulated as a work object delivered to member clusters and reconciled by velero controllers in member clusters finally.
 
-Create velero crds in Karmada control plane: 
+Create velero crds in Karmada control plane:
 remote velero crd directory: `https://github.com/vmware-tanzu/helm-charts/tree/main/charts/velero/crds/`
 
 Create a backup in `karmada-apiserver` and Distributed to `member1` cluster through PropagationPolicy
@@ -245,7 +245,7 @@ EOF
 
 ```
 
-And then you can find deployment nginx will be restored on member2 successfully. 
+And then you can find deployment nginx will be restored on member2 successfully.
 ```shell
 # kubectl get deployment.apps/nginx
 NAME    READY   UP-TO-DATE   AVAILABLE   AGE

docs/administrator/migration/migration-from-kubefed.md

@@ -2,26 +2,26 @@
 title: Migration From Kubefed
 ---
 
-Karmada is developed in continuation of Kubernetes [Federation v1](https://github.com/kubernetes-retired/federation) 
+Karmada is developed in continuation of Kubernetes [Federation v1](https://github.com/kubernetes-retired/federation)
 and [Federation v2(aka Kubefed)](https://github.com/kubernetes-sigs/kubefed). Karmada inherited a lot of concepts
 from these two versions. For example:
 
-- **Resource template**: Karmada uses Kubernetes Native API definition for federated resource template, 
+- **Resource template**: Karmada uses Kubernetes Native API definition for federated resource template,
   to make it easy to integrate with existing tools that already adopt Kubernetes.
-- **Propagation Policy**: Karmada offers a standalone Propagation(placement) Policy API to define multi-cluster 
+- **Propagation Policy**: Karmada offers a standalone Propagation(placement) Policy API to define multi-cluster
   scheduling and spreading requirements.
 - **Override Policy**: Karmada provides a standalone Override Policy API for specializing cluster relevant
-  configuration automation. 
+  configuration automation.
 
 Most of the features in Kubefed have been reformed in Karmada, so Karmada would be the natural successor.
 
 Generally speaking, migrating from Kubefed to Karmada would be pretty easy.
-This document outlines the basic migrate path for Kubefed users.
+This document outlines the basic migration path for Kubefed users.
 **Note:** This document is a work in progress, any feedback would be welcome.
 
 ## Cluster Registration
 
-Kubefed provides `join` and `unjoin` commands in `kubefedctl` command line tool, Karmada also implemented the 
+Kubefed provides `join` and `unjoin` commands in `kubefedctl` command line tool, Karmada also implemented the
 two commands in `karmadactl`.
 
 Refer to [Kubefed Cluster Registration](https://github.com/kubernetes-sigs/kubefed/blob/master/docs/cluster-registration.md),
@@ -38,7 +38,7 @@ kubefedctl join cluster1 --cluster-context cluster1 --host-cluster-context clust
 
 Now with Karmada, you can use `karmadactl` tool to do the same thing:
 ```
-karmadactl join cluster1 --cluster-context cluster1 --karmada-context karmada 
+karmadactl join cluster1 --cluster-context cluster1 --karmada-context karmada
 ```
 
 The behavior behind the `join` command is similar between Kubefed and Karmada. For Kubefed, it will create a
@@ -68,7 +68,7 @@ member1   v1.20.7   Push   True    66s
 ```
 
 Kubefed manages clusters with `Push` mode, however Karmada supports both `Push` and `Pull` modes.
-Refer to [Overview of cluster mode](https://karmada.io/docs/userguide/clustermanager/cluster-registration) for 
+Refer to [Overview of cluster mode](https://karmada.io/docs/userguide/clustermanager/cluster-registration) for
 more details.
 
 ### Unjoining clusters
@@ -82,7 +82,7 @@ kubefedctl unjoin cluster2 --cluster-context cluster2 --host-cluster-context clu
 Now with Karmada, you can use `karmadactl` tool to do the same thing:
 
 ```
-karmadactl unjoin cluster2 --cluster-context cluster2 --karmada-context karmada 
+karmadactl unjoin cluster2 --cluster-context cluster2 --karmada-context karmada
 ```
 
 The behavior behind the `unjoin` command is similar between Kubefed and Karmada, they both remove the cluster
@@ -178,8 +178,8 @@ spec:
         - cluster2
 ```
 
-The `PropagationPolicy` defines the rules of which resources(`resourceSelectors`) should be propagated to 
-where (`placement`). 
+The `PropagationPolicy` defines the rules of which resources(`resourceSelectors`) should be propagated to
+where (`placement`).
 See [Resource Propagating](https://karmada.io/docs/userguide/scheduling/resource-propagating) for more details.
 
 For the `override` part, Karmada provides `OverridePolicy` API to hold the rules for differentiation：
@@ -215,7 +215,7 @@ spec:
             value: 1.17.0-alpine
 ```
 
-The `OverridePolicy` defines the rules of which resources(`resourceSelectors`) should be overwritten when 
+The `OverridePolicy` defines the rules of which resources(`resourceSelectors`) should be overwritten when
 propagating to where(`targetCluster`).
 
 In addition to Kubefed, Karmada offers various alternatives to declare the override rules, see
@@ -225,9 +225,9 @@ In addition to Kubefed, Karmada offers various alternatives to declare the overr
 
 ### Will Karmada provide tools to smooth the migration?
 
-We don't have the plan yet, as we reached some Kubefed users and found that they're usually not using vanilla 
+We don't have the plan yet, as we reached some Kubefed users and found that they're usually not using vanilla
 Kubefed but the forked version, they extended Kubefed a lot to meet their requirements. So, it might be pretty
 hard to maintain a common tool to satisfy most users.
 
-We are also looking forward more feedback now, please feel free to reach us, and we are glad to support you
+We are also looking forward to more feedback now, please feel free to reach us, and we are glad to support you
 finish the migration.

docs/administrator/monitoring/working-with-filebeat.md

@@ -2,21 +2,21 @@
 title: Use Filebeat to collect logs of Karmada member clusters
 ---
 
-[Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is a lightweight shipper for forwarding and centralizing log data. Installed as an agent on your servers, Filebeat monitors the log files or locations that you specify, collects log events, and forwards them either to [Elasticsearch](https://www.elastic.co/products/elasticsearch) or [kafka](https://github.com/apache/kafka) for indexing. 
+[Filebeat](https://github.com/elastic/beats/tree/master/filebeat) is a lightweight shipper for forwarding and centralizing log data. Installed as an agent on your servers, Filebeat monitors the log files or locations that you specify, collects log events, and forwards them either to [Elasticsearch](https://www.elastic.co/products/elasticsearch) or [kafka](https://github.com/apache/kafka) for indexing.
 
-This document demonstrates how to use the `Filebeat` to collect logs of Karmada member clusters. 
+This document demonstrates how to use the `Filebeat` to collect logs of Karmada member clusters.
 
 ## Start up Karmada clusters
 
-You just need to clone Karmada repo, and run the following script in Karmada directory. 
+You just need to clone Karmada repo, and run the following script in Karmada directory.
 
 ```bash
 hack/local-up-karmada.sh
 ```
 
 ## Start Filebeat
 
-1. Create resource objects of Filebeat, the content is as follows. You can specify a list of inputs in the `filebeat.inputs` section of the `filebeat.yml`. Inputs specify how Filebeat locates and processes input data, also you can configure Filebeat to write to a specific output by setting options in the `Outputs` section of the `filebeat.yml` config file. The example will collect the log information of each container and write the collected logs to a file. More detailed information about the input and output configuration, please refer to: https://github.com/elastic/beats/tree/master/filebeat/docs
+1. Create resource objects of Filebeat, the content is as follows. You can specify a list of inputs in the `filebeat.inputs` section of the `filebeat.yml`. Inputs specify how Filebeat locates and processes input data, also you can configure Filebeat to write to a specific output by setting options in the `Outputs` section of the `filebeat.yml` config file. The example will collect the log information of each container and write the collected logs to a file. For more detailed information about the input and output configuration, please refer to: https://github.com/elastic/beats/tree/master/filebeat/docs
 
    ```yaml
    apiVersion: v1
@@ -89,11 +89,11 @@ hack/local-up-karmada.sh
        #        type: container
        #        paths:
        #          - /var/log/containers/*${data.kubernetes.container.id}.log
-   
+
        processors:
          - add_cloud_metadata:
          - add_host_metadata:
-   
+
        #output.elasticsearch:
        #  hosts: ['${ELASTICSEARCH_HOST:elasticsearch}:${ELASTICSEARCH_PORT:9200}']
        #  username: ${ELASTICSEARCH_USERNAME}
@@ -179,7 +179,7 @@ hack/local-up-karmada.sh
              type: DirectoryOrCreate
    ```
 
-2. Run the below command to execute Karmada PropagationPolicy and ClusterPropagationPolicy. 
+2. Run the below command to execute Karmada PropagationPolicy and ClusterPropagationPolicy.
 
    ```
    cat <<EOF | kubectl apply -f -

docs/contributor/cherry-picks.md

@@ -80,7 +80,7 @@ patch release branches.
   ```
 
   - Be aware the cherry pick script assumes you have a git remote called
-    `upstream` that points at the Karmada github org.
+    `upstream` that points to the Karmada github org.
 
   - You will need to run the cherry pick script separately for each patch
     release you want to cherry pick to. Cherry picks should be applied to all

docs/contributor/contribute-docs.md

@@ -13,7 +13,7 @@ the `karmada-io/website` repository.
 - Docs need to be translated into multiple languages for readers from different regions.
   The community now supports both Chinese and English.
   English is the official language of documentation.
-- For our docs we use markdown. If you are unfamiliar with Markdown, please see https://guides.github.com/features/mastering-markdown/ or https://www.markdownguide.org/ if you are looking for something more substantial. 
+- For our docs we use markdown. If you are unfamiliar with Markdown, please see https://guides.github.com/features/mastering-markdown/ or https://www.markdownguide.org/ if you are looking for something more substantial.
 - We get some additions through [Docusaurus 2](https://docusaurus.io/), a model static website generator.
 
 ## Setup
@@ -86,7 +86,7 @@ title: A doc with tags
 ```
 
 The top section between two lines of --- is the Front Matter section. Here we define a couple of entries which tell Docusaurus how to handle the article:
-* Title is the equivalent of the `<h1>` in a HTML document or `# <title>` in a Markdown article.
+* Title is the equivalent of the `<h1>` in an HTML document or `# <title>` in a Markdown article.
 * Each document has a unique ID. By default, a document ID is the name of the document (without the extension) related to the root docs directory.
 
 ### Linking to other docs
@@ -102,9 +102,9 @@ You can easily route to other places by adding any of the following links:
   Now we store public pictures about Karmada in `/docs/resources/general`. You can use the following to link the pictures:
   * `![Git workflow](../resources/contributor/git_workflow.png)`
 
-### Directory organization 
+### Directory organization
 
-Docusaurus 2 uses a sidebar to manage documents. 
+Docusaurus 2 uses a sidebar to manage documents.
 
 Creating a sidebar is useful to:
 * Group multiple related documents
@@ -157,14 +157,14 @@ If you add a document, you must add it to `sidebars.js` to make it display prope
 ### About Chinese docs
 
 If you want to contribute to our Chinese documentation, you can:
-* Translate our existing English docs to Chinese. In this case, you need to modify the corresponding file content from <https://github.com/karmada-io/website/tree/main/i18n/zh/docusaurus-plugin-content-docs/current>. 
+* Translate our existing English docs to Chinese. In this case, you need to modify the corresponding file content from <https://github.com/karmada-io/website/tree/main/i18n/zh/docusaurus-plugin-content-docs/current>.
   The organization of this directory is exactly the same as the outer layer. `current.json` holds translations for the documentation directory. You can edit it if you want to translate the name of directory.
 * Submit Chinese docs without the English version. No limits on the topic or category. In this case, you can add an empty article and its title to the main directory first, and complete the rest later.
   Then add the corresponding Chinese content to the Chinese directory.
 
 ## Debugging docs
 
-Now you have already completed docs. After you start a PR to `karmada.io/website`, if you have passed CI, you can get a preview of your document on the website.
+Now you have already completed the docs. After you start a PR to `karmada.io/website`, if you have passed CI, you can get a preview of your document on the website.
 
 Click **Details** marked in red, and you will enter the preview view of the website.
 

docs/contributor/count-contributions.md

@@ -4,7 +4,7 @@ title: Correct your information for better contribution
 
 After contributing to [karmada-io](https://github.com/karmada-io) through issues, comments, pull requests, etc., you can check your contributions [here](https://karmada.devstats.cncf.io/d/66/developer-activity-counts-by-companies).
 
- If you notice that the information in the company column is either incorrect or blank, we highly recommend that you correct it. 
+ If you notice that the information in the company column is either incorrect or blank, we highly recommend that you correct it.
 
 For instance, `Huawei Technologies Co. Ltd`should be used instead of `HUAWEI`:
 ![Wrong Information](../resources/contributor/contributions_list.png)
@@ -14,11 +14,11 @@ Here are the steps to fix this issue.
 ## Verify your organization in the CNCF system
 To begin, visit your profile [page](https://openprofile.dev/edit/profile) and ensure that your organization is accurate.
 ![organization-check](../resources/contributor/organization_check.png)
-* If the organization incorrect, please select the right one.
-* If your organization is not in the list, clieck on **Add** to add your organization.
+* If the organization is incorrect, please select the right one.
+* If your organization is not on the list, click on **Add** to add your organization.
 
 ## Update the CNCF repository used for calculating your contributions
-Once you have verified your organization in the CNCF system, you must create a pull request in gitdm with the updated affiliations.  
+Once you have verified your organization in the CNCF system, you must create a pull request in gitdm with the updated affiliations.
 To do this, you'll need to modify two files: `company_developers*.txt` and `developers_affiliations*.txt`. For reference, please see this example pull request: [PR Example](https://github.com/cncf/gitdm/pull/1257).
 
 After the pull request has been successfully merged, it may take up to four weeks for the changes to be synced.