From d9212421139416f1feb454ea71cfca75fa1ab2b8 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 11 May 2026 19:35:04 +0000 Subject: docs: fix typos across configuration, contributing, and vpp docs Corrections include: adresses->addresses, oder->other, Them->The, criterias->criteria, seeting->setting, carefull->careful, beeing->being, reenable->re-enable, wich->which, derection->direction, Whith->With, assosiate->associate, fpr->for, bootup->boot, trough->through. https://claude.ai/code/session_01RDpSBDLSWLKMGnyPCaKECB --- docs/configuration/service/webproxy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/configuration/service/webproxy.md') diff --git a/docs/configuration/service/webproxy.md b/docs/configuration/service/webproxy.md index 28156b2b..df675916 100644 --- a/docs/configuration/service/webproxy.md +++ b/docs/configuration/service/webproxy.md @@ -317,7 +317,7 @@ Defaults to 'uid' :::{note} This can only be done if all your users are located directly under the same position in the LDAP tree and the login name is used for naming -each user object. If your LDAP tree does not match these criterias or if you +each user object. If your LDAP tree does not match these criteria or if you want to filter who are valid users then you need to use a search filter to search for your users DN (filter-expression). ::: -- cgit v1.2.3 From 0d36eb00147b364c67791f5382f7591db04ddecf Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 11 May 2026 19:54:12 +0000 Subject: docs: address review feedback and pre-existing doc-lint errors - terraformAWS.md: balance the orphan `.. stop_vyoslinter` directive inside the eval-rst block and wrap the long MyST link references at EOF with `% stop_vyoslinter`/`% start_vyoslinter`. - webproxy.md: replace real-world IP 193.49.48.249 with doc-range 192.0.2.249 in the blacklist update example output. - console-server.md: "some times" -> "sometimes". - bgp.md: "command disable" -> "command disables"; add comma before "use the delete form"; "Route dampening which described in" -> "Route dampening, described in". https://claude.ai/code/session_01RDpSBDLSWLKMGnyPCaKECB --- docs/automation/terraform/terraformAWS.md | 6 ++++++ docs/configuration/protocols/bgp.md | 4 ++-- docs/configuration/service/console-server.md | 2 +- docs/configuration/service/webproxy.md | 2 +- 4 files changed, 10 insertions(+), 4 deletions(-) (limited to 'docs/configuration/service/webproxy.md') diff --git a/docs/automation/terraform/terraformAWS.md b/docs/automation/terraform/terraformAWS.md index d4e38d46..10740b99 100644 --- a/docs/automation/terraform/terraformAWS.md +++ b/docs/automation/terraform/terraformAWS.md @@ -103,6 +103,8 @@ Terraform, Ansible, and AWS, follow these steps: See `Structure of files in Ansible for AWS <#structure-of-files-in-ansible-for-aws>`__ for more details. You can obtain ``mykey.pem`` by creating a key `pair `__ in AWS and downloading your ``.pem`` key. + +.. start_vyoslinter ``` ### Deploy with Terraform @@ -543,6 +545,10 @@ ansible_user: vyos All files related to deploying VyOS on AWS with Terraform and Ansible can be found in the [vyos-automation] repository. +% stop_vyoslinter + [group]: https://docs.aws.amazon.com/cli/latest/userguide/cli-services-ec2-sg.html [pair]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html [vyos-automation]: + +% start_vyoslinter diff --git a/docs/configuration/protocols/bgp.md b/docs/configuration/protocols/bgp.md index ff0d24e2..cfa79ce4 100644 --- a/docs/configuration/protocols/bgp.md +++ b/docs/configuration/protocols/bgp.md @@ -285,7 +285,7 @@ and happen automatically if local-role is set. ```{cfgcmd} set protocols bgp neighbor \ shutdown -This command disable the peer or peer group. To re-enable the peer use +This command disables the peer or peer group. To re-enable the peer, use the delete form of this command. ``` @@ -805,7 +805,7 @@ availability is also advertised. A route that continually fails and returns requires a great deal of network traffic to update the network about the route's status. -Route dampening which described in {rfc}`2439` enables you to identify routes +Route dampening, described in {rfc}`2439`, enables you to identify routes that repeatedly fail and return. If route dampening is enabled, an unstable route accumulates penalties each time the route fails and returns. If the accumulated penalties exceed a threshold, the route is no longer advertised. diff --git a/docs/configuration/service/console-server.md b/docs/configuration/service/console-server.md index 87464c88..4e0ec575 100644 --- a/docs/configuration/service/console-server.md +++ b/docs/configuration/service/console-server.md @@ -60,7 +60,7 @@ left unconfigured. :::{note} USB to serial converters will handle most of their work in software -so you should be careful with the selected baudrate as some times they +so you should be careful with the selected baudrate as sometimes they can't cope with the expected speed. ::: ``` diff --git a/docs/configuration/service/webproxy.md b/docs/configuration/service/webproxy.md index df675916..f76cb741 100644 --- a/docs/configuration/service/webproxy.md +++ b/docs/configuration/service/webproxy.md @@ -369,7 +369,7 @@ Download/Update complete blacklist vyos@vyos:~$ update webproxy blacklists Warning: No url-filtering blacklist installed Would you like to download a default blacklist? [confirm][y] -Connecting to ftp.univ-tlse1.fr (193.49.48.249:21) +Connecting to ftp.univ-tlse1.fr (192.0.2.249:21) blacklists.gz 100% |*************************************************************************************************************| 17.0M 0:00:00 ETA Uncompressing blacklist... Checking permissions... -- cgit v1.2.3 From 9968c956f3eb7f80839148cd0496f3780915e176 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Tue, 12 May 2026 09:04:47 +0300 Subject: docs: address ready-flip review (webproxy hostname, ospf grammar, ipsec polish) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - webproxy.md: replace `ftp.univ-tlse1.fr` with `ftp.example.com` so the hostname matches the documentation-reserved IP `192.0.2.249` (Copilot). - ospf.md: insert missing preposition in `show ip ospf interface` and `show ipv6 ospfv3 interface` op-cmd descriptions (CodeRabbit). - ipsec.md: rewrite intro sentence ("can significantly speed up …") and hyphenate `feature-rich` (CodeRabbit). 🤖 Generated by [robots](https://vyos.io) --- docs/configuration/protocols/ospf.md | 4 ++-- docs/configuration/service/webproxy.md | 2 +- docs/vpp/configuration/ipsec.md | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) (limited to 'docs/configuration/service/webproxy.md') diff --git a/docs/configuration/protocols/ospf.md b/docs/configuration/protocols/ospf.md index 4fcca823..b3297b3d 100644 --- a/docs/configuration/protocols/ospf.md +++ b/docs/configuration/protocols/ospf.md @@ -807,7 +807,7 @@ interface. ```{opcmd} show ip ospf interface [\] -This command displays state and configuration of OSPF the specified +This command displays state and configuration of OSPF for the specified interface, or all interfaces if no interface is given. ``` @@ -1402,7 +1402,7 @@ This command displays the neighbor DR choice information. ``` ```{opcmd} show ipv6 ospfv3 interface [prefix]|[\ [prefix]] -This command displays state and configuration of OSPF the specified +This command displays state and configuration of OSPF for the specified interface, or all interfaces if no interface is given. With the argument {cfgcmd}`prefix` this command shows connected prefixes to advertise. ``` diff --git a/docs/configuration/service/webproxy.md b/docs/configuration/service/webproxy.md index f76cb741..0a21bed1 100644 --- a/docs/configuration/service/webproxy.md +++ b/docs/configuration/service/webproxy.md @@ -369,7 +369,7 @@ Download/Update complete blacklist vyos@vyos:~$ update webproxy blacklists Warning: No url-filtering blacklist installed Would you like to download a default blacklist? [confirm][y] -Connecting to ftp.univ-tlse1.fr (192.0.2.249:21) +Connecting to ftp.example.com (192.0.2.249:21) blacklists.gz 100% |*************************************************************************************************************| 17.0M 0:00:00 ETA Uncompressing blacklist... Checking permissions... diff --git a/docs/vpp/configuration/ipsec.md b/docs/vpp/configuration/ipsec.md index 710a94b3..6ec442e3 100644 --- a/docs/vpp/configuration/ipsec.md +++ b/docs/vpp/configuration/ipsec.md @@ -9,12 +9,12 @@ lastproofread: '2025-09-04' # VPP IPsec Configuration -VPP Dataplane in VyOS can offload IPSec processing from kernel. This allows -to speed up IPSec traffic handling significantly when necessary conditions +VPP Dataplane in VyOS can offload IPSec processing from the kernel. This can +significantly speed up IPSec traffic handling when the necessary conditions are met. :::{note} -VPP IPsec implementation is not as feature rich as Linux kernel IPsec. It +VPP IPsec implementation is not as feature-rich as Linux kernel IPsec. It supports only a subset of algorithms and modes. ::: -- cgit v1.2.3