summaryrefslogtreecommitdiff
path: root/docs/introducing/about.rst
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2020-11-29 19:08:35 +0100
committerrebortg <github@ghlr.de>2020-11-29 19:08:35 +0100
commit371bf8185f3cd0628969a8603aa92503b2fc3853 (patch)
tree91113bcd6a31fd635af54bf39b079f2cb1d3053b /docs/introducing/about.rst
parentadf00431bcc81e270687882e672d59dd2c65515a (diff)
downloadvyos-documentation-371bf8185f3cd0628969a8603aa92503b2fc3853.tar.gz
vyos-documentation-371bf8185f3cd0628969a8603aa92503b2fc3853.zip
rearange changelog, cli, contributing
Diffstat (limited to 'docs/introducing/about.rst')
-rw-r--r--docs/introducing/about.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/introducing/about.rst b/docs/introducing/about.rst
new file mode 100644
index 00000000..0411344b
--- /dev/null
+++ b/docs/introducing/about.rst
@@ -0,0 +1,27 @@
+.. _about:
+
+#####
+About
+#####
+
+VyOS is an open source network operating system based on Debian GNU/Linux.
+
+VyOS provides a free routing platform that competes directly with other
+commercially available solutions from well known network providers. Because
+VyOS is run on standard amd64, i586 and ARM systems, it is able to be used
+as a router and firewall platform for cloud deployments.
+
+We use multiple live versions of our manual hosted thankfully by
+https://readthedocs.org. We will provide one version of the manual for every
+VyOS major version starting with VyOS 1.2 which will receive Long-term support
+(LTS).
+
+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 syntax. No action needs to be taken by
+you.