From 3c4b0d49a77e864bc20dc7b3609745912f59d585 Mon Sep 17 00:00:00 2001 From: Yuriy Andamasov Date: Thu, 14 May 2026 00:51:12 +0300 Subject: docs: fix CLI typo, orphan colon fences, CloudWatch capitalization MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Three pre-existing rolling docs bugs, surfaced by Copilot review on the sagitta RST→MD conversion PR #2022 against the byte-for-byte ports of `cli.md` and `aws.md`: - `cli.md` line 464: `set interface ethernet …` is wrong; the CLI command is `set interfaces ethernet …` (plural). Users copying the example verbatim would hit "Configuration path is not valid". - `cli.md` lines 527-528: orphan `:::` / `::::` fence closers after the `{cfgcmd} save` block. The `(save)=` directive opens at line 503 and closes at line 506; the two `` ``` none `` blocks at 508-526 are self-contained; nothing opens these colon fences. MyST/Sphinx tolerates them silently today but they're literal noise. Drop both. - `aws.md` line 118: "Cloudwatch" → "CloudWatch", matching the surrounding correctly-cased uses on lines 115/121/122 and AWS's product naming. Mergify will backport to circinus and sagitta via the standard `@Mergifyio backport circinus sagitta` post-merge. 🤖 Generated by [robots](https://vyos.io) --- docs/cli.md | 5 ++--- docs/installation/cloud/aws.md | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/cli.md b/docs/cli.md index e961c790..6d4e6fad 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -461,7 +461,7 @@ Configuration commands are flattened from the tree into \'one-liner\' commands s ``` none [edit] -vyos@vyos# set interface ethernet eth0 address 192.0.2.100/24 +vyos@vyos# set interfaces ethernet eth0 address 192.0.2.100/24 ``` ``` none @@ -524,8 +524,7 @@ Saving configuration to 'tftp://192.168.0.100/vyos-test.config.boot'... Done ``` -::: -:::: + ```{cfgcmd} exit \[discard\] Configuration mode can not be exited while uncommitted changes exist. To exit configuration mode without applying changes, the {cfgcmd}`exit discard` command must be used. diff --git a/docs/installation/cloud/aws.md b/docs/installation/cloud/aws.md index de5da3aa..9cefe369 100644 --- a/docs/installation/cloud/aws.md +++ b/docs/installation/cloud/aws.md @@ -115,7 +115,7 @@ Parameter Store. For instructions on creating a configuration, see ### CloudWatch SSM Configuration creation -Creating the Amazon Cloudwatch Agent Configuration in Amazon +Creating the Amazon CloudWatch Agent Configuration in Amazon {abbr}`SSM (Systems Manager)` Parameter Store. 1. Create an {abbr}`IAM (Identity and Access Management)` role for your -- cgit v1.2.3