summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-12 07:07:03 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-12 07:08:40 +0100
commit42aafcc7539ec5db587ba8e94b8d08fe5aded76c (patch)
tree5d6c6698535dc90267782aed14daa57bab021b53
parent59334377e9b51b227c036cb46f3ec3da33e7f3c5 (diff)
downloadvyos-documentation-42aafcc7539ec5db587ba8e94b8d08fe5aded76c.tar.gz
vyos-documentation-42aafcc7539ec5db587ba8e94b8d08fe5aded76c.zip
index: add hint about changing CLI syntax
-rw-r--r--docs/index.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 56532143..5f18c011 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -23,6 +23,12 @@ The manual version is selected/specified by it's Git branch name. You can
switch between versions of the documentation by selecting the appropriate
branch on the bottom left corner.
+VyOS CLI syntax may change between major (and sometimes minor) versions. Please
+always refer to the documentation matching your current, running installation.
+If a change in the CLI is required, VyOS will ship a so called migration script
+which will take care of adjusting the synatax. No action needs to be taken by
+you.
+
.. _introduction:
.. toctree::
:caption: Introduction