Karmada Metrics Documentation Improvement

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

@@ -113,7 +113,7 @@ Velero consists of two components:
 
    And then you will find nginx is deployed successfully.
    ```shell
-   # kubectl get deployment.apps
+   $ kubectl get deployment.apps
    NAME    READY   UP-TO-DATE   AVAILABLE   AGE
    nginx   2/2     2            2           17s
    ```
@@ -134,27 +134,27 @@ kubectl config use-context member2
 
 In `member2`, we can also get the backup that we created in `member1`:
 ```shell
-# velero backup get
+$ velero backup get
 NAME           STATUS      ERRORS   WARNINGS   CREATED                         EXPIRES   STORAGE LOCATION   SELECTOR
 nginx-backup   Completed   0        0          2021-12-10 15:16:46 +0800 CST   29d       default            app=nginx
 ```
 
 Restore `member1` resources to `member2`:
 ```shell
-# velero restore create --from-backup nginx-backup
+$ velero restore create --from-backup nginx-backup
 Restore request "nginx-backup-20211210151807" submitted successfully.
 ```
 
 Watch restore result, you'll find that the status is Completed.
 ```shell
-# velero restore get
+$ velero restore get
 NAME                          BACKUP         STATUS      STARTED                         COMPLETED                       ERRORS   WARNINGS   CREATED                         SELECTOR
 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.
 ```shell
-# kubectl get deployment.apps/nginx
+$ kubectl get deployment.apps/nginx
 NAME    READY   UP-TO-DATE   AVAILABLE   AGE
 nginx   2/2     2            2           21s
 ```
@@ -247,7 +247,7 @@ EOF
 
 And then you can find deployment nginx will be restored on member2 successfully.
 ```shell
-# kubectl get deployment.apps/nginx
+$ kubectl get deployment.apps/nginx
 NAME    READY   UP-TO-DATE   AVAILABLE   AGE
 nginx   2/2     2            2           10s
 ```

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

@@ -50,8 +50,8 @@ object to describe the joined cluster.
 
 Assume you use the `kubefedctl` tool to check the status of the joined clusters as follows:
 
-```
-kubectl -n kube-federation-system get kubefedclusters
+```bash
+$ kubectl -n kube-federation-system get kubefedclusters
 
 NAME       AGE   READY   KUBERNETES-VERSION
 cluster1   1m    True    v1.21.2
@@ -60,8 +60,8 @@ cluster2   1m    True    v1.22.0
 
 Now with Karmada, you can use `karmadactl` tool to do the same thing:
 
-```
-kubectl get clusters
+```bash
+$ kubectl get clusters
 
 NAME      VERSION   MODE   READY   AGE
 member1   v1.20.7   Push   True    66s

docs/developers/customize-karmada-scheduler.md

@@ -140,7 +140,7 @@ make image-karmada-scheduler
 ```
 
 ```shell
-kubectl --kubeconfig ~/.kube/karmada.config --context karmada-host edit deploy/karmada-scheduler -nkarmada-system
+$ kubectl --kubeconfig ~/.kube/karmada.config --context karmada-host edit deploy/karmada-scheduler -nkarmada-system
 ...
  spec:
       automountServiceAccountToken: false
@@ -175,7 +175,7 @@ You can config the plugin enablement by setting the flag `--plugins`.
 For example, the following config will disable `TestFilter` plugin.
 
 ```shell
-kubectl --kubeconfig ~/.kube/karmada.config --context karmada-host edit deploy/karmada-scheduler -nkarmada-system
+$ kubectl --kubeconfig ~/.kube/karmada.config --context karmada-host edit deploy/karmada-scheduler -nkarmada-system
 ...
  spec:
       automountServiceAccountToken: false

docs/developers/document-releasing.md

@@ -54,8 +54,8 @@ go build ./hack/tools/gencomponentdocs/.
 1. Update versions.json
 
 ```shell
-cd website/
-vim versions.json
+$ cd website/
+$ vim versions.json
 
 [
   v1.5  # add a new version tag

docs/developers/performance-test-setup-for-karmada.md

@@ -56,7 +56,7 @@ kubectl apply -f fakekubelet.yml
 `kubectl get node` You will find fake nodes.
 
 ```shell
-> kubectl get node -o wide
+$ kubectl get node -o wide
 NAME         STATUS   ROLES   AGE   VERSION   INTERNAL-IP   EXTERNAL-IP   OS-IMAGE    KERNEL-VERSION   CONTAINER-RUNTIME
 fake-0       Ready    agent   10s   fake      10.88.0.136   <none>        <unknown>   <unknown>        <unknown>
 fake-1       Ready    agent   10s   fake      10.88.0.136   <none>        <unknown>   <unknown>        <unknown>
@@ -68,7 +68,7 @@ fake-4       Ready    agent   10s   fake      10.88.0.136   <none>        <unkno
 Deploy an sample deployment to test:
 
 ```shell
-> kubectl apply -f - <<EOF
+kubectl apply -f - <<EOF
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -107,7 +107,7 @@ EOF
 `kubectl get pod` You will find that it has been started, although the image does not exist.
 
 ```shell
