Skip to content

Commit

Permalink
update some docs for docusaurus v3
Browse files Browse the repository at this point in the history 
Signed-off-by: Arhell <arhell333@gmail.com>
  • Loading branch information
@Arhell
Arhell committed Jan 29, 2024
1 parent 9a9e27c commit f827b00
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
14 changes: 7 additions & 7 deletions blog/2022-10-26-test-report/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/contributor/contribute-docs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/karmada-io/website/blob/main/sidebars.js>.
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 = {
Expand Down Expand Up @@ -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 <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](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.
Expand Down
6 changes: 3 additions & 3 deletions docs/installation/install-binary.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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: <https://kubernetes.io/releases/download/#binaries>
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
Expand All @@ -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: <https://etcd.io/docs/latest/install/>
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
Expand Down Expand Up @@ -943,7 +943,7 @@ systemctl status karmada-webhook.service

### Configurate karmada-webhook

Download the `webhook-configuration.yaml` file: <https://github.com/karmada-io/karmada/blob/master/artifacts/deploy/webhook-configuration.yaml>
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)
Expand Down
2 changes: 1 addition & 1 deletion docs/releases.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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<version_number>.tgz
* karmada-chart-v\<version_number\>.tgz
* karmadactl-darwin-amd64.tgz
* karmadactl-darwin-amd64.tgz.sha256
* karmadactl-darwin-arm64.tgz
Expand Down
2 changes: 1 addition & 1 deletion i18n/zh/docusaurus-plugin-content-docs/current/releases.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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<version_number>.tgz
* karmada-chart-v\<version_number\>.tgz
* karmadactl-darwin-amd64.tgz
* karmadactl-darwin-amd64.tgz.sha256
* karmadactl-darwin-arm64.tgz
Expand Down

0 comments on commit f827b00

Please sign in to comment.