diff options
| author | Claude <noreply@anthropic.com> | 2026-05-11 19:54:12 +0000 |
|---|---|---|
| committer | Claude <noreply@anthropic.com> | 2026-05-11 19:54:12 +0000 |
| commit | 0d36eb00147b364c67791f5382f7591db04ddecf (patch) | |
| tree | b4595d2904bc76e45b3cbf4de9ca4bd3d918d59c | |
| parent | d9212421139416f1feb454ea71cfca75fa1ab2b8 (diff) | |
| download | vyos-documentation-0d36eb00147b364c67791f5382f7591db04ddecf.tar.gz vyos-documentation-0d36eb00147b364c67791f5382f7591db04ddecf.zip | |
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
| -rw-r--r-- | docs/automation/terraform/terraformAWS.md | 6 | ||||
| -rw-r--r-- | docs/configuration/protocols/bgp.md | 4 | ||||
| -rw-r--r-- | docs/configuration/service/console-server.md | 2 | ||||
| -rw-r--r-- | docs/configuration/service/webproxy.md | 2 |
4 files changed, 10 insertions, 4 deletions
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 <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html>`__ 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]: <https://github.com/vyos/vyos-automation/tree/main/TerraformCloud/AWS_terraform_ansible_single_vyos_instance-main> + +% 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 \<address|interface\> 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... |
