From 80c5ca4aebb666932f681d2be0e7712e22d97f47 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Tue, 5 May 2026 01:42:07 +0300 Subject: docs: address review feedback from PR #1857 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fix conversion artifacts, typos, grammar errors, and technical inaccuracies flagged by automated code review (Copilot + CodeRabbit). Infrastructure: add root-level md-*.md exclusion to conf.py, fix sphinx-autobuild ignore globs in Makefile. Content: fix curly quotes, invalid Go panic() calls, shell quoting in cURL examples, incorrect firewall command paths, typos across 22 documentation files, remove duplicate sections. 🤖 Generated by [robots](https://vyos.io) --- docs/automation/md-cloud-init.md | 2 -- docs/automation/md-vyos-api.md | 4 ++-- docs/automation/md-vyos-govyos.md | 20 +++++++++----------- docs/automation/md-vyos-napalm.md | 2 -- docs/automation/md-vyos-pyvyos.md | 2 -- docs/automation/terraform/md-terraformAWS.md | 3 --- docs/automation/terraform/md-terraformAZ.md | 5 +++-- docs/automation/terraform/md-terraformGoogle.md | 10 +++++----- docs/automation/terraform/md-terraformvSphere.md | 3 +-- 9 files changed, 20 insertions(+), 31 deletions(-) (limited to 'docs/automation') diff --git a/docs/automation/md-cloud-init.md b/docs/automation/md-cloud-init.md index 01ad360d..b6350b54 100644 --- a/docs/automation/md-cloud-init.md +++ b/docs/automation/md-cloud-init.md @@ -371,8 +371,6 @@ Power on the VM using the CLI or GUI. After it boots, verify the configuration. - Cloud-init [network-config-docs]. - Proxmox [Cloud-init-Support]. - -[cloud-init-docs]: https://docs.vyos.io/en/equuleus/automation/cloud-init.html?highlight=cloud-init#vyos-cloud-init [cloud-init-support]: [cloud-init-write_files]: https://cloudinit.readthedocs.io/en/latest/topics/examples.html#writing-out-arbitrary-files [network-config-docs]: https://cloudinit.readthedocs.io/en/latest/topics/network-config.html diff --git a/docs/automation/md-vyos-api.md b/docs/automation/md-vyos-api.md index fd753838..66e8250c 100644 --- a/docs/automation/md-vyos-api.md +++ b/docs/automation/md-vyos-api.md @@ -527,7 +527,7 @@ request body. For example: ```none curl -k --location --request POST 'https://vyos/config-file' \ ---form data='{"op": "merge", "string": "interfaces {\nethernet eth1 {\naddress "192.168.2.137/24"\ndescription "test"\n}\n}\n"}' \ +--form data='{"op": "merge", "string": "interfaces {\nethernet eth1 {\naddress \"192.168.2.137/24\"\ndescription \"test\"\n}\n}\n"}' \ --form key='MY-HTTPS-API-PLAINTEXT-KEY' response: @@ -553,7 +553,7 @@ The following example uses the JSON format for brevity, though the standard form data format is equally valid: ```none -curl -k -X POST -d '{"key": "MY-HTTPS-API-PLAINTEXT-KEY", "op": "merge", "string": "interfaces {\nethernet eth1 {\naddress '192.168.137.1/24'\ndescription 'internal'\n}\n}\n", "confirm_time": 1}' https://vyos/config-file +curl -k -X POST -d '{"key": "MY-HTTPS-API-PLAINTEXT-KEY", "op": "merge", "string": "interfaces {\nethernet eth1 {\naddress \"192.168.137.1/24\"\ndescription \"internal\"\n}\n}\n", "confirm_time": 1}' https://vyos/config-file response: { diff --git a/docs/automation/md-vyos-govyos.md b/docs/automation/md-vyos-govyos.md index e5a444f1..c1d0b24a 100644 --- a/docs/automation/md-vyos-govyos.md +++ b/docs/automation/md-vyos-govyos.md @@ -76,7 +76,7 @@ fmt.Println(out.Success) ```none out, resp, err := c.Show.Do(ctx, "interfaces dummy dum1 address") if err != nil { - panic("Error: %v", err) + panic(fmt.Sprintf("Error: %v", err)) } fmt.Println(out.Success) @@ -89,7 +89,7 @@ fmt.Printf("Data: %v\n", out.Data) ```none out, resp, err := c.Conf.Get(ctx, "interfaces dummy dum1", nil) if err != nil { - panic("Error: %v", err) + panic(fmt.Sprintf("Error: %v", err)) } fmt.Println(out.Success) @@ -106,7 +106,7 @@ options := RetrieveOptions{ out, resp, err := c.Conf.Get(ctx, "interfaces dummy dum1", options) if err != nil { - panic("Error: %v", err) + panic(fmt.Sprintf("Error: %v", err)) } fmt.Println(out.Success) @@ -118,7 +118,7 @@ fmt.Println(out.Success) ```none out, resp, err := c.Conf.Delete(ctx, "interfaces dummy dum1") if err != nil { - panic("Error: %v", err) + panic(fmt.Sprintf("Error: %v", err)) } fmt.Println(out.Success) @@ -131,7 +131,7 @@ fmt.Println(out.Success) out, resp, err := c.Conf.Save(ctx, "") if err != nil { - panic("Error: %v", err) + panic(fmt.Sprintf("Error: %v", err)) } fmt.Println(out.Success) @@ -144,7 +144,7 @@ fmt.Println(out.Success) out, resp, err := c.Conf.Save(ctx, "/config/test300.config") if err != nil { - panic("Error: %v", err) + panic(fmt.Sprintf("Error: %v", err)) } fmt.Println(out.Success) @@ -156,7 +156,7 @@ fmt.Println(out.Success) ```none out, resp, err := c.Show.Do(ctx, "system image") if err != nil { - panic("Error: %v", err) + panic(fmt.Sprintf("Error: %v", err)) } fmt.Println(out.Success) @@ -169,7 +169,7 @@ fmt.Printf("Data: %v\n", out.Data) ```none out, resp, err := c.Generate.Do(ctx, "pki wireguard key-pair") if err != nil { - panic("Error: %v", err) + panic(fmt.Sprintf("Error: %v", err)) } fmt.Println(out.Success) @@ -182,7 +182,7 @@ fmt.Printf("Data: %v\n", out.Data) ```none out, resp, err := c.Reset.Do(ctx, "ip bgp 192.0.2.11") if err != nil { - panic("Error: %v", err) + panic(fmt.Sprintf("Error: %v", err)) } fmt.Println(out.Success) @@ -195,5 +195,3 @@ fmt.Printf("Data: %v\n", out.Data) ```none out, resp, err := c.ConfigFile.Load(ctx, "/config/test300.config") ``` - -[go-vyos]: https://github.com/ganawaj/go-vyos diff --git a/docs/automation/md-vyos-napalm.md b/docs/automation/md-vyos-napalm.md index 27e3c16c..d656c7c2 100644 --- a/docs/automation/md-vyos-napalm.md +++ b/docs/automation/md-vyos-napalm.md @@ -149,6 +149,4 @@ $./vyos-napalm.py +name-server 203.0.113.8 [edit] ``` - -[napalm]: https://napalm.readthedocs.io/en/latest/base.html [NAPALM VyOS driver]: https://github.com/napalm-automation-community/napalm-vyos diff --git a/docs/automation/md-vyos-pyvyos.md b/docs/automation/md-vyos-pyvyos.md index c9dcbc81..1a6a09fd 100644 --- a/docs/automation/md-vyos-pyvyos.md +++ b/docs/automation/md-vyos-pyvyos.md @@ -147,5 +147,3 @@ if not response.error: ```none response = device.config_file_load(file="/config/test300.config") ``` - -[pyvyos]: https://github.com/robertoberto/pyvyos diff --git a/docs/automation/terraform/md-terraformAWS.md b/docs/automation/terraform/md-terraformAWS.md index b0c06bb1..488e7926 100644 --- a/docs/automation/terraform/md-terraformAWS.md +++ b/docs/automation/terraform/md-terraformAWS.md @@ -544,8 +544,5 @@ All files related to deploying VyOS on AWS with Terraform and Ansible can be found in the [vyos-automation] repository. [group]: https://docs.aws.amazon.com/cli/latest/userguide/cli-services-ec2-sg.html -[image]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html -[install]: https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli -[link]: https://developer.hashicorp.com/terraform/intro [pair]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html [vyos-automation]: diff --git a/docs/automation/terraform/md-terraformAZ.md b/docs/automation/terraform/md-terraformAZ.md index 05856824..b1b8fac0 100644 --- a/docs/automation/terraform/md-terraformAZ.md +++ b/docs/automation/terraform/md-terraformAZ.md @@ -400,7 +400,8 @@ variable "admin_username" { variable "admin_password" { description = "Administrator password" - default = "Vyos0!" + type = string + sensitive = true } variable "source_network" { @@ -488,7 +489,7 @@ ansible_network_os: vyos.vyos.vyos # user and password gets from terraform variables "admin_username" and "admin_password" in the file /root/azvyos/var.tf ansible_user: vyos -ansible_ssh_pass: Vyos0! +ansible_ssh_pass: "{{ vault_vyos_ssh_pass }}" ``` diff --git a/docs/automation/terraform/md-terraformGoogle.md b/docs/automation/terraform/md-terraformGoogle.md index 7236b045..f9c002a7 100644 --- a/docs/automation/terraform/md-terraformGoogle.md +++ b/docs/automation/terraform/md-terraformGoogle.md @@ -466,12 +466,12 @@ resource "google_compute_firewall" "udp_500_4500" { name = "${var.goog_cm_deployment_name}-udp-500-4500" network = element(var.networks, 0) -allow { - ports = ["500", "4500"] - protocol = "udp" -} + allow { + ports = ["500", "4500"] + protocol = "udp" + } -source_ranges = ["0.0.0.0/0"] + source_ranges = ["0.0.0.0/0"] target_tags = ["${var.goog_cm_deployment_name}-deployment"] } diff --git a/docs/automation/terraform/md-terraformvSphere.md b/docs/automation/terraform/md-terraformvSphere.md index 8bbb91e9..abcef5fa 100644 --- a/docs/automation/terraform/md-terraformvSphere.md +++ b/docs/automation/terraform/md-terraformvSphere.md @@ -345,7 +345,7 @@ remote_user=vyos # About tasks: # "Wait 300 seconds, but only start checking after 60 seconds" - try to make ssh connection every 60 seconds until 300 seconds # "Configure general settings for the VyOS hosts group" - make provisioning into vSphere VyOS node -# You have to add all necessary cammans of VyOS under the block "lines:" +# You have to add all necessary commands of VyOS under the block "lines:" ############################################################################## @@ -363,7 +363,6 @@ remote_user=vyos vyos_config: lines: - set system name-server 192.0.2.1 - - set system name-server 192.0.2.1 save: true ``` -- cgit v1.2.3