From 82a06e1dc812ceba239aaabf4acd651a038bfee7 Mon Sep 17 00:00:00 2001
From: Yuriy Andamasov <yuriy@vyos.io>
Date: Wed, 13 May 2026 23:18:29 +0300
Subject: fix(includes): rewrite need_improvement.txt as MyST so plain
 `{include}` renders correctly
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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)
---
 docs/_include/need_improvement.txt           | 22 ++++------------------
 docs/configuration/highavailability/index.md |  3 +--
 2 files changed, 5 insertions(+), 20 deletions(-)

(limited to 'docs')

diff --git a/docs/_include/need_improvement.txt b/docs/_include/need_improvement.txt
index e368ee95..c95260ee 100644
--- a/docs/_include/need_improvement.txt
+++ b/docs/_include/need_improvement.txt
@@ -1,21 +1,7 @@
-.. raw:: latex
-
-    \iffalse
-
-.. raw:: html
-
-   <div class="admonition error">
-   <p class="admonition-title">Call for Contributions</p>
-
+:::{admonition} Call for Contributions
+:class: error
 
 Help improve this section with additional content, examples, and explanations.
 
-For contribution guidelines, see :ref:`documentation`.
-
-.. raw:: html
-
-   </div>
-
-.. raw:: latex
-
-    \fi
\ No newline at end of file
+For contribution guidelines, see {ref}`documentation`.
+:::
diff --git a/docs/configuration/highavailability/index.md b/docs/configuration/highavailability/index.md
index e26f5791..dbd36f03 100644
--- a/docs/configuration/highavailability/index.md
+++ b/docs/configuration/highavailability/index.md
@@ -414,8 +414,7 @@ To know more about scripting, check the {ref}`command-scripting` section.
 
 ## Virtual-server
 
-```{eval-rst}
-.. include:: /_include/need_improvement.txt
+```{include} /_include/need_improvement.txt
 ```
 
 Virtual Server allows to Load-balance traffic destination virtual-address:port
-- 
cgit v1.2.3


From 86de2de975cf4958c84d73cdd669be525e4680ea Mon Sep 17 00:00:00 2001
From: Yuriy Andamasov <yuriy@vyos.io>
Date: Thu, 14 May 2026 00:57:01 +0300
Subject: fix(includes): wrap admonition in `{only} not latex` to preserve PDF
 suppression
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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)
---
 docs/_include/need_improvement.txt | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'docs')

diff --git a/docs/_include/need_improvement.txt b/docs/_include/need_improvement.txt
index c95260ee..23f33f66 100644
--- a/docs/_include/need_improvement.txt
+++ b/docs/_include/need_improvement.txt
@@ -1,3 +1,4 @@
+::::{only} not latex
 :::{admonition} Call for Contributions
 :class: error
 
@@ -5,3 +6,4 @@ Help improve this section with additional content, examples, and explanations.
 
 For contribution guidelines, see {ref}`documentation`.
 :::
+::::
-- 
cgit v1.2.3