diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-14 00:51:12 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-14 00:51:12 +0300 |
| commit | 3c4b0d49a77e864bc20dc7b3609745912f59d585 (patch) | |
| tree | e8f26e6bb14cdf3e95fafb1e6d7f9bb1394a867d /docs/cli.md | |
| parent | 80f5a07903fe421415bf714fa9b51ba0d115e6d9 (diff) | |
| download | vyos-documentation-3c4b0d49a77e864bc20dc7b3609745912f59d585.tar.gz vyos-documentation-3c4b0d49a77e864bc20dc7b3609745912f59d585.zip | |
docs: fix CLI typo, orphan colon fences, CloudWatch capitalization
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)
Diffstat (limited to 'docs/cli.md')
| -rw-r--r-- | docs/cli.md | 5 |
1 files changed, 2 insertions, 3 deletions
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. |