| Age | Commit message (Collapse) | Author |
|---|
|
This reverts commit 4b36114e053ee11d0cb264a1e4cfe4692d78f194.
|
|
* feat: add swap_sources.py for incremental RST-to-MyST migration
Pre-build swap/restore script that renames md-{name}.md β {name}.md
before Sphinx builds and restores after. Includes state tracking,
exclude file generation, collision detection, and partial-failure
rollback. 10 tests cover all specified behaviors plus rollback path.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* feat: add import_myst.py for importing MyST files from myst/* branches
Adds scripts/import_myst.py with import_page, git_show, list_myst_files,
list_rst_files, and do_import. Imported files are written as md-{name}.md
alongside existing RST files; importing is decoupled from swap activation.
Adds tests/test_import_myst.py covering single-page write, identical-skip,
warn-on-different-without-force, force-overwrite, and nested-path creation.
All 5 tests pass on Python 3.9.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* feat: add MyST swap exclude patterns and directive config to conf.py
π€ Generated by [robots](https://vyos.io)
* feat: add swap-wrapped rendering targets to Makefile
π€ Generated by [robots](https://vyos.io)
* feat: add swap pre/post build hooks for ReadTheDocs
π€ Generated by [robots](https://vyos.io)
* feat: add empty _swap.txt, remove atexit from swap script
The atexit handler in --swap mode caused immediate restore on process
exit, breaking standalone usage. Makefile trap and RTD post_build
handle restore reliably.
π€ Generated by [robots](https://vyos.io)
* feat: activate quick-start as MyST canary via swap mechanism
Imports docs/md-quick-start.md from origin/myst/current and adds
quick-start to docs/_swap.txt. Validates the swap pipeline end-to-end
on one page: import_myst pulls the MD via git show, swap_sources
renames md-quick-start.md to quick-start.md, sphinx-build renders
quick-start.html with zero MD-specific warnings, and restore reverses
the rename cleanly.
π€ Generated by [robots](https://vyos.io)
* feat: activate 106 visual-validated canaries via swap
Imports 105 MD files (plus quick-start already present) from
origin/myst/current and adds them to docs/_swap.txt. The selection
is the BackstopJS visual-passers cohort: pages with <5% rendered
diff vs the live RST docs at docs.vyos.io/en/latest/, filtered to
those with an RST counterpart on current and no cmdincludemd usage
(template-format reconciliation pending).
Local sphinx-build with all 106 swapped: succeeded with 100
warnings (vs 95 baseline). The 5 new warnings are all undefined
cross-reference labels, not build failures:
- contributing/development.md (missing 'coding-guidelines')
- operation/upgrade-recovery.md (3 missing 'how_it_works' /
'cancelling_recovery')
- vpp/configuration/dataplane/{buffers,memory,unix}.md (missing
'vpp_config_dataplane_*' labels)
Source list: ~/.claude/projects/-Users-vybot-GitHub-vyos-documentation/docs/2026-04-29-myst-conversion-audit/visual-passers-under-5pct.txt
BackstopJS report: claude/gifted-hertz-74b9f9 worktree
(visual-compare/), 2026-04-23 vs vyos--1838.org.readthedocs.build.
π€ Generated by [robots](https://vyos.io)
* fix: re-import 4 canary md-*.md files with xref label fixes
Re-imports the dash-form-corrected versions of:
- contributing/md-development.md (added (coding-guidelines)= anchor)
- operation/md-upgrade-recovery.md (3 ref renames: how_it_works /
cancelling_recovery -> dash form)
- vpp/configuration/dataplane/md-buffers.md (vpp_config_dataplane_physmem
-> vpp-config-dataplane-physmem)
- vpp/configuration/dataplane/md-unix.md
(vpp_config_dataplane_interface_rx_mode
-> vpp-config-dataplane-interface-rx-mode)
Source: origin/myst/current commit 59fbe3ea. Verified locally: clean
swap-build no longer reports any of the 5 target labels (1 of 6 β
vpp-config-hugepages β remains because system.md isn't in the canary
swap list; that anchor lives there).
π€ Generated by [robots](https://vyos.io)
* fix: re-add 4 canary md-*.md files deleted by 242b334a
Commit 242b334a accidentally staged deletions instead of modifications
because the working tree had unprefixed *.md files left over from an
incomplete swap-restore cycle. Re-imports the same 4 files from
origin/myst/current with the xref label fixes applied:
- contributing/md-development.md β (coding-guidelines)= anchor
- operation/md-upgrade-recovery.md β how_it_works β how-it-works,
cancelling_recovery β cancelling-recovery
- vpp/configuration/dataplane/md-buffers.md β vpp_config_dataplane_physmem
β vpp-config-dataplane-physmem
- vpp/configuration/dataplane/md-unix.md β vpp_config_dataplane_interface_rx_mode
β vpp-config-dataplane-interface-rx-mode
Source: origin/myst/current commit 59fbe3ea.
π€ Generated by [robots](https://vyos.io)
* fix: resolve remaining xref label gaps in swap-active build
Three small additions clear the cross-reference warnings tied to
underscore-vs-dash label form mismatches and the vpp-config-hugepages
reference that previously needed system.md in the canary set.
- system.rst: add .. _vpp-config-hugepages: alongside the existing
underscore label so memory.md references resolve regardless of
whether system.md is swap-active.
- md-lcp.md: add (vpp_config_dataplane_lcp_ignore-kernel-routes)=
alongside dash form (carries upstream from myst/current 079fa786).
- md-memory.md: add (vpp_config_dataplane_memory)= alongside dash
form (also from myst/current 079fa786).
Local clean swap-build with 106 canaries:
before: 305 warnings, 8 undefined-label entries in our scope
after: 300 warnings, 0 undefined-label entries in our scope
Remaining undefined-label warnings (release-notes, prepare_commit)
are in documentation.rst and unrelated to the canary swap mechanism.
π€ Generated by [robots](https://vyos.io)
* fix: re-add md-lcp.md and md-memory.md (deleted by 870c9e7e)
Same disaster pattern as 242b334a: a swap-restore cycle left
unprefixed *.md files in the working tree, and the subsequent
git add staged deletions instead of modifications. Restoring the
two affected md-*.md files from origin/myst/current 079fa786
(which has the dual underscore+dash anchors needed for the
swap-active build).
π€ Generated by [robots](https://vyos.io)
* feat: expand canaries to 114; refresh 3 with cfgcmd body fix
Adds 8 new visual-validated canaries from the post-cfgcmd-fix
BackstopJS run (2026-04-29):
- configuration/policy/as-path-list
- configuration/policy/community-list
- configuration/policy/extcommunity-list
- configuration/policy/large-community-list
- configuration/policy/local-route
- configuration/policy/prefix-list
- configuration/service/salt-minion
- configuration/system/updates
Refreshes 3 existing canaries whose MD content changed via the
cfgcmd/opcmd single-line body fix on myst/current fc19ab5c:
- configuration/firewall/global-options
- configuration/firewall/groups
- configuration/policy/route
All 11 sourced from origin/myst/current. Net: 106 -> 114 canaries.
π€ Generated by [robots](https://vyos.io)
* fix: re-import md-cloud-init.md (block 3 fix from myst/current)
π€ Generated by [robots](https://vyos.io)
* feat(swap): import .md files and webp transition from myst/current
Selective import from origin/myst/current (cf9c9b34):
- Add/update 255 .md files (full MyST conversion plus webp ref updates)
- Delete 175 PNG/JPG from docs/_static/images (webp twins already present)
- Delete 5 autotest topology.png (webp twins already present)
Preserved on swap (untouched):
- All .rst files (incremental swap pattern)
- conf.py, _ext/, _include/*.txt, .gitignore
- 115 canary md-*.md files
- 7 superpowers/specs/*.md design docs
- Logos vyos-logo.png / vyos-logo-icon.png (referenced by conf.py)
π€ Generated by [robots](https://vyos.io)
* chore(swap): remove canary md-*.md files and docs/superpowers
- Remove 115 canary md-*.md files (incremental swap helpers no longer needed)
- Remove 8 files under docs/superpowers (project planning/design docs that
shouldn't ship in the documentation tree)
π€ Generated by [robots](https://vyos.io)
* docs: address Copilot review feedback on imported MyST pages
Fix issues flagged by Copilot review on PR #1857 (the same content lives
in myst/current as the canonical source):
Real bugs:
- site-2-site-cisco.md: replace curly quote (U+2019) with ASCII apostrophe
- rsa-keys.md: fix typo "key-pair nam>>" β "key-pair name>"
- vmware.md: lowercase admonition directive (:::{NOTE} β :::{note})
- vpp/configuration/nat/index.md: remove blank line inside {include} fence
Grammar:
- vpp/configuration/interfaces/loopback.md: "bounded" β "bound"
- vpp/configuration/sflow.md: "VyOS support" β "VyOS supports"
- vpp/requirements.md: "bypass" β "bypasses"
- vpp/configuration/dataplane/interface.md: "configures" β "configure"
CI linter (IP addresses):
- nmp.md: wrap 8.8.8.8 example with stop/start_vyoslinter
- lac-lns.md: wrap LNS config block (contains 8.8.8.8)
- wan-load-balancing.md: wrap whole file (illustrative non-RFC IPs)
- policy/examples.md: replace 192.0.1.1 with RFC 5737 192.0.2.1
π€ Generated by [robots](https://vyos.io)
* fix(swap): address Copilot review feedback on swap infrastructure
Category D β drop obsolete canary mechanism settings:
- conf.py: remove '**/md-*.md' from exclude_patterns (no canaries left)
- Makefile: replace malformed '*/_build/*' with '$(BUILDDIR)/**' and drop
the '*/md-*' ignore (canary files no longer exist)
Category C β script robustness:
- import_myst.py:
* list_myst_files() now raises SystemExit on git ls-tree failure instead
of silently returning [] (would have masked typo'd --source refs)
* list_rst_files() skips _build/ when scanning for .rst stems
* import_page() rejects stems containing '..' or absolute paths and
re-checks that the resolved destination stays under docs_dir
* --dry-run uses a separate "would_import" counter; summary line now
distinguishes dry-run from actual imports
- swap_sources.py:
* parse_swap_list() reads with explicit encoding='utf-8'
* do_restore() validates state file version + entry shape before
renaming files; raises with actionable message on corruption
* State file reads/writes use explicit encoding='utf-8' throughout
_swap.txt:
- Wrap long comment line to satisfy 80-character doc-linter limit
π€ Generated by [robots](https://vyos.io)
* refactor(swap): rename imported .md files to md- prefix for swap mechanism
Restore the canary file naming convention that swap_sources.py expects:
the imported MyST pages now live as docs/<dir>/md-<name>.md alongside
the existing docs/<dir>/<name>.rst, so swap_sources.py --swap can rename
them into place at build time.
- 254 .md files renamed (every page with a matching .rst counterpart)
- 2 MyST-only pages left at their final names (no .rst exists, no swap
needed): docs/copyright.md, docs/automation/terraform/terraformvyos.md
All 114 stems listed in docs/_swap.txt now have a corresponding
md-<name>.md source file ready to swap in.
π€ Generated by [robots](https://vyos.io)
* docs: address CodeRabbit review feedback on imported MyST pages
Fix issues flagged by CodeRabbit on PR #1857. All issues are pre-existing
in the upstream RST docs and inherited by the MyST conversion.
Real bugs:
- inter-vrf-routing-vrf-lite.md: invalid IPv6 next-hop "2001:db8::*" β
"2001:db8::1"
- ipsec-pa-route-based.md: vendor mislabel "Cisco" β "Palo Alto"
(header on line 39 and "Monitoring on Cisco side" section heading)
- bgp-ipv6-unnumbered.md: AS number mismatch between configuration and
verification output for both routers (Router A: 65020 β 64496;
Router B: 65021 β 64499)
- qos.md: class 30 used "match ADDRESS20" instead of ADDRESS30 β broke
the documented pattern (classes 10/20/30 β ADDRESS10/20/30)
Security:
- OpenVPN_with_LDAP.md: redact full PEM private key material from the
three "set pki ... private key '...'" lines and from the embedded
OpenVPN client <key> block; replace with <REDACTED> / ...REDACTED...
placeholders. Public certificates retained.
π€ Generated by [robots](https://vyos.io)
* feat(swap): default to serving MyST for all swapped pages
Replace the previously-curated 114-stem _swap.txt with the full set of
254 imported md-prefixed pages, so MD is served by default at build
time. To revert any specific page back to RST, remove its stem from
_swap.txt (or comment it out).
π€ Generated by [robots](https://vyos.io)
* fix(ext): handle RST fallback in CmdInclude when _renderer absent
`cmdincludemd` is in `myst_fence_as_directive`, so MyST routes
fence blocks through `render_fence β render_restructuredtext β
MockRSTParser`. In that path `self.state` is a plain docutils Body
with no `_renderer`, crashing the build.
Fall back to `nested_parse` when `_renderer` is unavailable so the
directive works in both MyST and RST/MockRSTParser contexts.
π€ Generated by [robots](https://vyos.io)
* feat(conf): copy .md sources into HTML output for plain-text serving
Adds a build-finished hook that mirrors every .md file from the Sphinx
source tree into the HTML output directory verbatim, making unrendered
MyST sources accessible alongside HTML renders at the same URL path.
π€ Generated by [robots](https://vyos.io)
* docs: address review feedback from PR #1857
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)
---------
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
|
|
The markers suppress the linter IPv6 check on ``<prefix>::64``,
which the regex matches as a non-documentation address.
π€ Generated by [robots](https://vyos.io)
|
|
- pppoe-ipv6-basic.rst: remove stop/start_vyoslinter pair added in error
(content between markers had no real IPs and no lines > 80 chars)
- OpenVPN_with_LDAP.rst: replace stop_vyoslinter around long line-block
URL with a named hyperlink target whose URL wraps to the next line
- wireguard.rst: split long named hyperlink target onto two lines,
eliminating the need for stop/start_vyoslinter markers
π€ Generated by [robots](https://vyos.io)
|
|
Wrap prose lines exceeding 80 chars and apply stop/start_vyoslinter
markers around cfgcmd/opcmd directive lines that cannot be shortened
(e.g. long option names with placeholder arguments).
Affected files: bonding, wireguard, pim, conntrack-sync, dmvpn,
ipsec_general, site2site_ipsec, vrf/index, bare-metal,
inter-vrf-routing-vrf-lite, lac-lns, tunnelbroker, OpenVPN_with_LDAP,
dmvpn-dualhub-dualcloud.
π€ Generated by [robots](https://vyos.io)
|
|
The following files were touched by the WebP image PR and exposed
pre-existing lint violations β real IPs needed for authenticity or
actual protocol addresses (OSPF router-IDs, MAC-embedded IPv6):
- inter-vrf-routing-vrf-lite.rst: 195.51.100.1, 198.51.0.0/16
- ipsec-cisco-route-based.rst: 1.1.1.1, 2.2.2.2, 1.0.0.0 (Cisco loopback/OSPF RID)
- ipsec-pa-route-based.rst: 1.1.1.1, 2.2.2.2 (PA/VyOS OSPF RIDs)
- lac-lns.rst: 8.8.8.8 (DNS example)
- pppoe-ipv6-basic.rst: ::64 (prefix format illustration)
- bridge.rst: 33:33::16:50:0 (MAC address in firewall log)
π€ Generated by [robots](https://vyos.io)
|
|
The tunnelbroker.net example intentionally uses real Hurricane Electric
IPv6 addresses (2001:470:*) β needed for authenticity. Wrap all
affected code blocks with stop/start_vyoslinter.
π€ Generated by [robots](https://vyos.io)
|
|
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Add WebP versions of all 187 PNG/JPG images (38MB β 17MB, 55% reduction).
Update RST/MD references to use Sphinx wildcard syntax (.*) so HTML builds
use WebP while PDF/LaTeX builds fall back to original PNG/JPG.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
* docs: fix typos and improve prose in terraform, ansible, and config docs
Fix typos (VyoSβVyOS, respresentβrepresents), rewrap long prose
lines for readability, restore correct YAML indentation in Ansible
examples, and standardize heading hierarchy in affected files.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: replace public DNS IP with RFC 5737 address in NMP example
Use 198.51.100.1 (TEST-NET-2) instead of 8.8.8.8 to satisfy the
documentation linter requirement for reserved addresses.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: restore linter markers around NMP code block with 8.8.8.8
Restore stop/start_vyoslinter markers that were incorrectly removed.
The DNS server address is intentional and should not be changed.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
Normalize top-level page headings from = or * underline-only to #
overline+underline format, following RST/Sphinx best practices for
consistent heading hierarchy.
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
* docs: fix tab-to-space indentation in code blocks across 5 files
Replace tab characters with spaces inside code-block and output
directives for consistent rendering. Also rewrap long prose lines
for readability.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* chore: remove accidentally committed settings file
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: fix inconsistent indentation in trafficpolicy and qos code blocks
Normalize indentation within code blocks where tab-to-space
conversion left some entries misaligned (tbit, gibps, tibps
in trafficpolicy; egress command in qos).
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
|
* chore: add TODO markers for 12 files needing cfgcmd/opcmd conversion
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: fill TBD placeholder in flow-accounting, remove TBD in static routes
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* docs: add stub admonitions to 3 minimal pages
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: replace non-RFC IP addresses and suppress false positives in linter
Replace public IPs with RFC 5737 documentation addresses and add
stop/start_vyoslinter markers for false positives (MAC addresses,
OIDs, NAT64 well-known prefix).
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: replace remaining non-RFC IPs and suppress MAC address false positive
- Replace 8.8.8.8 (Google DNS) with 192.0.2.1 (RFC 5737) in:
- docs/configexamples/ansible.rst (3 occurrences)
- docs/configexamples/nmp.rst (1 occurrence)
- docs/automation/terraform/terraformvSphere.rst (1 occurrence)
- Wrap SHA-256 certificate fingerprint in openvpn-examples.rst with
stop_vyoslinter/start_vyoslinter to suppress false-positive IPv6 flag
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: wrap long lines to comply with 80-char line length limit
Wrapped prose content exceeding 80 characters in 9 documentation files.
Only RST prose and directive content was modified; code block contents
were left untouched as they are exempt from the linter.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: wrap 2 remaining long lines for linter compliance
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* fix: suppress linter for long URL reference in terraformvSphere.rst
* fix: address Copilot review suggestions β broken links, typos, YAML indentation
- Fix broken inline RST links split across lines in sysctl.rst, eve-ng.rst,
oracle.rst (stub notes with VyOS documentation repository link)
- Fix YAML indentation in both playbook code blocks in ansible.rst
- Fix typo "VyoS" -> "VyOS" in ansible.rst
- Fix typo "desition" -> "decision" in terraformvSphere.rst
- Fix 4 occurrences of "Terrafom" -> "Terraform" in terraformvSphere.rst
- Fix :doc: role split across two lines in openvpn-examples.rst
- Wrap long paragraph in openconnect.rst to <=80 chars and remove
unnecessary stop/start_vyoslinter markers
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: resolve remaining linter failures β long lines and OID false positive
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* fix: revert 8.8.8.8 replacements, use stop_vyoslinter instead
---------
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
|
|
|
|
Fixed typos in networks
|
|
configurations (#1719)
The previous 'connection-type respond' option in IPsec site-to-site peers
was misleading - instead of passively waiting for peer initiation, it would
initiate negotiation when matching traffic appeared, potentially causing
SA duplication and renegotiation loops.
|
|
|
|
Add missed `Virtual-Template1` for LAC L2TP Cisco config example
|
|
|
|
Fixed typos of the ESP group name in the IPsec documentation
|
|
Added blueprint Policy-based Site-to-Site IPsec VPN with Cisco IOS.
Added blueprint Route-based Site-to-Site IPsec VPN with Cisco IOS.
Added blueprint Route-based Site-to-Site IPsec VPN with Palo Alto.
|
|
|
|
DMVPN Dual Hub Dual Cloud blueprint
|
|
blueprints for bridge and firewall configuration
|
|
|
|
about usage of inbound and outbound interface when interface is attached to a non-default vrf.
|
|
|
|
Corrected the grammar and added the vyos client configuration
|
|
|
|
Fix spelling mistakes across multiple files
|
|
Modified old option from 'enable-default-log' to new one 'default-log'
|
|
|
|
|
|
dynamic IPs (#1415)
|
|
|
|
Ansible: rephrasing
|
|
|
|
|
|
Rewritten the L2TP documentation
Added the example 'PPPoE over L2TP' to blueprints
|
|
|
|
|
|
|
|
|
|
|
|
Ansible example article
|
|
|
|
Update some nat commands to new syntax
|
|
An example of how to set up Ansible and VyOS.
|
|
|
|
tunnel, plus firewall, using new firewall sintax
|
