docs: Change document title

dragonflyoss · Apr 3, 2024 · 837ef2a · 837ef2a
1 parent fea3b1c
commit 837ef2a
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 73 deletions.
diff --git a/docs/getting-started/installation/binaries.md b/docs/getting-started/installation/binaries.md
@@ -9,7 +9,7 @@ This guide shows how to install the Dragonfly. Dragonfly can be installed either
 
 <!-- markdownlint-disable -->
 
-| Required Software | Version Limit                | Document                                                                     |
+| Name              | Version                      | Document                                                                     |
 | ----------------- | ---------------------------- | ---------------------------------------------------------------------------- |
 | Git               | 1.9.1+                       | [git-scm](https://git-scm.com/)                                              |
 | Golang            | 1.16.x                       | [go.dev](https://go.dev/)                                                    |

diff --git a/docs/getting-started/installation/helm-charts.md b/docs/getting-started/installation/helm-charts.md
@@ -10,7 +10,7 @@ Hugging Face, TorchServe, Triton Server, etc., refer to [Integrations](../../set
 
 ## Prerequisites {#prerequisites}
 
-| Required software  | Version | Document                                |
+| Name               | Version | Document                                |
 | ------------------ | ------- | --------------------------------------- |
 | Kubernetes cluster | 1.20+   | [kubernetes.io](https://kubernetes.io/) |
 | Helm               | v3.8.0+ | [helm.sh](https://helm.sh/)             |
@@ -160,8 +160,7 @@ export POD_NAME=$(kubectl get pods --namespace dragonfly-system -l "app=dragonfl
 export PEER_ID=$(kubectl -n dragonfly-system exec -it ${POD_NAME} -- grep "alpine" /var/log/dragonfly/daemon/core.log | awk -F'"peer":"' '{print $2}' | awk -F'"' '{print $1}' | head -n 1)
 
 # Check logs.
-kubectl -n dragonfly-system exec -it ${POD_NAME} -- grep ${PEER_ID} /var/log/dragonfly/daemon/
-core.log | grep "peer task done"
+kubectl -n dragonfly-system exec -it ${POD_NAME} -- grep ${PEER_ID} /var/log/dragonfly/daemon/core.log | grep "peer task done"
 ```
 
 <!-- markdownlint-restore -->

diff --git a/docs/getting-started/quick-start/kubernetes.md b/docs/getting-started/quick-start/kubernetes.md
@@ -7,22 +7,16 @@ slug: /getting-started/quick-start/kubernetes/
 
 Documentation for deploying Dragonfly on kubernetes using helm.
 
-You can have a quick start following [Helm Charts](../installation/helm-charts.md).
-We recommend to use `containerd with CRI` and `CRI-O` client.
-
-This table describes some container runtimes version and documents.
-
-<!-- markdownlint-disable -->
+## Runtime
 
-| Runtime                 | Version | Document                                         | CRI Support | Pull Command                                |
-| ----------------------- | ------- | ------------------------------------------------ | ----------- | ------------------------------------------- |
-| containerd<sup>\*</sup> | v1.1.0+ | [Link](../../setup/runtime/containerd/mirror.md) | Yes         | crictl pull docker.io/library/alpine:latest |
-| containerd without CRI  | v1.1.0  | [Link](../../setup/runtime/containerd/proxy.md)  | No          | ctr image pull docker.io/library/alpine     |
-| CRI-O                   | All     | [Link](../../setup/runtime/cri-o.md)             | Yes         | crictl pull docker.io/library/alpine:latest |
-
-<!-- markdownlint-restore -->
+You can have a quick start following [Helm Charts](../installation/helm-charts.md).
+We recommend to use `containerd`.
 
-`containerd` is recommended.
+| Runtime                 | Version | Document                                         |
+| ----------------------- | ------- | ------------------------------------------------ |
+| containerd              | v1.1.0+ | [Link](../../setup/runtime/containerd/mirror.md) |
+| Docker                  | v20.0.1+| [Link](../../setup/runtime/docker.md)            |
+| CRI-O                   | All     | [Link](../../setup/runtime/cri-o.md)             |
 
 ## Setup kubernetes cluster {#setup-kubernetes-cluster}
 

diff --git a/docs/getting-started/quick-start/multi-cluster-kubernetes.md b/docs/getting-started/quick-start/multi-cluster-kubernetes.md
@@ -17,22 +17,14 @@ and internal peers can only schedule and transmit data in a kubernetes cluster.
 
 ## Runtime
 
-You can have a quick start following [Helm Charts](../../installation/helm-charts).
-We recommend to use `containerd with CRI` and `CRI-O` client.
-
-This table describes some container runtimes version and documents.
-
-<!-- markdownlint-disable -->
-
-| Runtime                 | Version | Document                                         | CRI Support | Pull Command                                |
-| ----------------------- | ------- | ------------------------------------------------ | ----------- | ------------------------------------------- |
-| containerd<sup>\*</sup> | v1.1.0+ | [Link](../../setup/runtime/containerd/mirror.md) | Yes         | crictl pull docker.io/library/alpine:latest |
-| containerd without CRI  | v1.1.0  | [Link](../../setup/runtime/containerd/proxy.md)  | No          | ctr image pull docker.io/library/alpine     |
-| CRI-O                   | All     | [Link](../../setup/runtime/cri-o.md)             | Yes         | crictl pull docker.io/library/alpine:latest |
-
-<!-- markdownlint-restore -->
-
-`containerd` is recommended.
+You can have a quick start following [Helm Charts](../installation/helm-charts.md).
+We recommend to use `containerd`.
+
+| Runtime                 | Version | Document                                         |
+| ----------------------- | ------- | ------------------------------------------------ |
+| containerd              | v1.1.0+ | [Link](../../setup/runtime/containerd/mirror.md) |
+| Docker                  | v20.0.1+| [Link](../../setup/runtime/docker.md)            |
+| CRI-O                   | All     | [Link](../../setup/runtime/cri-o.md)             |
 
 ## Setup kubernetes cluster
 

diff --git a/...docusaurus-plugin-content-docs/current/getting-started/installation/binaries.md b/...docusaurus-plugin-content-docs/current/getting-started/installation/binaries.md
@@ -5,7 +5,7 @@ title: 使用二进制文件安装
 
 文档的目标是帮助您快速开始使用源码或构建的二进制版本部署 Dragonfly。
 
-## 依赖
+## 环境准备
 
 <!-- markdownlint-disable -->
 

diff --git a/...usaurus-plugin-content-docs/current/getting-started/installation/helm-charts.md b/...usaurus-plugin-content-docs/current/getting-started/installation/helm-charts.md
@@ -10,11 +10,11 @@ title: Helm Charts
 
 ## 环境准备
 
-| 所需软件           | 版本要求 | 文档                                    |
+| 所需软件            | 版本要求 | 文档                                      |
 | ------------------ | -------- | --------------------------------------- |
 | Kubernetes cluster | 1.19+    | [kubernetes.io](https://kubernetes.io/) |
 | Helm               | v3.8.0+  | [helm.sh](https://helm.sh/)             |
-| containerd        | v1.5.0+  | [containerd.io](https://containerd.io/) |
+| containerd         | v1.5.0+  | [containerd.io](https://containerd.io/) |
 
 ## 准备 Kubernetes 集群
 
@@ -155,12 +155,10 @@ docker exec -i kind-worker /usr/local/bin/crictl pull alpine:3.19
 export POD_NAME=$(kubectl get pods --namespace dragonfly-system -l "app=dragonfly,release=dragonfly,component=dfdaemon" -o=jsonpath='{.items[?(@.spec.nodeName=="kind-worker")].metadata.name}' | head -n 1 )
 
 # 获取 Peer ID
-export PEER_ID=$(kubectl -n dragonfly-system exec -it ${POD_NAME} -- grep "alpine" /var/log/dragonfly/
-daemon/core.log | awk -F'"peer":"' '{print $2}' | awk -F'"' '{print $1}' | head -n 1)
+export PEER_ID=$(kubectl -n dragonfly-system exec -it ${POD_NAME} -- grep "alpine" /var/log/dragonfly/daemon/core.log | awk -F'"peer":"' '{print $2}' | awk -F'"' '{print $1}' | head -n 1)
 
 # 查看下载日志
-kubectl -n dragonfly-system exec -it ${POD_NAME} -- grep ${PEER_ID} /var/log/dragonfly/
-daemon/core.log | grep "peer task done"
+kubectl -n dragonfly-system exec -it ${POD_NAME} -- grep ${PEER_ID} /var/log/dragonfly/daemon/core.log | grep "peer task done"
 ```
 
 <!-- markdownlint-restore -->

diff --git a/...ocusaurus-plugin-content-docs/current/getting-started/quick-start/kubernetes.md b/...ocusaurus-plugin-content-docs/current/getting-started/quick-start/kubernetes.md
@@ -7,23 +7,16 @@ slug: /getting-started/quick-start/kubernetes/
 
 文档的目标是帮助您快速开始使用 Helm 部署 Dragonfly。
 
-您可以根据 [Helm Charts](../installation/helm-charts.md)
-文档中的内容快速搭建 Dragonfly 的 Kubernetes 集群。
-我们推荐使用 `containerd with CRI` 和 `CRI-O` 客户端。
+## 容器运行时
 
-下表列出了一些容器的运行时、版本和文档。
+您可以根据 [Helm Charts](../installation/helm-charts.md)文档中的内容快速搭建 Dragonfly 的 Kubernetes 集群。
+我们推荐使用 `containerd`。
 
-<!-- markdownlint-disable -->
-
-| Runtime                 | Version | Document                                         | CRI Support | Pull Command                                |
-| ----------------------- | ------- | ------------------------------------------------ | ----------- | ------------------------------------------- |
-| containerd<sup>\*</sup> | v1.1.0+ | [Link](../../setup/runtime/containerd/mirror.md) | Yes         | crictl pull docker.io/library/alpine:latest |
-| containerd without CRI  | v1.1.0  | [Link](../../setup/runtime/containerd/proxy.md)  | No          | ctr image pull docker.io/library/alpine     |
-| CRI-O                   | All     | [Link](../../setup/runtime/cri-o.md)             | Yes         | crictl pull docker.io/library/alpine:latest |
-
-<!-- markdownlint-restore -->
-
-推荐使用 `containerd`.
+| 容器运行时                | 版本要求 |  文档                                             |
+| ----------------------- | ------- | ------------------------------------------------ |
+| containerd              | v1.1.0+ | [Link](../../setup/runtime/containerd/mirror.md) |
+| Docker                  | v20.0.1+| [Link](../../setup/runtime/docker.md)            |
+| CRI-O                   | All     | [Link](../../setup/runtime/cri-o.md)             |
 
 ## 准备 Kubernetes 集群
 

diff --git a/...in-content-docs/current/getting-started/quick-start/multi-cluster-kubernetes.md b/...in-content-docs/current/getting-started/quick-start/multi-cluster-kubernetes.md
@@ -15,25 +15,16 @@ Peers 只能在当前 Dragonfly 集群内 P2P 传输数据，所以一定要保
 
 ![multi-cluster-kubernetes](../../resource/getting-started/multi-cluster-kubernetes.png)
 
-## Runtime
+## 容器运行时
 
-您可以根据 [Helm Charts](../installation/helm-charts.md)
-文档中的内容快速搭建 Dragonfly 的 Kubernetes 集群。
-我们推荐使用 `containerd with CRI` 和 `CRI-O` 客户端。
+您可以根据 [Helm Charts](../installation/helm-charts.md)文档中的内容快速搭建 Dragonfly 的 Kubernetes 集群。
+我们推荐使用 `containerd`。
 
-下表列出了一些容器的运行时、版本和文档。
-
-<!-- markdownlint-disable -->
-
-| Runtime                 | Version | Document                                         | CRI Support | Pull Command                                |
-| ----------------------- | ------- | ------------------------------------------------ | ----------- | ------------------------------------------- |
-| containerd<sup>\*</sup> | v1.1.0+ | [Link](../../setup/runtime/containerd/mirror.md) | Yes         | crictl pull docker.io/library/alpine:latest |
-| containerd without CRI  | v1.1.0  | [Link](../../setup/runtime/containerd/proxy.md)  | No          | ctr image pull docker.io/library/alpine     |
-| CRI-O                   | All     | [Link](../../setup/runtime/cri-o.md)             | Yes         | crictl pull docker.io/library/alpine:latest |
-
-<!-- markdownlint-restore -->
-
-推荐使用 `containerd`.
+| 容器运行时                | 版本要求 |  文档                                             |
+| ----------------------- | ------- | ------------------------------------------------ |
+| containerd              | v1.1.0+ | [Link](../../setup/runtime/containerd/mirror.md) |
+| Docker                  | v20.0.1+| [Link](../../setup/runtime/docker.md)            |
+| CRI-O                   | All     | [Link](../../setup/runtime/cri-o.md)             |
 
 ## 准备 Kubernetes 集群