vyos-documentation.git/docs/_include, branch 1.5

fix(includes): wrap admonition in `{only} not latex` to preserve PDF suppression

2026-05-13T22:05:52+00:00

The original RST `_include/need_improvement.txt` wrapped the admonition in `.. raw:: latex \iffalse / \fi`, intentionally hiding the "Call for Contributions" notice from the LaTeX/PDF builder (see b222a313, 2020). `.readthedocs.yml` enables `formats: - pdf` and `conf.py` configures `latex_elements`/`latex_documents`, so PDF output is a real downstream artifact. The previous commit (82a06e1d) dropped that suppression. Restore it using Sphinx's `only` directive with `not latex`, which is the MyST equivalent of the original RST builder-conditional pattern. Spotted by Copilot inline review on #2016. 🤖 Generated by [robots](https://vyos.io) (cherry picked from commit 86de2de975cf4958c84d73cdd669be525e4680ea)

fix(includes): rewrite need_improvement.txt as MyST so plain `{include}` renders correctly

2026-05-13T22:05:52+00:00

After the RST→MyST migration, ~45 MD pages use the plain `{include}` MyST directive to pull in `_include/need_improvement.txt`. The included file still contained RST (`.. raw:: html`, `.. raw:: latex`, `:ref:`), and MyST's built-in `{include}` parses the content with the *outer* file's parser — i.e. as MyST. RST directives then render as literal paragraphs. Visible symptom on docs.vyos.io/en/rolling (and across 1.5/1.4): the VPP index, VPP subpages, haproxy, isis, bfd, policy, pki, salt, flowtables, webproxy, and others all show: .. raw:: latex \iffalse .. raw:: html Call for Contributions Help improve this section ... For contribution guidelines, see :ref: documentation . Fix: rewrite `_include/need_improvement.txt` as a native MyST admonition (`:::{admonition} Call for Contributions / :class: error / ... / :::`) and drop the now-unnecessary `{eval-rst}` wrapper at the single callsite (`configuration/highavailability/index.md`) that wrapped the include for RST processing. The fix is companion to 9c815d68 (cmdincludemd RST plumbing) but targets the plain-`{include}` path which doesn't route through our custom extension. 🤖 Generated by [robots](https://vyos.io) (cherry picked from commit 82a06e1dc812ceba239aaabf4acd651a038bfee7)

DOC: Proofread wireguard.rst (#1784)

2026-03-16T14:13:10+00:00

* DOC: Proofread wireguard.rst * Apply suggestions from code review Co-authored-by: Daniil Baturin --------- Co-authored-by: Daniil Baturin

Proofread files in /vpp directory (#1770)

2026-03-02T09:42:37+00:00

* 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

DOC: Proofreading ethernet.rst (#1740)

2026-02-16T12:13:04+00:00

* DOC: Proofreading ethernet.rst * doc: indentation configuration * Apply suggestions from code review Co-authored-by: Daniil Baturin * Remove mentions of Metro Ethernet --------- Co-authored-by: Daniil Baturin

DOC: Proofreading virtual, loopback, and dummy interfaces (#1745)

2026-01-27T09:52:27+00:00

DOC: Proofreading bonding.rst (#1721)

2025-12-23T13:37:59+00:00

interface: correct documentation for dhcpv6-options no-release (#1520)

2024-08-10T20:12:41+00:00

trivial spelling changes to include/interface-{ip,mirror}.txt

2024-07-04T12:23:46+00:00

change interface-mac.txt to match contributor guidelines on mac addresses

2024-07-04T12:16:35+00:00