diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-13 23:18:29 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-13 23:18:29 +0300 |
| commit | 82a06e1dc812ceba239aaabf4acd651a038bfee7 (patch) | |
| tree | 182f3cfd0797b8d2ded1f961d481e8c001e17d41 /docs | |
| parent | bfc681807ab2eafe3bfcea55be148deaba29f298 (diff) | |
| download | vyos-documentation-82a06e1dc812ceba239aaabf4acd651a038bfee7.tar.gz vyos-documentation-82a06e1dc812ceba239aaabf4acd651a038bfee7.zip | |
fix(includes): rewrite need_improvement.txt as MyST so plain `{include}` renders correctly
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)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_include/need_improvement.txt | 22 | ||||
| -rw-r--r-- | docs/configuration/highavailability/index.md | 3 |
2 files changed, 5 insertions, 20 deletions
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 |