Merge pull request #3270 from ty-dc/docs/upgrade-x

Update document format
spidernet-io · Mar 1, 2024 · e0ccf2f · e0ccf2f
2 parents 014a3bd + 347a1a5
commit e0ccf2f
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 32 deletions.
diff --git a/docs/concepts/coordinator-zh_CN.md b/docs/concepts/coordinator-zh_CN.md
@@ -13,10 +13,10 @@ Spiderpool 内置一个叫 `coordinator` 的 CNI meta-plugin, 它在 Main CNI
 注意: 如果您的操作系统是使用 NetworkManager 的 OS，比如 Fedora、Centos等，强烈建议配置 NetworkManager 的配置文件(/etc/NetworkManager/conf.d/spidernet.conf)，避免 NetworkManager 干扰 `coordinator` 创建的 Veth 虚拟接口，影响通信:
 
 ```shell
-~# cat << EOF | > /etc/NetworkManager/conf.d/spidernet.conf
-> [keyfile]
-> unmanaged-devices=interface-name:^veth*
-> EOF
+~# cat > /etc/NetworkManager/conf.d/spidernet.conf <<EOF
+[keyfile]
+unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
+EOF
 ~# systemctl restart NetworkManager
 ```
 

diff --git a/docs/reference/plugin-ifacer.md b/docs/reference/plugin-ifacer.md
@@ -19,10 +19,10 @@ This plugin dynamically creates VLAN sub-interfaces or Bond interfaces on the no
 
  ```shell
  ~# INTERFACE=<your_interface_name>
- ~# cat << EOF | > /etc/NetworkManager/conf.d/spidernet.conf
- > [keyfile]
- > unmanaged-devices=interface-name:^veth*;interface-name:${INTERFACE}
- > EOF
+ ~# cat > /etc/NetworkManager/conf.d/spidernet.conf <<EOF
+ [keyfile]
+ unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
+ EOF
  ~# systemctl restart NetworkManager
  ```
 

diff --git a/docs/usage/install/underlay/get-started-macvlan-zh_CN.md b/docs/usage/install/underlay/get-started-macvlan-zh_CN.md
@@ -26,10 +26,10 @@ Spiderpool 可用作 Underlay 网络场景下提供固定 IP 的一种解决方
 
  ```shell
  ~# IFACER_INTERFACE="<NAME>"
- ~# cat << EOF | > /etc/NetworkManager/conf.d/spidernet.conf
- > [keyfile]
- > unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
- > EOF
+ ~# cat > /etc/NetworkManager/conf.d/spidernet.conf <<EOF
+ [keyfile]
+ unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
+ EOF
  ~# systemctl restart NetworkManager
  ```
 

diff --git a/docs/usage/install/underlay/get-started-macvlan.md b/docs/usage/install/underlay/get-started-macvlan.md
@@ -26,10 +26,10 @@ Spiderpool provides a solution for assigning static IP addresses in underlay net
 
  ```shell
  ~# IFACER_INTERFACE="<NAME>"
- ~# cat << EOF | > /etc/NetworkManager/conf.d/spidernet.conf
- > [keyfile]
- > unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
- > EOF
+ ~# cat > /etc/NetworkManager/conf.d/spidernet.conf <<EOF
+ [keyfile]
+ unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
+ EOF
  ~# systemctl restart NetworkManager
  ```
 

diff --git a/docs/usage/install/underlay/get-started-ovs-zh_CN.md b/docs/usage/install/underlay/get-started-ovs-zh_CN.md
@@ -31,10 +31,10 @@ Spiderpool 可用作 Underlay 网络场景下提供固定 IP 的一种解决方
 
  ```shell
  ~# IFACER_INTERFACE="<NAME>"
- ~# cat << EOF | > /etc/NetworkManager/conf.d/spidernet.conf
- > [keyfile]
- > unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
- > EOF
+ ~# cat > /etc/NetworkManager/conf.d/spidernet.conf <<EOF
+ [keyfile]
+ unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
+ EOF
  ~# systemctl restart NetworkManager
  ```
 

diff --git a/docs/usage/install/underlay/get-started-ovs.md b/docs/usage/install/underlay/get-started-ovs.md
@@ -31,10 +31,10 @@ Spiderpool can be used as a solution to provide fixed IPs in an Underlay network
 
  ```shell
  ~# IFACER_INTERFACE="<NAME>"
- ~# cat << EOF | > /etc/NetworkManager/conf.d/spidernet.conf
- > [keyfile]
- > unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
- > EOF
+ ~# cat > /etc/NetworkManager/conf.d/spidernet.conf <<EOF
+ [keyfile]
+ unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
+ EOF
  ~# systemctl restart NetworkManager
  ```
 

diff --git a/docs/usage/install/underlay/get-started-sriov-zh_CN.md b/docs/usage/install/underlay/get-started-sriov-zh_CN.md
@@ -39,10 +39,10 @@ Spiderpool 可用作 underlay 网络场景下提供固定 IP 的一种解决方
 
  ```shell
  ~# IFACER_INTERFACE="<NAME>"
- ~# cat << EOF | > /etc/NetworkManager/conf.d/spidernet.conf
- > [keyfile]
- > unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
- > EOF
+ ~# cat > /etc/NetworkManager/conf.d/spidernet.conf <<EOF
+ [keyfile]
+ unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
+ EOF
  ~# systemctl restart NetworkManager
  ```
 

diff --git a/docs/usage/install/underlay/get-started-sriov.md b/docs/usage/install/underlay/get-started-sriov.md
@@ -39,10 +39,10 @@ Spiderpool provides a solution for assigning static IP addresses in underlay net
 
  ```shell
  ~# IFACER_INTERFACE="<NAME>"
- ~# cat << EOF | > /etc/NetworkManager/conf.d/spidernet.conf
- > [keyfile]
- > unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
- > EOF
+ ~# cat > /etc/NetworkManager/conf.d/spidernet.conf <<EOF
+ [keyfile]
+ unmanaged-devices=interface-name:^veth*;interface-name:${IFACER_INTERFACE}
+ EOF
  ~# systemctl restart NetworkManager
  ```