diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-02 18:38:55 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-06 16:18:03 +0300 |
| commit | 5dbb26f7b468874a8c6d1ba1a9cca3bb3d40f24f (patch) | |
| tree | df43e194b04bbff772da7d7506edb7f57f12a3da | |
| parent | f7bab3007a9e0d0fef3ec551a677380a00b12d6a (diff) | |
| download | vyos-documentation-5dbb26f7b468874a8c6d1ba1a9cca3bb3d40f24f.tar.gz vyos-documentation-5dbb26f7b468874a8c6d1ba1a9cca3bb3d40f24f.zip | |
docs: address Copilot review feedback on imported MyST pages
Fix issues flagged by Copilot review on PR #1857 (the same content lives
in myst/current as the canonical source):
Real bugs:
- site-2-site-cisco.md: replace curly quote (U+2019) with ASCII apostrophe
- rsa-keys.md: fix typo "key-pair nam>>" → "key-pair name>"
- vmware.md: lowercase admonition directive (:::{NOTE} → :::{note})
- vpp/configuration/nat/index.md: remove blank line inside {include} fence
Grammar:
- vpp/configuration/interfaces/loopback.md: "bounded" → "bound"
- vpp/configuration/sflow.md: "VyOS support" → "VyOS supports"
- vpp/requirements.md: "bypass" → "bypasses"
- vpp/configuration/dataplane/interface.md: "configures" → "configure"
CI linter (IP addresses):
- nmp.md: wrap 8.8.8.8 example with stop/start_vyoslinter
- lac-lns.md: wrap LNS config block (contains 8.8.8.8)
- wan-load-balancing.md: wrap whole file (illustrative non-RFC IPs)
- policy/examples.md: replace 192.0.1.1 with RFC 5737 192.0.2.1
🤖 Generated by [robots](https://vyos.io)
| -rw-r--r-- | docs/configexamples/lac-lns.md | 4 | ||||
| -rw-r--r-- | docs/configexamples/nmp.md | 4 | ||||
| -rw-r--r-- | docs/configexamples/site-2-site-cisco.md | 2 | ||||
| -rw-r--r-- | docs/configexamples/wan-load-balancing.md | 4 | ||||
| -rw-r--r-- | docs/configuration/policy/examples.md | 2 | ||||
| -rw-r--r-- | docs/configuration/vpn/rsa-keys.md | 2 | ||||
| -rw-r--r-- | docs/installation/virtual/vmware.md | 2 | ||||
| -rw-r--r-- | docs/vpp/configuration/dataplane/interface.md | 2 | ||||
| -rw-r--r-- | docs/vpp/configuration/interfaces/loopback.md | 2 | ||||
| -rw-r--r-- | docs/vpp/configuration/nat/index.md | 1 | ||||
| -rw-r--r-- | docs/vpp/configuration/sflow.md | 2 | ||||
| -rw-r--r-- | docs/vpp/requirements.md | 2 |
12 files changed, 20 insertions, 9 deletions
diff --git a/docs/configexamples/lac-lns.md b/docs/configexamples/lac-lns.md index 315abe1c..51a96f8b 100644 --- a/docs/configexamples/lac-lns.md +++ b/docs/configexamples/lac-lns.md @@ -77,6 +77,8 @@ interface Virtual-Template1 ### LNS +% stop_vyoslinter + ```none set interfaces ethernet eth0 address '192.168.139.100/24' set nat source rule 100 outbound-interface name 'eth0' @@ -94,6 +96,8 @@ set vpn l2tp remote-access name-server '8.8.8.8' set vpn l2tp remote-access ppp-options disable-ccp ``` +% start_vyoslinter + :::{note} This setup requires the Compression Control Protocol (CCP) being disabled, the command `set vpn l2tp remote-access ppp-options disable-ccp` diff --git a/docs/configexamples/nmp.md b/docs/configexamples/nmp.md index 9aa73540..02d99f86 100644 --- a/docs/configexamples/nmp.md +++ b/docs/configexamples/nmp.md @@ -15,6 +15,8 @@ scale and expand with the needs of your network. First prepare our VyOS router for connection to NMP. We have to set up the SNMP protocol and connectivity between the router and NMP. +% stop_vyoslinter + ```none set interfaces ethernet eth0 address 'dhcp' set system name-server '8.8.8.8' @@ -22,6 +24,8 @@ set service snmp community router authorization 'test' set service snmp community router network '0.0.0.0/0' ``` +% start_vyoslinter + ## Configuration 'NMP' diff --git a/docs/configexamples/site-2-site-cisco.md b/docs/configexamples/site-2-site-cisco.md index 2a2fb7a1..d8ca2c18 100644 --- a/docs/configexamples/site-2-site-cisco.md +++ b/docs/configexamples/site-2-site-cisco.md @@ -29,7 +29,7 @@ set interfaces tunnel tun1 source-address '198.51.100.1' - IPsec: ```none -set vpn ipsec authentication psk vyos_cisco_l id 'vyos.net’ +set vpn ipsec authentication psk vyos_cisco_l id 'vyos.net' set vpn ipsec authentication psk vyos_cisco_l id 'cisco.hub.net' set vpn ipsec authentication psk vyos_cisco_l secret 'secret' set vpn ipsec esp-group e1 lifetime '3600' diff --git a/docs/configexamples/wan-load-balancing.md b/docs/configexamples/wan-load-balancing.md index 5671c515..b9357523 100644 --- a/docs/configexamples/wan-load-balancing.md +++ b/docs/configexamples/wan-load-balancing.md @@ -7,6 +7,8 @@ lastproofread: '2021-06-29' # WAN Load Balancer examples +% stop_vyoslinter + ## Example 1: Distributing load evenly The setup used in this example is shown in the following diagram: @@ -177,3 +179,5 @@ set load-balancing wan rule 5 inbound-interface eth+ set load-balancing wan rule 5 destination address 10.0.0.0/8 ``` +% start_vyoslinter + diff --git a/docs/configuration/policy/examples.md b/docs/configuration/policy/examples.md index 86aba9a9..2b5d54d2 100644 --- a/docs/configuration/policy/examples.md +++ b/docs/configuration/policy/examples.md @@ -105,7 +105,7 @@ Policy-Based Routing with multiple ISP uplinks Add default routes for routing `table 10` and `table 11` ```none -set protocols static table 10 route 0.0.0.0/0 next-hop 192.0.1.1 +set protocols static table 10 route 0.0.0.0/0 next-hop 192.0.2.1 set protocols static table 11 route 0.0.0.0/0 next-hop 192.0.2.2 ``` diff --git a/docs/configuration/vpn/rsa-keys.md b/docs/configuration/vpn/rsa-keys.md index b224b514..875ba91b 100644 --- a/docs/configuration/vpn/rsa-keys.md +++ b/docs/configuration/vpn/rsa-keys.md @@ -10,7 +10,7 @@ To make IPSec work with dynamic address on one/both sides, we will have to use RSA keys for authentication. They are very fast and easy to setup. First, on both routers run the operational command "generate pki key-pair -install \<key-pair nam>>". You may choose different length than 2048 of course. +install \<key-pair name>". You may choose different length than 2048 of course. ```none vyos@left# run generate pki key-pair install ipsec-LEFT diff --git a/docs/installation/virtual/vmware.md b/docs/installation/virtual/vmware.md index 34fb2197..66278ae9 100644 --- a/docs/installation/virtual/vmware.md +++ b/docs/installation/virtual/vmware.md @@ -12,7 +12,7 @@ lastproofread: '2026-02-02' using a generic Linux instance by attaching the bootable ISO file and installing using the `install image` command. -:::{NOTE} +:::{note} Previous issues have been documented with GRE/IPSEC tunneling using the E1000 adapter on VyOS guests. Use the VMXNET3 adapter instead. ::: diff --git a/docs/vpp/configuration/dataplane/interface.md b/docs/vpp/configuration/dataplane/interface.md index 3f345c8d..02a65ff8 100644 --- a/docs/vpp/configuration/dataplane/interface.md +++ b/docs/vpp/configuration/dataplane/interface.md @@ -27,7 +27,7 @@ Some network interface cards (NICs) may not be compatible with the DPDK driver. ### DPDK interface options -This section shows how to configures DPDK-specific settings for an interface. +This section shows how to configure DPDK-specific settings for an interface. ```{cfgcmd} set vpp settings interface \<interface-name\> num-rx-queues \<value\> ``` diff --git a/docs/vpp/configuration/interfaces/loopback.md b/docs/vpp/configuration/interfaces/loopback.md index 552ec7e3..844892a3 100644 --- a/docs/vpp/configuration/interfaces/loopback.md +++ b/docs/vpp/configuration/interfaces/loopback.md @@ -47,7 +47,7 @@ Administratively disable the loopback interface. ### Kernel Interface Integration -Kernel interface is bounded to the VPP loopback interface for management +Kernel interface is bound to the VPP loopback interface for management and application compatibility. ## IP Address Configuration diff --git a/docs/vpp/configuration/nat/index.md b/docs/vpp/configuration/nat/index.md index aa1698ea..2591a791 100644 --- a/docs/vpp/configuration/nat/index.md +++ b/docs/vpp/configuration/nat/index.md @@ -5,7 +5,6 @@ lastproofread: '2026-03-05' (vpp-config-nat-index)= ```{include} /_include/need_improvement.txt - ``` # VPP NAT Configuration diff --git a/docs/vpp/configuration/sflow.md b/docs/vpp/configuration/sflow.md index a065b6b0..53f6feed 100644 --- a/docs/vpp/configuration/sflow.md +++ b/docs/vpp/configuration/sflow.md @@ -10,7 +10,7 @@ lastproofread: '2025-09-04' # VPP sFlow Configuration -VPP Dataplane in VyOS support sFlow for traffic monitoring and analysis. +VPP Dataplane in VyOS supports sFlow for traffic monitoring and analysis. The VPP Dataplane integration works hand-in-hand with normal kernel sFlow agent, which is responsible for collecting and exporting sFlow samples. VPP itself is responsible for generating the samples. diff --git a/docs/vpp/requirements.md b/docs/vpp/requirements.md index e1443577..159f70d4 100644 --- a/docs/vpp/requirements.md +++ b/docs/vpp/requirements.md @@ -125,7 +125,7 @@ prerequisites before enabling VPP: ``` :::{note} - This option bypass the hardware validation checks for the specified + This option bypasses the hardware validation checks for the specified devices. Stability and performance are not guaranteed when using unsupported NICs or drivers. ::: |
