Update nav structure (a big update)

Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
windsonsea · Nov 21, 2023 · 68f912f · 68f912f
1 parent 58d2025
commit 68f912f
Show file tree

Hide file tree

Showing 167 changed files with 292 additions and 317 deletions.
diff --git a/docs/docs/architecture/apis.md → docs/docs/apis.md b/docs/docs/architecture/apis.md → docs/docs/apis.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 11
 sidebar_label: "APIs"
 ---
 

diff --git a/docs/docs/apps/_category_.json b/docs/docs/apps/_category_.json
@@ -1,8 +1,8 @@
-{
-  "label": "Use Cases",
-  "position": 5,
-  "link" : {
-    "type": "generated-index",
-    "description": "In this section, we will introduce different use cases:"
-  }
+{
+  "label": "Applications",
+  "position": 8,
+  "link" : {
+    "type": "generated-index",
+    "description": "In this section, we will describe the application usage in HwameiStor:"
+  }
 }
diff --git a/docs/docs/apps/disk.md b/docs/docs/apps/disk.md
@@ -0,0 +1,39 @@
+---
+sidebar_position: 2
+sidebar_label: "Use Disk Volume"
+---
+
+# Use Disk Volume
+
+HwameiStor provides another type of data volume known as raw disk data volume.
+This volume is based on the raw disk present on the node and can be directly mounted for container use.
+As a result, this type of data volume offers more efficient data read and write performance,
+thereby fully unleashing the performance of the disk.
+
+Create a nginx application and use `hwameistor-disk-volume` volume using the following command:
+
+```console
+$ cat << EOF | kubectl apply -f -
+apiVersion: v1
+kind: Pod
+metadata:
+  name: nginx
+  namespace: default
+spec:
+  containers:
+  - name: nginx
+    image: docker.io/library/nginx:latest
+    imagePullPolicy: IfNotPresent
+    volumeMounts:
+    - name: data
+      mountPath: /data
+    ports:
+    - containerPort: 80
+  volumes:
+  - name: data
+    persistentVolumeClaim:
+      claimName: hwameistor-disk-volume
+EOF
+```
+
+
diff --git a/...s/quick_start/create_stateful/basic/ha.md → docs/docs/apps/ha.md b/...s/quick_start/create_stateful/basic/ha.md → docs/docs/apps/ha.md
diff --git a/docs/docs/apps/lvm.md b/docs/docs/apps/lvm.md
@@ -0,0 +1,36 @@
+---
+sidebar_position: 1
+sidebar_label: "LVM Volume"
+---
+
+# Use LVM Volume
+
+HwameiStor provides LVM-based data volumes,
+which offer read and write performance comparable to that of native disks.
+These data volumes also provide advanced features such as data volume expansion, migration, high availability, and more.
+
+Create a nginx application and use `hwameistor-lvm-volume` volume using the following command:
+
+```console
+$ cat << EOF | kubectl apply -f -
+apiVersion: v1
+kind: Pod
+metadata:
+  name: nginx
+  namespace: default
+spec:
+  containers:
+  - name: nginx
+    image: docker.io/library/nginx:latest
+    imagePullPolicy: IfNotPresent
+    volumeMounts:
+    - name: data
+      mountPath: /data
+    ports:
+    - containerPort: 80
+  volumes:
+  - name: data
+    persistentVolumeClaim:
+      claimName: hwameistor-lvm-volume
+EOF     
+```
diff --git a/docs/docs/architecture/_category_.json b/docs/docs/architecture/_category_.json
diff --git a/docs/docs/architecture/overview.md b/docs/docs/architecture/overview.md
diff --git a/docs/docs/community.md b/docs/docs/community.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 7
+sidebar_position: 15
 sidebar_label:  "Community"
 ---
 

diff --git a/docs/docs/contribute/_category_.json b/docs/docs/contribute/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Contribution",
-  "position": 7,
+  "position": 16,
   "link": {
     "type": "generated-index",
     "description": "In this section, we will introduce how to contribute to HwameiStor:"

diff --git a/docs/docs/faqs.md b/docs/docs/faqs.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 8
+sidebar_position: 12
 sidebar_label: "FAQs"
 ---
 

diff --git a/..._start/advanced_features/fast_failover.md → docs/docs/fast_failover.md b/..._start/advanced_features/fast_failover.md → docs/docs/fast_failover.md
@@ -1,9 +1,9 @@
 ---
-sidebar_position: 6
+sidebar_position: 9
 sidebar_label: "Fast Failover"
 ---
 
-# Application Fast Failover
+# Fast Failover
 
 When the stateful application (i.e. Pod with HwameiStor volume) runs into a problem, especially caused by the node issue,
 it's important to reschedule the Pod to another healthy node and keep running.

diff --git a/docs/docs/img/ldm.png b/docs/docs/img/ldm.png
diff --git a/docs/docs/img/localstor.png b/docs/docs/img/localstor.png
diff --git a/.../docs/quick_start/install/_category_.json → docs/docs/install/_category_.json b/.../docs/quick_start/install/_category_.json → docs/docs/install/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Installation",
-  "position": 1,
+  "position": 4,
   "link" : {
     "type": "generated-index",
     "description": "In this section, we will introduce the installation procedure:"

diff --git a/docs/docs/quick_start/install/operator.md → docs/docs/install/operator.md b/docs/docs/quick_start/install/operator.md → docs/docs/install/operator.md
diff --git a/docs/docs/quick_start/install/post_check.md → docs/docs/install/post_check.md b/docs/docs/quick_start/install/post_check.md → docs/docs/install/post_check.md
@@ -75,7 +75,7 @@ localvolumesnapshots                 lvs                          hwameistor.io/
 resizepolicies                                                    hwameistor.io/v1alpha1   false        ResizePolicy
 ```
 
-For the details about CRDs, please also refer to [CRDs](../../architecture/apis.md).
+For the details about CRDs, please also refer to [CRDs](../apis.md).
 
 ## Check `LocalDiskNodes` and `localDisks`
 

diff --git a/docs/docs/quick_start/install/prereq.md → docs/docs/install/prereq.md b/docs/docs/quick_start/install/prereq.md → docs/docs/install/prereq.md
diff --git a/docs/docs/quick_start/uninstall.md → docs/docs/install/uninstall.md b/docs/docs/quick_start/uninstall.md → docs/docs/install/uninstall.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 5
 sidebar_label: "Uninstall"
 ---
 

diff --git a/...docs/architecture/modules/_category_.json → docs/docs/modules/_category_.json b/...docs/architecture/modules/_category_.json → docs/docs/modules/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Modules",
-  "position": 2,
+  "position": 3,
   "link" : {
     "type": "generated-index",
     "description": "In this section, we will introduce the following modules:"

diff --git a/...hitecture/modules/admission_controller.md → docs/docs/modules/admission_controller.md b/...hitecture/modules/admission_controller.md → docs/docs/modules/admission_controller.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 5
 sidebar_label: "Admission Controller"
 ---
 
@@ -13,7 +13,7 @@ sidebar_label: "Admission Controller"
 
 ## Which resources will be verified?
 
-Only `POD` resources will be verified, and the verification process occurs at the time of creation.
+Only Pod resources will be verified, and the verification process occurs at the time of creation.
 
 :::info
 In order to ensure that the pods of HwameiStor can be started smoothly, the pods in the namespace where HwameiStor is deployed will not be verified.

diff --git a/docs/docs/architecture/modules/evictor.md → docs/docs/modules/evictor.md b/docs/docs/architecture/modules/evictor.md → docs/docs/modules/evictor.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 6
 sidebar_label: "Evictor"
 ---
 

diff --git a/docs/docs/architecture/modules/exporter.md → docs/docs/modules/exporter.md b/docs/docs/architecture/modules/exporter.md → docs/docs/modules/exporter.md
@@ -1,8 +1,8 @@
 ---
-sidebar_position: 6
+sidebar_position: 7
 sidebar_label: "Exporter"
 ---
 
 # Exporter
 
-Exporter is HwameiStor's metrics server which will collect the metrics for the system resources, such as Disk, Volumes, Operations, etc.., and supply for the Prometheus module.
+Exporter is HwameiStor's metrics server which will collect the metrics for the system resources, such as Disk, Volumes, Operations, etc.., and supply for the Prometheus module.
diff --git a/docs/docs/architecture/modules/gui.md → docs/docs/modules/gui.md b/docs/docs/architecture/modules/gui.md → docs/docs/modules/gui.md
@@ -1,8 +1,8 @@
 ---
-sidebar_position: 7
+sidebar_position: 8
 sidebar_label: "GUI"
 ---
 
 # GUI
 
-HwameiStor has a module for Graph User Interface. It will provide users with an easy way to manage the HwameiStor system. The GUI can be deployed by the Operator.
+HwameiStor has a module for Graph User Interface. It will provide users with an easy way to manage the HwameiStor system. The GUI can be deployed by the Operator.
diff --git a/...cs/architecture/modules/lda_controller.md → docs/docs/modules/lda_controller.md b/...cs/architecture/modules/lda_controller.md → docs/docs/modules/lda_controller.md
@@ -1,11 +1,11 @@
 ---
-sidebar_position: 8
+sidebar_position: 9
 sidebar_label: "LDA Controller"
 ---
 
 # LDA Controller
 
-The LDA controller provides a separate CRD---localdiskactions, which is used to match the localdisk and execute the specified action. As follows:
+The LDA controller provides a separate CRD - `localdiskactions`, which is used to match the localdisk and execute the specified action. As follows:
 
 ```yaml
 apiVersion: hwameistor.io/v1alpha1

diff --git a/docs/docs/architecture/modules/ldm.md → docs/docs/modules/ldm.md b/docs/docs/architecture/modules/ldm.md → docs/docs/modules/ldm.md
@@ -7,7 +7,7 @@ sidebar_label: "Local Disk Manager"
 
 Local Disk Manager (LDM) is one of the modules of HwameiStor. `LDM` is used to simplify the management of disks on nodes. It can abstract the disk on a node into a resource for monitoring and management purposes. It's a daemon that will be deployed on each node, then detect the disk on the node, abstract it into local disk (LD) resources and save it to kubernetes.
 
-![LDM 架构图](../../img/ldm.png)
+![LDM architecture](../img/ldm.png)
 
 At present, the LDM project is still in the `alpha` stage.
 

diff --git a/docs/docs/architecture/modules/ls.md → docs/docs/modules/ls.md b/docs/docs/architecture/modules/ls.md → docs/docs/modules/ls.md
@@ -11,7 +11,7 @@ Supported volume managers: `LVM`.
 
 Supported storage medium: `HDD`, `SSD`, `NVMe`.
 
-![local storage architecture](../../img/localstor.png)
+![local storage architecture](../img/localstor.png)
 
 ## Applicable scenarios
 

diff --git a/docs/docs/architecture/modules/scheduler.md → docs/docs/modules/scheduler.md b/docs/docs/architecture/modules/scheduler.md → docs/docs/modules/scheduler.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 sidebar_label: "Scheduler"
 ---
 

diff --git a/docs/docs/quick_start/_category_.json → docs/docs/nodes_and_disks/_category_.json b/docs/docs/quick_start/_category_.json → docs/docs/nodes_and_disks/_category_.json
@@ -1,8 +1,8 @@
-{
-  "label": "Quick Start",
-  "position": 2,
-  "link" : {
-    "type": "generated-index",
-    "description": "In this section, we will provide some guides to help you quickly get started with HwameiStor:"
-  }
+{
+  "label": "Nodes and Disks",
+  "position": 5,
+  "link" : {
+    "type": "generated-index",
+    "description": "In this section, we will provide some guides about nodes and disks:"
+  }
 }
diff --git a/...start/advanced_features/disk_expansion.md → docs/docs/nodes_and_disks/disk_expansion.md b/...start/advanced_features/disk_expansion.md → docs/docs/nodes_and_disks/disk_expansion.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 4
 sidebar_label: "Disk Expansion"
 ---
 

diff --git a/...es_and_nodes/node_expansion/disk_nodes.md → docs/docs/nodes_and_disks/disk_nodes.md b/...es_and_nodes/node_expansion/disk_nodes.md → docs/docs/nodes_and_disks/disk_nodes.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 sidebar_label: "Disk Storage Node"
 ---
 

diff --git a/...mes_and_nodes/node_expansion/lvm_nodes.md → docs/docs/nodes_and_disks/lvm_nodes.md b/...mes_and_nodes/node_expansion/lvm_nodes.md → docs/docs/nodes_and_disks/lvm_nodes.md
@@ -12,7 +12,7 @@ LVM storage nodes pool the disks on the node and provide LVM-type data volumes f
 ### 1. Prepare a storage node
 
 Add the node into the Kubernetes cluster or select a Kubernetes node.
-The node should have all the required items described in [Prerequisites](../../quick_start/install/prereq.md).
+The node should have all the required items described in [Prerequisites](../install/prereq.md).
 
 For example, suppose you have a new node with the following information:
 

diff --git a/...start/advanced_features/node_expansion.md → docs/docs/nodes_and_disks/node_expansion.md b/...start/advanced_features/node_expansion.md → docs/docs/nodes_and_disks/node_expansion.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 2
 sidebar_label: "Node Expansion"
 ---
 

diff --git a/docs/docs/overview.md b/docs/docs/overview.md
@@ -0,0 +1,10 @@
+---
+sidebar_position: 2
+sidebar_label: "Architecture"
+---
+
+# Architecture
+
+HwameiStor is an HA local storage system for cloud-native stateful workloads.
+
+![System architecture](img/architecture.png)
diff --git a/docs/docs/quick_start/advanced_features/_category_.json b/docs/docs/quick_start/advanced_features/_category_.json
diff --git a/docs/docs/quick_start/create_stateful/_category_.json b/docs/docs/quick_start/create_stateful/_category_.json
diff --git a/docs/docs/quick_start/create_stateful/advanced/_category_.json b/docs/docs/quick_start/create_stateful/advanced/_category_.json
diff --git a/docs/docs/quick_start/create_stateful/basic/_category_.json b/docs/docs/quick_start/create_stateful/basic/_category_.json
diff --git a/docs/docs/storageclass/_category_.json b/docs/docs/storageclass/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "StorageClass",
+  "position": 6,
+  "link" : {
+    "type": "generated-index",
+    "description": "In this section, we will introduce StorageClass:"
+  }
+}