summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2026-04-09Proofread docs in the /automation/terraform directory (#1800)Quill
* Proofread terraformAWS.rst * Proofread terraformAZ.rst * Edit terraformGoogle.rst * Edit terraformvSphere.rst * Move directory of Terraform guides into terraform/index * Fix line length lint errors * Fix addtional line length lint errors
2026-04-09DOC: Proofread files in the /configuration/loadbalancing directory (#1821)Quill
* Initial proofread * Fix line length lint errors
2026-04-07T8046: traffic-engineering (#1726)Kyrylo Yatsenko
2026-04-03DOC: Proofread command-scripting.rst (#1813)LiudmylaNad
2026-04-03DOC: Add CLIs and their description for VTIs (#1811)LiudmylaNad
2026-04-03DOC: Proofread wwan.rst (#1812)LiudmylaNad
2026-03-30Add TODO markers, fill placeholders, mark stub pages (#1802)Yuriy Andamasov
* 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>
2026-03-30Split troubleshooting, add contributing index, clean VPN structure (#1804)Yuriy Andamasov
* Add design spec for documentation improvements Covers 4 work streams: mechanical fixes (headings, indentation, typos), content quality (TODO flags, TBD fills, stub markers), structural reorganization (troubleshooting split, contributing index, VPN cleanup), and RTD platform cleanup (hide versions, delete stale redirects). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix spec issues from review: correct heading chars, tab counts, line numbers Addresses 10 reviewer findings: corrected heading character types (^ was actually -), removed ip.rst (already correct), updated file count from 37 to 35, listed all 13 tab-containing files, fixed troubleshooting line count to 460, added heading level guidance for split pages, clarified contributing/documentation.rst scope, removed current from hide list, added rollback verification step, updated success criteria. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Add implementation plan for documentation improvements 16 tasks across 4 work streams: mechanical fixes (PR 1, tasks 1-6), content quality (PR 2, tasks 7-10), structural reorg (PR 3, tasks 11-14), and RTD platform cleanup (tasks 15-16). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix 6 issues from plan review - Replace hardcoded RTD token with $RTD_TOKEN variable - Fix Task 7 heading reference to be format-agnostic - Correct RTD PATCH expected response (200, not 204) - Fix version verification to check hidden field, not active - Account for blank lines 402-403 in troubleshooting split - Clarify start/stop_vyoslinter handling in system.rst Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor: split troubleshooting into 5 focused sub-pages Split monolithic 460-line troubleshooting/index.rst into: - connectivity.rst (ping, traceroute, mtr, IPv6 discovery) - interfaces.rst (interface naming, MAC addresses) - monitoring.rst (traffic dumps, bandwidth, iperf) - terminal.rst (console clearing, counter resets) - system.rst (boot steps, system information) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * refactor: create contributing/index.rst, simplify root toctree * fix: remove 'pages to sort' placeholders from VPN section * fix: wrap long lines in index.rst for linter compliance * Add design spec for sitemap generation improvement * Fix sitemap spec: remove invalid sitemap_excludes, add version pin * fix: address Copilot review suggestions — grammar, typos, RST markup fixes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: resolve remaining long lines in index.rst Shorten :ref: display text on two lines that exceeded the 80-char limit: "Virtual Environment" -> "VM" (line 24, 90 -> 73 chars) and "Configuration Blueprints" -> "Blueprints" (line 51, 85 -> 71 chars). Both targets remain correct; display text is clear in context. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore: remove superpowers specs from PR Specs moved to personal branch yuriy/docs-modernization-specs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-30DOC: Proofread wireless.rst (#1806)LiudmylaNad
* DOC: Proofread wireless.rst * Apply suggestion from @dmbaturin --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>
2026-03-26T8433: remove changelogs from documentation (#1809)Daniil Baturin
They are kept in Phorge and the KB and do not need to be duplicated here
2026-03-20vpp: T8315: Update NIC requirements and add supported hardware list (#1792)Alexandr K.
2026-03-17Proofread files in /vpp/configuration/interfaces directory (#1793)Quill
* Proofread bonding.rst * Proofread bridge.rst * Edit remaining files in /interfaces * Fix line length lint errors * Apply suggestions from code review Co-authored-by: Daniil Baturin <daniil@baturin.org> --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>
2026-03-17Proofread files in the /vpp/configuration/nat directory (#1785)Quill
* Initial proofread * Fix indent in nat44.rst * Fix line length lint errors * Apply suggestion from @dmbaturin --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>
2026-03-17DOC: Proofread openvpn-examples.rst (#1779)LiudmylaNad
* DOC: Proofread openvpn-examples.rst * Apply suggestions from code review Co-authored-by: Daniil Baturin <daniil@baturin.org> --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>
2026-03-17DOC: Proofread vxlan.rst (#1797)LiudmylaNad
2026-03-17DOC: Proofread sstp-client.rst (#1798)LiudmylaNad
2026-03-17DOC: Proofread pppoe.rst (#1790)LiudmylaNad
Remove superfluous information not related to PPPoE interface configuration in VyOS Co-authored-by: Daniil Baturin <daniil@baturin.org>
2026-03-16DOC: Proofread wireguard.rst (#1784)LiudmylaNad
* DOC: Proofread wireguard.rst * Apply suggestions from code review Co-authored-by: Daniil Baturin <daniil@baturin.org> --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>
2026-03-16DOC: Proofread pseudo-ethernet.rst (#1791)LiudmylaNad
* DOC: Proofread pseudo-ethernet.rst --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>
2026-03-16DOC: Add information about execute permissions. (#1796)LiudmylaNad
2026-03-16Merge branch 'current' into syslog-clichksrividya0208
2026-03-12fix ISIS config commands examplesAlex Kudentsov
2026-03-11Correction of syslog and isis cli commands as per the latest versionsrividya0208
2026-03-09Merge pull request #1789 from natali-rs1985/T8354Viacheslav Hletenko
vpp: T8354: Move 'ignore-kernel-routes' option out of resource-allocation section
2026-03-06vpp: T8354: Move 'ignore-kernel-routes' option out of resource-allocation ↵Nataliia Solomko
section
2026-03-06Fix typoSting Alleman
2026-03-05vpp: Move interfaces from vpp section to 'interfaces vpp'Nataliia Solomko
2026-03-05doc: proofread docs in /vpp/configuration/dataplane directory (#1777)Quill
* Initial proofread * buffers.rst * cpu.rst * index.rst * interface.rst * proofread ipsec.rst * Proofread ipv6, l2learn, lcp * Proofread remaining files in /dataplane * Fix line length lint errors
2026-03-05T7513: DOC: VPP CGNAT Exclude Rule (#1786)RC
* T7513: DOC: VPP CGNAT Exclude Rule * T7513: Doc CGNAT Exclude rule - fix linter errors
2026-03-05T8136: IPSEC PPK Support (#1733)Giga Murphy
* T8136: IPSEC PPK Support * Fix styling and capitalization issues. --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>
2026-03-04Merge pull request #1780 from natali-rs1985/T8283Nataliia S.
vpp: T8283: Move bonding interface from vpp section to 'interfaces vpp bonding'
2026-03-02Merge pull request #1782 from alexk37/fix-inbound-interface-syntaxViacheslav Hletenko
firewall: fix inbound-interface name syntax
2026-03-02Proofread files in /vpp directory (#1770)Quill
* Proofread description.rst and requirements.rst * Fixes indentation in aws.rst * Update need_improvement.txt * Edit limitations.rst * Prooofread vpp/troubleshooting.rst * Fix line length lint errors * Fix additional line length errors * Fix final line length errors
2026-03-02DOC: Proofread openvpn.rst (#1778)LiudmylaNad
* DOC: Proofread openvpn.rst * Update openvpn.rst
2026-03-01Typo in vpn openconnect page (#1783)Leonardo Rizzi
2026-02-27firewall: fix inbound-interface name syntaxAlex Kudentsov
2026-02-26Fix blackbox-exporter examplesRoman Stein
Update prometheus blackbox-exporter examples to use the correct values for preferred-ip-protocol
2026-02-25vpp: T8283: Move bonding interface from vpp section to 'interfaces vpp bonding'Nataliia Solomko
2026-02-23Add note about using proxmox image for KVM (#1774)Quill
2026-02-23vpp: T8261: Refactor resource settings into 'resource-allocation' section ↵Nataliia S.
(#1775)
2026-02-19vpp: T8274: Remove dpdk-options section for num-* parameters (#1776)Alexandr K.
2026-02-18vpp: T8268: Unify CPU settings into a single 'cpu-cores' node under ↵Nataliia S.
'resource-allocation' (#1773)
2026-02-18vpp: T8266: Add global `interfaces-rx-mode` setting and remove per-interface ↵Alexandr K.
commands (#1772)
2026-02-17T8081: Update password recovery flow documentation (#1756)Quill
2026-02-17vpp: T8262: Refactor IPsec settings to use only 'ipsec-acceleration' flag ↵Nataliia S.
(#1768)
2026-02-16Proofread docs in /installation/virtual directory (#1752)Quill
* docker.rst * eve-ng.rst * gns3.rst * libvirt.rst * proxmox.rst * vmware.rst
2026-02-16DOC: Proofreading ethernet.rst (#1740)LiudmylaNad
* DOC: Proofreading ethernet.rst * doc: indentation configuration * Apply suggestions from code review Co-authored-by: Daniil Baturin <daniil@baturin.org> * Remove mentions of Metro Ethernet --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>
2026-02-16DOC: Proofreading copyright.md (#1744)LiudmylaNad
2026-02-16DOC: Proofread tunnel.rst (#1753)LiudmylaNad
* DOC: Proofread tunnel.rst * Apply suggestions from code review Co-authored-by: Daniil Baturin <daniil@baturin.org> * Review comments addressed --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>
2026-02-16DOC: Proofread geneve.rst (#1754)LiudmylaNad
* DOC: Proofread geneve.rst * Update docs/configuration/interfaces/geneve.rst Co-authored-by: Daniil Baturin <daniil@baturin.org> * Apply suggestions from code review Co-authored-by: Daniil Baturin <daniil@baturin.org> * Update geneve.rst Corrected Geneve capitalization. * Apply suggestions from code review Review comments have been addressed. Co-authored-by: Daniil Baturin <daniil@baturin.org> * Update geneve.rst Line length corrections.  --------- Co-authored-by: Daniil Baturin <daniil@baturin.org>