Add TODO markers, fill placeholders, mark stub pages by andamasov · Pull Request #1802 · vyos/vyos-documentation

andamasov · 2026-03-20T23:57:08Z

Summary

Add TODO comments to 12 files that use raw command blocks instead of cfgcmd/opcmd directives
Fill TBD placeholder in flow-accounting.rst with syslog-facility description
Remove orphan TBD in static.rst (content already follows the heading)
Add stub admonitions to 3 minimal pages (eve-ng, oracle, sysctl)

Test plan

Verify Sphinx build succeeds
Verify TODO directives render as expected
Verify stub notes render correctly

Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…utes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

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>

…itive - 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>

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>

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Copilot

Pull request overview

This PR updates the VyOS documentation to better track command-coverage work (via TODO markers), remove/replace lingering placeholders, and clearly label a few minimal pages as stubs pending expansion.

Changes:

Add .. TODO:: directives to multiple pages that still use raw command blocks (vs cfgcmd/opcmd) to improve coverage tracking visibility.
Replace/remove TBD placeholders (e.g., flow-accounting syslog facility description; remove orphan TBD in static routing docs).
Add “stub” .. note:: admonitions to minimal installation/system pages and perform various line-length/formatting cleanups.

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
docs/installation/virtual/eve-ng.rst	Add stub note for an underdeveloped page.
docs/installation/cloud/oracle.rst	Add stub note for an underdeveloped page.
docs/configuration/vpn/rsa-keys.rst	Add TODO marker; reflow a numbered list for readability/line length.
docs/configuration/vpn/openconnect.rst	Add TODO marker; add vyoslinter stop/start around a long paragraph; reflow nearby text.
docs/configuration/vpn/ipsec/troubleshooting_ipsec.rst	Add TODO marker; reflow a long sentence for line length.
docs/configuration/system/sysctl.rst	Add stub note for an underdeveloped page.
docs/configuration/system/flow-accounting.rst	Replace `TBD` with a concrete `syslog-facility` description.
docs/configuration/service/snmp.rst	Add TODO marker for command-block conversion tracking.
docs/configuration/protocols/static.rst	Reformat `cfgcmd` blocks/descriptions; remove orphan `TBD` under alternate routing tables.
docs/configuration/policy/examples.rst	Add TODO marker for command-block conversion tracking.
docs/configuration/nat/nat66.rst	Add TODO marker; reflow explanatory text for line length.
docs/configuration/nat/nat64.rst	Add TODO marker; add vyoslinter stop/start around a test snippet.
docs/configuration/interfaces/vti.rst	Add TODO marker for command-block conversion tracking.
docs/configuration/interfaces/openvpn-examples.rst	Add TODO marker; reflow prose; add vyoslinter stop/start for long outputs; adjust sample values; reflow a `:doc:` reference.
docs/configuration/firewall/index.rst	Add TODO marker for command-block conversion tracking.
docs/configexamples/site-2-site-cisco.rst	Replace non-reserved/public-looking IPs with documentation-friendly reserved examples.
docs/configexamples/nmp.rst	Reflow text; normalize CLI snippet indentation; update example name-server IP.
docs/configexamples/fwall-and-bridge.rst	Add vyoslinter stop/start around long log output; normalize whitespace.
docs/configexamples/ansible.rst	Reflow text; normalize code-block indentation; update example name-server IP.
docs/automation/terraform/terraformvSphere.rst	Reflow prose; tidy tree formatting; update example name-server IP; add vyoslinter stop/start around a long URL.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…ndentation - 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>

…itive Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

c-po · 2026-04-02T14:08:03Z

@Mergifyio backport circinus

mergify · 2026-04-02T14:08:08Z

backport circinus

✅ Backports have been created

Details

#1814 Add TODO markers, fill placeholders, mark stub pages (backport #1802) has been created for branch circinus

* 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> (cherry picked from commit a01c2c4)

* chore: add TODO markers for 12 files needing cfgcmd/opcmd conversion * fix: fill TBD placeholder in flow-accounting, remove TBD in static routes * docs: add stub admonitions to 3 minimal pages * 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). * 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 * 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. * fix: wrap 2 remaining long lines for linter compliance * 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 * fix: resolve remaining linter failures — long lines and OID false positive * fix: revert 8.8.8.8 replacements, use stop_vyoslinter instead --------- (cherry picked from commit a01c2c4) Co-authored-by: Yuriy Andamasov <yuriy@vyos.io> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

github-actions bot assigned andamasov Mar 20, 2026

github-actions bot added the conflicts label Mar 21, 2026

andamasov and others added 5 commits March 21, 2026 02:39

chore: add TODO markers for 12 files needing cfgcmd/opcmd conversion

f183093

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

fix: fill TBD placeholder in flow-accounting, remove TBD in static ro…

dd55f8e

…utes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

docs: add stub admonitions to 3 minimal pages

422491e

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

andamasov force-pushed the fix/docs-content-quality branch from f09e644 to c854aef Compare March 21, 2026 00:40

github-actions bot removed the conflicts label Mar 21, 2026

andamasov and others added 3 commits March 21, 2026 02:52

fix: wrap 2 remaining long lines for linter compliance

11b6b41

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

fix: suppress linter for long URL reference in terraformvSphere.rst

3266125

andamasov requested review from Copilot and dmbaturin March 21, 2026 16:53

Copilot started reviewing on behalf of andamasov March 21, 2026 16:53 View session

Copilot AI reviewed Mar 21, 2026

View reviewed changes

andamasov and others added 3 commits March 21, 2026 19:12

fix: resolve remaining linter failures — long lines and OID false pos…

20e6758

…itive Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

fix: revert 8.8.8.8 replacements, use stop_vyoslinter instead

0b36fda

dmbaturin merged commit a01c2c4 into current Mar 30, 2026
6 checks passed

dmbaturin deleted the fix/docs-content-quality branch March 30, 2026 11:11

mergify bot mentioned this pull request Apr 2, 2026

Add TODO markers, fill placeholders, mark stub pages (backport #1802) #1814

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add TODO markers, fill placeholders, mark stub pages#1802

Add TODO markers, fill placeholders, mark stub pages#1802
dmbaturin merged 11 commits intocurrentfrom
fix/docs-content-quality

andamasov commented Mar 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

c-po commented Apr 2, 2026

Uh oh!

mergify bot commented Apr 2, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

Conversation

andamasov commented Mar 20, 2026

Summary

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

c-po commented Apr 2, 2026

Uh oh!

mergify bot commented Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Backports have been created

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

mergify bot commented Apr 2, 2026 •

edited

Loading