Merge pull request #440 from rambohe-ch/upgrade-user-manauls-construc…

…tion

reconstruct user manuals

docs/faq/yurtadm.md

@@ -12,7 +12,7 @@ Execute `yum install -y conntrack` and then re-execute the yurtadm join command.
 
 **3. How does yurtadm join support user-provided cni plugins**
 
-`yurtadm join` will pull the specially modified cni binary files by default. For the modified content, please refer to [link](../user-manuals/network/edge-pod-network.md). If you want to use pre-prepared cni binaries, they should be placed in the directory `/opt/cni/bin`, and then add the `--reuse-cni-bin=true` parameter when using `yurtadm join` .
+`yurtadm join` will pull the specially modified cni binary files by default. For the modified content, please refer to [link](../user-manuals/network/container-network/flannel.md). If you want to use pre-prepared cni binaries, they should be placed in the directory `/opt/cni/bin`, and then add the `--reuse-cni-bin=true` parameter when using `yurtadm join` .
 
 **4. How does yurtadm join support components such as kubelet/kubeadm provided by users**
 

docs/installation/yurtadm-join.md

@@ -46,7 +46,7 @@ The process of `yurtadm join` will automatically install the following k8s compo
 - kubelet
 - kube-proxy
 
-The process of `yurtadm join` will pull specially modified cni binaries, the modifications can be found [here](../user-manuals/network/edge-pod-network.md). If you want to use cni binaries that uses prepared beforehand, the cni binaries should be placed under `/opt/cni/bin` directory. Then configure yurtadm parameter `--reuse-cni-bin=true` for `yurtadm join` command.
+The process of `yurtadm join` will pull specially modified cni binaries, the modifications can be found [here](../user-manuals/network/container-network/flannel.md). If you want to use cni binaries that uses prepared beforehand, the cni binaries should be placed under `/opt/cni/bin` directory. Then configure yurtadm parameter `--reuse-cni-bin=true` for `yurtadm join` command.
 
 Also, You can pre-place the `kubelet` and `kubeadm` components in the directories named by the PATH environment variable. However, there are restrictions on the version of `kubelet` and `kubeadm`. `yurtadm` will check if the `major version` and `minor version` are the same as the cluster kubernetes version(Follow semver specification).
 

docs/user-manuals/network/edge-pod-network.md → docs/user-manuals/network/container-network/flannel.md

@@ -1,5 +1,5 @@
 ---
-title: Edge Pod Network
+title: Flannel
 ---
 
 ## Background
@@ -11,7 +11,7 @@ In Cloud Edge usage scenarios，in order to ensure the workloads on the edge nod
 If we adopt flannel as CNI plugin and VXLAN as the backend, when a VTEP device is created on a node（generally named: flannel.1）, the VNI and VTEP info will be record in the node annotations，so that other nodes can create the related route and forward rules.
 Flannel arch is shown below:
 
-![flannel-architecture](../../../static/img/docs/user-manuals/network/flannel-architecture.png)
+![flannel-architecture](../../../../static/img/docs/user-manuals/network/flannel-architecture.png)
 
 Let's take an example with 2 edge nodes：
 - node2 creates flannel.1 device，MAC address is "9e:c9:07:f9:b3:8b"，IP address is "172.30.133.0", the related info will be record in node2 annotations:

docs/user-manuals/network/container-network/hostnetwork.md

@@ -0,0 +1,3 @@
+---
+title: HostNetwork
+---

docs/user-manuals/network/network-management-overview.md

@@ -0,0 +1,3 @@
+---
+title: Network management overview
+---

docs/user-manuals/network/network-ports-list.md

@@ -0,0 +1,3 @@
+---
+title: Network ports list
+---

docs/user-manuals/network/nodeport-isolation.md → docs/user-manuals/network/service/nodeport-isolation.md

@@ -1,5 +1,5 @@
 ---
-title: nodeport-isolation
+title: NodePort isolation
 ---
 
 ## Background introduction
@@ -13,7 +13,7 @@ This feature originated from a community requirement, which can be found in the
 A new filter named `nodeportisolation` has been introduced to handle this feature, and a new annotation `nodeport.openyurt.io/listen` has been added for NodePort services to trigger the nodeportisolation filter in YurtHub.
 The nodeportisolation filter reassembles responses for kube-proxy list/watch service requests according to the `nodeport.openyurt.io/listen` annotation settings in the service.
 
-For more information on the detailed design of the data filtering framework, please refer to [resource-access-control](../resource-access-control/resource-access-control.md).
+For more information on the detailed design of the data filtering framework, please refer to [resource-access-control].
 
 ## How to use
 

docs/user-manuals/network/service-topology.md → docs/user-manuals/network/service/service-topology.md

@@ -6,7 +6,7 @@ title: Service Topology
 
 The following picture shows the general function of the *service topology*.
 
-![service-topology](../../../static/img/docs/user-manuals/network/service-topology-example.png)
+![service-topology](../../../../static/img/docs/user-manuals/network/service-topology-example.png)
 
 To use *service topology*, the `EndpointSliceProxying` [feature gate](https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/) must be enabled, and kube-proxy needs to be configured to connect to Yurthub instead of the API server.
 