-> kubectl get pod -o wide
+$ kubectl get pod -o wide
 NAME                        READY   STATUS    RESTARTS   AGE   IP          NODE     NOMINATED NODE   READINESS GATES
 fake-pod-78884479b7-52qcx   1/1     Running   0          6s    10.0.0.23   fake-4   <none>           <none>
 fake-pod-78884479b7-bd6nk   1/1     Running   0          6s    10.0.0.13   fake-2   <none>           <none>

docs/developers/profiling-karmada.md

@@ -40,7 +40,7 @@ The HTTP endpoint will now be available as a local port.
 You can then generate the file for the memory profile with curl and pipe the data to a file:
 
 ```shell
-$ curl http://localhost:6060/debug/pprof/heap  > heap.pprof
+curl http://localhost:6060/debug/pprof/heap  > heap.pprof
 ```
 
 Generate the file for the CPU profile with curl and pipe the data to a file (7200 seconds is two hours):

docs/get-started/nginx-example.md

@@ -29,7 +29,7 @@ cd karmada
 run the following script:
 
 ```
-# hack/local-up-karmada.sh
+hack/local-up-karmada.sh
 ```
 This script will do the following tasks for you:
 - Start a Kubernetes cluster to run the Karmada control plane, aka. the `host cluster`.

docs/installation/install-binary.md

@@ -29,7 +29,7 @@ Step-by-step installation of binary high-availability `karmada` cluster.
 Execute operations at `karmada-01` `karmada-02` `karmada-03`.
 
 ```bash
-vi /etc/hosts
+$ vi /etc/hosts
 172.31.209.245	karmada-01
 172.31.209.246	karmada-02
 172.31.209.247	karmada-03
@@ -126,9 +126,9 @@ You normally don't need to change `*.sh` files.
 ### Step 3: Run Shell Scripts
 
 ```bash
-$ ./generate_ca.sh
-$ ./generate_leaf.sh ca_cert/
-$ ./generate_etcd.sh
+./generate_ca.sh
+./generate_leaf.sh ca_cert/
+./generate_etcd.sh
 ```
 
 
@@ -312,7 +312,7 @@ systemctl status etcd.service
 ### Verify
 
 ```bash
-etcdctl --cacert /etc/karmada/pki/etcd/ca.crt \
+$ etcdctl --cacert /etc/karmada/pki/etcd/ca.crt \
 	--cert /etc/karmada/pki/etcd/healthcheck-client.crt \
 	--key /etc/karmada/pki/etcd/healthcheck-client.key \
 	--endpoints "172.31.209.245:2379,172.31.209.246:2379,172.31.209.247:2379" \
@@ -515,7 +515,7 @@ Then, like `karmada-webhook`, use `nginx` for high availability.
 modify the `nginx` configuration and add the following configuration,Execute operations at `karmada-01`.
 
 ```bash
-cat /usr/local/karmada-nginx/conf/nginx.conf
+$ cat /usr/local/karmada-nginx/conf/nginx.conf
 worker_processes 2;
 
 events {
@@ -858,7 +858,7 @@ ok
 modify the `nginx` configuration and add the following configuration,Execute operations at `karmada-01`.
 
 ```bash
-cat /usr/local/karmada-nginx/conf/nginx.conf
+$ cat /usr/local/karmada-nginx/conf/nginx.conf
 worker_processes 2;
 
 events {

docs/installation/installation.md

@@ -82,7 +82,7 @@ Step 2: Show members of karmada
 
 The components of Karmada are installed in `karmada-system` namespace by default, you can get them by:
 ```bash
-kubectl get deployments -n karmada-system
+$ kubectl get deployments -n karmada-system
 NAME                           READY   UP-TO-DATE   AVAILABLE   AGE
 karmada-aggregated-apiserver   1/1     1            1           102s
 karmada-apiserver              1/1     1            1           2m34s
@@ -93,7 +93,7 @@ kube-controller-manager        1/1     1            1           2m3s
 ```
 And the `karmada-etcd` is installed as the `StatefulSet`, get it by:
 ```bash
-kubectl get statefulsets -n karmada-system
+$ kubectl get statefulsets -n karmada-system
 NAME   READY   AGE
 etcd   1/1     28m
 ```
@@ -140,7 +140,7 @@ kubectl karmada init --crds https://github.com/karmada-io/karmada/releases/downl
 
 Check installed components:
 ```bash
-kubectl get pods -n karmada-system --kubeconfig=$HOME/.kube/host.config
+$ kubectl get pods -n karmada-system --kubeconfig=$HOME/.kube/host.config
 NAME                                           READY   STATUS    RESTARTS   AGE
 etcd-0                                         1/1     Running   0          2m55s
 karmada-aggregated-apiserver-84b45bf9b-n5gnk   1/1     Running   0          109s