From f827b00365e5afb429f9ad9b149478f981738eb8 Mon Sep 17 00:00:00 2001 From: Arhell Date: Mon, 29 Jan 2024 11:04:57 +0200 Subject: [PATCH] update some docs for docusaurus v3 Signed-off-by: Arhell --- blog/2022-10-26-test-report/index.md | 14 +++++++------- docs/contributor/contribute-docs.md | 4 ++-- docs/installation/install-binary.md | 6 +++--- docs/releases.md | 2 +- .../current/releases.md | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/blog/2022-10-26-test-report/index.md b/blog/2022-10-26-test-report/index.md index d68dd84f..da31b26d 100644 --- a/blog/2022-10-26-test-report/index.md +++ b/blog/2022-10-26-test-report/index.md @@ -74,17 +74,17 @@ With reference to the SLI (Service Level Indicator)/SLO (Service Level Objective 1. API Call Latency -| Status | SLI | SLO | -|---------|--------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------| -| Official | P99 latency of Mutating API calls (including POST, PUT, DELETE, PATCH) to a single resource object in the last 5 minutes | P99 <= 1s | -| Official | P99 latency of non-streaming read-only API calls (including GET and LIST) in the last 5 minutes | (a)Scope=resource, P99 <= 1s, (b)Scope=namespace or Scope=cluster, P99 <= 30s | +| Status | SLI | SLO | +|---------|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------| +| Official | P99 latency of Mutating API calls (including POST, PUT, DELETE, PATCH) to a single resource object in the last 5 minutes | P99 \<\= 1s | +| Official | P99 latency of non-streaming read-only API calls (including GET and LIST) in the last 5 minutes | (a)Scope=resource, P99 \<\= 1s, (b)Scope=namespace or Scope=cluster, P99 \<\= 30s | 2. Resource Distribution Latency -| Status | SLI | SLO | -|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| -| Official | After the user submits the resource template and delivers the policy on the federated control plane, the P99 delay from the time when the resource is created on the member cluster, regardless of the network fluctuation between the control plane and the member cluster | P99 <= 2s | +| Status | SLI | SLO | +|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Official | After the user submits the resource template and delivers the policy on the federated control plane, the P99 delay from the time when the resource is created on the member cluster, regardless of the network fluctuation between the control plane and the member cluster | P99 \<\= 2s | 3. Cluster Registration Latency diff --git a/docs/contributor/contribute-docs.md b/docs/contributor/contribute-docs.md index 11a1c667..13c22974 100644 --- a/docs/contributor/contribute-docs.md +++ b/docs/contributor/contribute-docs.md @@ -111,7 +111,7 @@ Creating a sidebar is useful to: * Display a sidebar on each of those documents * Provide paginated navigation, with next/previous button -For our docs, you can know how our documents are organized from . +For our docs, you can know how our documents are organized from [https://github.com/karmada-io/website/blob/main/sidebars.js](https://github.com/karmada-io/website/blob/main/sidebars.js). ``` module.exports = { @@ -157,7 +157,7 @@ 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 . +* 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](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. diff --git a/docs/installation/install-binary.md b/docs/installation/install-binary.md index 049facad..2578483c 100644 --- a/docs/installation/install-binary.md +++ b/docs/installation/install-binary.md @@ -52,7 +52,7 @@ Execute operations at `karmada-01`. Download the `kubernetes` binary package. -Refer to this page to download binaries of different versions and architectures: +Refer to this page to download binaries of different versions and architectures: [https://kubernetes.io/releases/download/#binaries](https://kubernetes.io/releases/download/#binaries) ```bash wget https://dl.k8s.io/v1.23.3/kubernetes-server-linux-amd64.tar.gz @@ -65,7 +65,7 @@ mv kube-apiserver kube-controller-manager kubectl /usr/local/sbin/ Download the `etcd` binary package. -You may want to use a newer version of etcd, please refer to this page: +You may want to use a newer version of etcd, please refer to this page: [https://etcd.io/docs/latest/install/](https://etcd.io/docs/latest/install/) ```bash wget https://github.com/etcd-io/etcd/releases/download/v3.5.1/etcd-v3.5.1-linux-amd64.tar.gz @@ -943,7 +943,7 @@ systemctl status karmada-webhook.service ### Configurate karmada-webhook -Download the `webhook-configuration.yaml` file: +Download the `webhook-configuration.yaml` file: [https://github.com/karmada-io/karmada/blob/master/artifacts/deploy/webhook-configuration.yaml](https://github.com/karmada-io/karmada/blob/master/artifacts/deploy/webhook-configuration.yaml) ```bash ca_string=$(cat /etc/karmada/pki/server-ca.crt | base64 | tr "\n" " "|sed s/[[:space:]]//g) diff --git a/docs/releases.md b/docs/releases.md index 6fa6cae0..47dbce55 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -75,7 +75,7 @@ For example, [here](https://hub.docker.com/r/karmada/karmada-controller-manager) Since v1.2.0, the following artifacts are uploaded: * crds.tar.gz -* karmada-chart-v.tgz +* karmada-chart-v\.tgz * karmadactl-darwin-amd64.tgz * karmadactl-darwin-amd64.tgz.sha256 * karmadactl-darwin-arm64.tgz diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/releases.md b/i18n/zh/docusaurus-plugin-content-docs/current/releases.md index 0b1cd6ea..4d91218a 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/releases.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/releases.md @@ -75,7 +75,7 @@ For example, [here](https://hub.docker.com/r/karmada/karmada-controller-manager) Since v1.2.0, the following artifacts are uploaded: * crds.tar.gz -* karmada-chart-v.tgz +* karmada-chart-v\.tgz * karmadactl-darwin-amd64.tgz * karmadactl-darwin-amd64.tgz.sha256 * karmadactl-darwin-arm64.tgz