diff options
author | currite <sll@disroot.org> | 2020-11-06 16:51:13 +0100 |
---|---|---|
committer | currite <sll@disroot.org> | 2020-11-06 16:51:13 +0100 |
commit | 095239eace352ab194c23be1423b61da8351d33f (patch) | |
tree | 5b0cea8301283e522105bab77fa54cf5dbb24321 /docs/about.rst | |
parent | ea0a0d7e92f0b82e531f09e788d8d1cda34f6241 (diff) | |
download | vyos-documentation-095239eace352ab194c23be1423b61da8351d33f.tar.gz vyos-documentation-095239eace352ab194c23be1423b61da8351d33f.zip |
index: establish highlighted blocks without affecting links
Add toctree captions and names to separate blocks
(similar to 1.3 index) without affecting existing links
Diffstat (limited to 'docs/about.rst')
-rw-r--r-- | docs/about.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/about.rst b/docs/about.rst new file mode 100644 index 00000000..383c95eb --- /dev/null +++ b/docs/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 can 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 its 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. |