vyos-documentation.git/docs/cli.md, branch mergify/bp/scutum/pr-2246

T3871: bind interface names to hardware slots instead of hw-id (#2246)

2026-10-31T13:36:49+00:00

* docs: T3871: describe how interface names are assigned Names are no longer derived from the hw-id node. They are bound to the slot the hardware occupies and recorded in a mapping file, so document what decides a name, what happens when a card is replaced or added, and how to rename an interface. The troubleshooting page said to pin a MAC with hw-id when interfaces were renamed after a VM migration or a clone. That node no longer exists and the situation it describes no longer arises, so replace it with a pointer to the new section and a note on where to look when an interface really is missing. * docs: T3871: drop hw-id from the example output The node is gone from the CLI, so example configuration dumps which still show it no longer match what a reader sees on their own system. Remove it from the shown output only; no prose changes. The comparison shown on the testing page is rewritten rather than trimmed, as deleting the lines would have left an edit level behind with nothing under it. (cherry picked from commit f939f4eb05f55e7e4c81e1b5dc954c3fc06d2389)

docs(cli, aws): hard-wrap pre-existing long prose lines to <=80 chars

2026-05-13T23:14:53+00:00

doc-lint regression on [vyos-documentation#2024](https://github.com/vyos/vyos-documentation/pull/2024): the CI workflow's `scripts/doc-linter.py` scans every line of every changed file (not just changed lines), so the typo fix on `cli.md:464` and the capitalization fix on `aws.md:118` surfaced 57 pre-existing >80-char violations that have lived on rolling since the MyST migration. `cli.md` — 53 prose paragraphs hard-wrapped at word boundaries to 80 chars, preserving content fidelity. List items use hanging-indent continuations under their `- ` marker. No content reworded; only soft-wrap → hard-wrap. `aws.md` — wrapped the inline AWS GWLB blog link (L164) and the References section (L185-187) with `% stop_vyoslinter` / `% start_vyoslinter` markers. These are URL-bearing lines that cannot be shortened (URL itself >80 chars). Verified locally: `python3 scripts/doc-linter.py "['docs/cli.md','docs/installation/cloud/aws.md','docs/automation/terraform/terraformvyos.md']"` → exit 0, no violations. 🤖 Generated by [robots](https://vyos.io)

docs: fix CLI typo, orphan colon fences, CloudWatch capitalization

2026-05-13T23:14:32+00:00

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)

feat: flip swap mechanism on circinus — MD as primary, RST as override

2026-05-06T18:08:17+00:00

Mirror of #1899 for circinus. Same logic, same scripts, per-branch file set. Changes: - Rename docs/**/md-.md to docs/**/.md (drop md- prefix) for all 253 stems previously listed in docs/_swap.txt - Rename docs/**/.rst to docs/**/rst-.rst (add rst- prefix) for the same 253 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty - conf.py exclude_patterns flipped: rst-*.rst excluded by default - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt - scripts/swap_sources.py rewritten with inverted rename direction (rst-.rst → .rst when applying overrides; .md excluded via _md_exclude.txt) - scripts/import_myst.py and tests/test_import_myst.py deleted (obsolete) - tests/test_swap_sources.py rewritten for new semantics Identical change set to #1899 (current). Per-branch differences: - circinus has 253 stems vs current's 254 (suricata is current-only) - otherwise the script/conf.py/test changes are byte-identical with current Generated by robots https://vyos.io