docs/user-manuals/node-management/configure-node-autonomy.md

@@ -0,0 +1,3 @@
+---
+title: Configure node autonomy
+---

docs/user-manuals/node-management/join-a-node.md

@@ -0,0 +1,3 @@
+---
+title: Join a node
+---

docs/user-manuals/node-management/node-management-overview.md

@@ -0,0 +1,3 @@
+---
+title: Node management overview
+---

docs/user-manuals/node-management/remove-a-node.md

@@ -0,0 +1,3 @@
+---
+title: Remove a node
+---

docs/user-manuals/node-pool-management/create-a-node-pool.md

@@ -0,0 +1,3 @@
+---
+title: Create a node pool
+---

docs/user-manuals/node-pool-management/delete-a-node-pool.md

@@ -0,0 +1,3 @@
+---
+title: Delete a node pool
+---

docs/user-manuals/node-pool-management/edit-a-node-pool.md

@@ -0,0 +1,3 @@
+---
+title: Edit a node pool
+---

docs/user-manuals/node-pool-management/node-pool-management-overview.md

@@ -0,0 +1,3 @@
+---
+title: Node pool management overview
+---

docs/user-manuals/workload/workload-management-overview.md

@@ -0,0 +1,3 @@
+---
+title: Workload management overview
+---

docs/user-manuals/workload/yurt-app-set.md

@@ -2,7 +2,7 @@
 title: YurtAppSet
 ---
 
-In [the previous article](./node-pool-management.md) we introduced the use of `NodePool`, mainly the creation and management of `NodePool`.
+In [the previous article](../node-pool-management/node-pool-management-overview.md) we introduced the use of `NodePool`, mainly the creation and management of `NodePool`.
 Further, we developed the ability to deploy applications unitized based on `NodePool` to improve the efficiency of users' operations.
 
 In this article, we will show how `yurt-app-set` can help users manage their workload. Assume we already have an OpenYurt cluster built on

i18n/zh/docusaurus-plugin-content-docs/current/faq/yurtadm.md

@@ -12,7 +12,7 @@ title: yurtadm
 
 **3. yurtadm join如何支持用户提供的cni插件**
 
-`yurtadm join`默认会拉取经过特殊修改的cni二进制文件，修改的内容可以参考[链接](../user-manuals/network/edge-pod-network.md)。如果你想要使用预先准备好的cni二进制文件，应该将它们放置在目录`/opt/cni/bin`下，接着在使用`yurtadm join`时添加`--reuse-cni-bin=true`参数。
+`yurtadm join`默认会拉取经过特殊修改的cni二进制文件，修改的内容可以参考[链接]。如果你想要使用预先准备好的cni二进制文件，应该将它们放置在目录`/opt/cni/bin`下，接着在使用`yurtadm join`时添加`--reuse-cni-bin=true`参数。
 
 **4. yurtadm join如何支持用户提供的kubelet/kubeadm等组件**
 

i18n/zh/docusaurus-plugin-content-docs/current/installation/yurtadm-join.md

@@ -46,7 +46,7 @@ $ _output/local/bin/linux/amd64/yurtadm join 1.2.3.4:6443 --token=zffaj3.a5vjzf0
 - kubelet
 - kube-proxy
 
-`yurtadm join`的过程中，将会拉取经过特殊修改的cni二进制文件，修改的内容可以参考[链接](../user-manuals/network/edge-pod-network.md)。如果你想要使用预先准备好的cni二进制文件，你应该将它们放置在目录`/opt/cni/bin`下，接着在使用`yurtadm join`时添加`--reuse-cni-bin=true`参数即可。
+`yurtadm join`的过程中，将会拉取经过特殊修改的cni二进制文件，修改的内容可以参考[链接]。如果你想要使用预先准备好的cni二进制文件，你应该将它们放置在目录`/opt/cni/bin`下，接着在使用`yurtadm join`时添加`--reuse-cni-bin=true`参数即可。
 
 你也可以将`kubelet`和`kubeadm`组件提前预置在PATH环境变量中。不过对于`kubelet`和`kubeadm`的版本有一些限制，`yurtadm`会检查组件的`major version`和`minor version`是否与集群Kubernetes版本相同（这遵循semver规范）。
 

i18n/zh/docusaurus-plugin-content-docs/current/user-manuals/workload/yurt-app-set.md

@@ -2,7 +2,7 @@
 title: YurtAppSet
 ---
 
-在[上一篇文章](./node-pool-management.md) 中我们介绍了节点池的使用，主要是节点池的创建和管理，进一步，我们开发了基于节点池的应用单元化部署能力，提高用户的运维效率。
+在[上一篇文章] 中我们介绍了节点池的使用，主要是节点池的创建和管理，进一步，我们开发了基于节点池的应用单元化部署能力，提高用户的运维效率。
 
 在这篇文章中，我们将展示 yurt-app-manager 如何帮助用户管理工作负载。假设我们已经拥有一个基于原生 kubernetes 搭建起来的 OpenYurt 集群，且至少有两个节点。