Modify style and structures (fluid-cloudnative#85)

* modify style and structures modify style and structures * modify style and structures
PlutoEr-001 · Aug 27, 2020 · 71080b4 · 71080b4
1 parent 2ad3516
commit 71080b4
Show file tree

Hide file tree

Showing 11 changed files with 28 additions and 17 deletions.
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -44,7 +44,7 @@ Fluid是一个开源的Kubernetes原生的分布式数据集编排和加速引
 
 ## 文档
 
-如果需要详细了解Fluid的使用，请参考文档 [docs](https://github.com/fluid-cloudnative/docs-fluid)：
+如果需要详细了解Fluid的使用，请参考文档 [docs](docs/README_zh.md)：
 
 - [English](docs/en/TOC.md)
 - [简体中文](docs/zh/TOC.md)

diff --git a/docs/README_zh.md b/docs/README_zh.md
@@ -0,0 +1,15 @@
+# Fluid文档
+
+这个文件夹保存了[Fluid项目](https://github.com/fluid-cloudnative/fluid)文档。
+
+- `en`: [英文文档](en/TOC.md)
+- `zh`: [中文文档](zh/TOC.md)
+
+## 文档版本
+
+目前我们维护了如下版本的Fluid文档，每份都会对应相应分支。
+
+| 分支名 | 版本描述 |
+| :--- | :-- |
+| `master` | 最新版 |
+| `v0.1.0` | v0.1.0| 
diff --git a/docs/en/TOC.md b/docs/en/TOC.md
@@ -14,7 +14,6 @@
   - [Accelerate Data Accessing](samples/accelerate_data_accessing.md)
   - [Cache Co-locality](samples/data_co_locality.md)
   - [Machine Learning](samples/machinelearning.md)
-  - [Dawnbench](samples/dawnbench.md)
 + Developer Guide
   - [How to develop](dev/how_to_develop.md)
   - [API_Doc](dev/api_doc.md)

diff --git a/docs/en/samples/machinelearning.md b/docs/en/samples/machinelearning.md
@@ -5,13 +5,13 @@ This article describes how to deploy [ImageNet](http://www.image-net.org/) datas
 ## Prerequisites
 
 - [Fluid](https://github.com/fluid-cloudnative/fluid) (version >= 0.1.0)
-- [arena](https://github.com/kubeflow/arena)（version >= 0.4.0）
+- [Arena](https://github.com/kubeflow/arena)（version >= 0.4.0）
 
 > **NOTE**:
 >
 > 1. The document requires Fluid installed on your Kubernetes cluster. Please refer to [Fluid Installation Guide](../userguide/install.md) to finish installation before going to the next step.
 >
-> 2. Arena is a CLI that is convenient for data scientists to run and monitor machine learning tasks. See [arena-installation-tutorial](https://github.com/kubeflow/arena/blob/master/docs/installation/INSTALL_FROM_BINARY.md) for more information.
+> 2. Arena is a CLI that is convenient for data scientists to run and monitor machine learning tasks. See [Arena Installation Tutorial](https://github.com/kubeflow/arena/blob/master/docs/installation/INSTALL_FROM_BINARY.md) for more information.
 
 ## Deploy Dataset on Kubernetes Cluster with Fluid
 

diff --git a/docs/en/samples/warmup.md b/docs/en/samples/warmup.md
diff --git a/docs/en/userguide/install.md b/docs/en/userguide/install.md
@@ -3,7 +3,6 @@
 ## Prerequisites
 
 - Git
-
 - Kubernetes cluster（version >= 1.14）, and support CSI
 - kubectl（version >= 1.14）
 - [Helm](https://helm.sh/)（version >= 3.0）
@@ -18,7 +17,7 @@ For the installation and configuration of Helm 3, please refer to [here](https:/
 
 ### Download Fluid Chart
 
-You can execute the following command in any folder to clone source code from [fluid repository](https://github.com/fluid-cloudnative/fluid):
+You can execute the following command in any folder to clone source code from [Fluid repository](https://github.com/fluid-cloudnative/fluid):
 
 ```shell
 $ git clone https://github.com/fluid-cloudnative/fluid.git
@@ -40,7 +39,7 @@ Create namespace:
 $ kubectl create ns fluid-system
 ```
 
-Install fluid with:
+Install Fluid with:
 
 ```shell
 $ helm install fluid charts/fluid/fluid

diff --git a/docs/zh/TOC.md b/docs/zh/TOC.md
@@ -9,7 +9,7 @@
   - [概述](userguide/overview.md)
   - [快速上手](userguide/get_started.md)
   - [安装](userguide/install.md)
-  - [问题诊断](userguide/diagnose.md)
+  - [问题诊断](userguide/troubleshooting.md)
 + 示例
   - [数据加速](samples/accelerate_data_accessing.md)
   - [缓存亲和性调度](samples/data_co_locality.md)

diff --git a/docs/zh/samples/accelerate_data_accessing.md b/docs/zh/samples/accelerate_data_accessing.md
@@ -12,7 +12,7 @@ controller-manager-7fd6457ccf-jnkvn   1/1     Running   0          60s
 csi-nodeplugin-fluid-6rhpt            2/2     Running   0          60s
 csi-nodeplugin-fluid-6zwgl            2/2     Running   0          60s
 ```
-通常来说，你会看到一个名为“controller-manager”的Pod和多个名为“csi-nodeplugin”的Pod正在运行。其中，“csi-nodeplugin”这些Pod的数量取决于你的Kubernetes集群中结点的数量。
+通常来说，你会看到一个名为`controller-manager`的Pod和多个名为`csi-nodeplugin`的Pod正在运行。其中，`csi-nodeplugin`这些Pod的数量取决于你的Kubernetes集群中结点的数量。
 
 ## 新建工作环境
 ```shell

diff --git a/docs/zh/samples/warmup.md b/docs/zh/samples/warmup.md
diff --git a/docs/zh/userguide/get_started.md b/docs/zh/userguide/get_started.md
@@ -58,9 +58,9 @@ csi-nodeplugin-fluid-wczmq          2/2       Running   0          32h
 ```
 
 ## 创建dataset
-Fluid提供了云原生的数据加速和管理能力，并抽象出了*数据集*概念方便用户管理，接下来将演示如何用 Fluid 创建一个数据集。   
+Fluid提供了云原生的数据加速和管理能力，并抽象出了`数据集`概念方便用户管理，接下来将演示如何用 Fluid 创建一个数据集。   
 
-1. 通过CRD文件创建一个Dataset对象，其中描述了数据集的来源。
+1. 通过`CRD`文件创建一个Dataset对象，其中描述了数据集的来源。
 ```yaml
 apiVersion: data.fluid.io/v1alpha1
 kind: Dataset
@@ -76,10 +76,10 @@ spec:
 ```
 kubectl create -f dataset.yaml
 ```
-dataset创建以后处于 *not bound* 状态，需要绑定 runtime 才能使用。
+dataset创建以后处于 `not bound` 状态，需要绑定 runtime 才能使用。
 
 
-2. 同样根据 alluxioRuntime的CRD文件创建一个 *Alluxio* Runtime 对象，用来描述支持这个数据集的 runtime。
+2. 同样根据 AlluxioRuntime的CRD文件创建一个 `Alluxio Runtime` 对象，用来描述支持这个数据集的 Runtime。
 ```yaml
 apiVersion: data.fluid.io/v1alpha1
 kind: AlluxioRuntime
@@ -156,7 +156,7 @@ user	0m0.002s
 sys	0m0.028s
 ```
 
-5. 为了避免其他因素(比如 page cache )对结果造成影响，我们将删除之前的容器，新建相同的应用，尝试访问同样的文件。由于此时文件已经被 *alluxio* 缓存，可以看到第二次访问所需时间远小于第一次。
+5. 为了避免其他因素(比如 page cache )对结果造成影响，我们将删除之前的容器，新建相同的应用，尝试访问同样的文件。由于此时文件已经被 `Alluxio` 缓存，可以看到第二次访问所需时间远小于第一次。
 ```shell
 kubectl delete -f app.yaml && kubectl create -f app.yaml
 ...

diff --git a/docs/zh/userguide/install.md b/docs/zh/userguide/install.md
@@ -23,7 +23,7 @@
 $ git clone https://github.com/fluid-cloudnative/fluid.git
 ```
 
-Fluid源代码中包含了部署Fluid所需的[Helm charts](https://github.com/fluid-cloudnative/fluid/tree/master/charts)。
+Fluid源代码中包含了部署Fluid所需的[Helm Charts](https://github.com/fluid-cloudnative/fluid/tree/master/charts)。
 
 ### 使用Helm安装Fluid