diff options
| author | LiudmylaNad <l.nadolina@vyos.io> | 2025-12-09 15:19:01 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-12-09 14:19:01 +0000 |
| commit | b9560fe13513745fd324747460ff83d7fd1b5bdd (patch) | |
| tree | 76bdf36a76abba1e1860d66e5cbdd641f8af9a26 /docs/introducing/about.rst | |
| parent | bc7512c2c7ac247943c736adfb3e0f58a67acc1d (diff) | |
| download | vyos-documentation-b9560fe13513745fd324747460ff83d7fd1b5bdd.tar.gz vyos-documentation-b9560fe13513745fd324747460ff83d7fd1b5bdd.zip | |
Proofreading about.rst and history.rst (#1709)
* Proofreading About and History
* Apply suggestions from code review
Co-authored-by: Daniil Baturin <daniil@baturin.org>
* Addressed comments on the About and History sections.
---------
Co-authored-by: Daniil Baturin <daniil@baturin.org>
Diffstat (limited to 'docs/introducing/about.rst')
| -rw-r--r-- | docs/introducing/about.rst | 32 |
1 files changed, 14 insertions, 18 deletions
diff --git a/docs/introducing/about.rst b/docs/introducing/about.rst index 944ff0a1..a791dcd0 100644 --- a/docs/introducing/about.rst +++ b/docs/introducing/about.rst @@ -4,24 +4,20 @@ About ##### -VyOS is an open source network operating system based on Debian GNU/Linux. +VyOS is an open-source network operating system that provides a single unified +CLI and API to manage routing protocols, firewall and NAT, QoS, load balancing, +DHCP and DNS servers, and many other features. -VyOS provides a free routing platform that competes directly with other -commercially available solutions from well known network providers. Because -VyOS runs on standard amd64, i586 and ARM systems, it is able to be used -as a router and firewall platform for cloud deployments. +VyOS runs on a wide variety of commodity hardware, virtual machines, and +multiple cloud environments. -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). +We provide a dedicated user guide for each major +VyOS release that receives long-term support (LTS). We maintain multiple user +guide versions, all hosted at https://docs.vyos.io. +To switch between versions, select the appropriate version in the bottom-right +corner. -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. +VyOS CLI syntax may vary between major and sometimes minor releases. Always +refer to the documentation matching your current running installation. If +a change in the CLI is required, VyOS provides a migration script to handle +the syntax adjustments. No user action is required. |