Skip to content

Commit b9560fe

Browse files
Proofreading about.rst and history.rst (#1709)
* Proofreading About and History * Apply suggestions from code review Co-authored-by: Daniil Baturin <[email protected]> * Addressed comments on the About and History sections. --------- Co-authored-by: Daniil Baturin <[email protected]>
1 parent bc7512c commit b9560fe

File tree

2 files changed

+83
-98
lines changed

2 files changed

+83
-98
lines changed

docs/introducing/about.rst

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,20 @@
44
About
55
#####
66

7-
VyOS is an open source network operating system based on Debian GNU/Linux.
7+
VyOS is an open-source network operating system that provides a single unified
8+
CLI and API to manage routing protocols, firewall and NAT, QoS, load balancing,
9+
DHCP and DNS servers, and many other features.
810

9-
VyOS provides a free routing platform that competes directly with other
10-
commercially available solutions from well known network providers. Because
11-
VyOS runs on standard amd64, i586 and ARM systems, it is able to be used
12-
as a router and firewall platform for cloud deployments.
11+
VyOS runs on a wide variety of commodity hardware, virtual machines, and
12+
multiple cloud environments.
1313

14-
We use multiple live versions of our manual, hosted thankfully by
15-
https://readthedocs.org. We will provide one version of the manual for every
16-
VyOS major version starting with VyOS 1.2 which will receive Long-term support
17-
(LTS).
14+
We provide a dedicated user guide for each major
15+
VyOS release that receives long-term support (LTS). We maintain multiple user
16+
guide versions, all hosted at https://docs.vyos.io.
17+
To switch between versions, select the appropriate version in the bottom-right
18+
corner.
1819

19-
The manual version is selected/specified by it's Git branch name. You can
20-
switch between versions of the documentation by selecting the appropriate
21-
branch on the bottom left corner.
22-
23-
VyOS CLI syntax may change between major (and sometimes minor) versions. Please
24-
always refer to the documentation matching your current, running installation.
25-
If a change in the CLI is required, VyOS will ship a so called migration script
26-
which will take care of adjusting the syntax. No action needs to be taken by
27-
you.
20+
VyOS CLI syntax may vary between major and sometimes minor releases. Always
21+
refer to the documentation matching your current running installation. If
22+
a change in the CLI is required, VyOS provides a migration script to handle
23+
the syntax adjustments. No user action is required.

docs/introducing/history.rst

Lines changed: 69 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -7,127 +7,116 @@ History
77
In the beginning...
88
===================
99

10-
There once was a network operating system based on Debian GNU/Linux,
11-
called Vyatta. [*]_ 2006 onwards, it was a great free software
12-
alternative to Cisco IOS and Jupiter JUNOS. It came in two editions:
13-
Vyatta Core (previously Vyatta Community Edition) that was completely
14-
free software, and Vyatta Subscription Edition that had proprietary
15-
features and was only available to paying customers.
16-
17-
Vyatta was acquired by Brocade Communication Systems in 2012. Shortly
18-
after, Brocade renamed Vyatta Subscription Edition to Brocade vRouter,
19-
discontinued Vyatta Core and shut down the community forum without a
20-
notice. The bug tracker and Git repositories followed next year.
21-
22-
It's worth noting that by the time Brocade acquired Vyatta,
23-
development of Vyatta Core was already stagnated. Vyatta Subscription
24-
Edition (and thus, Vyatta development as a whole) had been replacing
25-
core components with proprietary software, meaning few features made
26-
it to Vyatta Core, and those that did were bug-ridden and hamstrung.
27-
28-
In 2013, soon after Vyatta Core was abandoned, the community forked
29-
the last Vyatta Core version (6.6R1) and VyOS Project came into being.
30-
`Sentrium SL <https://blog.vyos.io/sentrium-what-sentrium>`_ was
31-
established by VyOS maintainers in 2014 to fund VyOS development by
32-
selling support, consulting services and prebuilt long-term support
33-
images. The company was later reorganized under the VyOS brand.
34-
35-
Brocade was acquired by Broadcom in 2016 and sold what remains of
36-
erstwhile Vyatta to AT&T in 2017, who in turn sold it to Ciena in 2021.
10+
There was a network operating system based on Debian GNU/Linux, called
11+
Vyatta. [*]_ Introduced in 2006, it served as a great free-software alternative
12+
to proprietary products. Vyatta came in two editions: Vyatta Core
13+
(formerly known as Vyatta Community Edition), which was free software, and
14+
Vyatta Subscription Edition, which included proprietary features and was
15+
available only to paying customers.
16+
17+
Brocade Communications Systems acquired Vyatta in 2012. Shortly after, Brocade
18+
renamed Vyatta Subscription Edition to Brocade vRouter, discontinued Vyatta
19+
Core, and shut down the community forum without notice. The bug tracker and Git
20+
repositories were closed the following year.
21+
22+
By the time Brocade acquired Vyatta, the development of Vyatta Core had
23+
already stagnated. The focus had shifted to Vyatta Subscription Edition,
24+
where core components were replaced with proprietary software. As a result,
25+
Vyatta Core received fewer new features, and some of those added faced issues.
26+
27+
In 2013, shortly after Vyatta Core was discontinued, the community forked its
28+
final version (6.6R1) to create the VyOS project. In 2014, the maintainers
29+
established a company to fund VyOS development through technical support,
30+
consulting services, and LTS release access subscriptions. The company was
31+
originally named Sentrium and was later reorganized under the VyOS brand.
3732

3833

3934
Major releases
4035
==============
41-
42-
VyOS major versions used to be named after elements in order of atomic
43-
numbers. With 1.2, this naming scheme was replaced with the much
44-
cooler scheme of Latin names of `IAU
45-
<https://en.wikipedia.org/wiki/IAU_designated_constellations_by_area>`_
46-
designated constellations by solid angle area, starting from the smallest.
36+
VyOS originally named its major versions after elements by atomic number.
37+
Beginning with version 1.2, this naming scheme was changed. It now uses the
38+
Latin names of constellations recognized by the International Astronomical
39+
Union (`IAU
40+
<https://en.wikipedia.org/wiki/IAU_designated_constellations_by_area>`_),
41+
ordered by their solid angle area, beginning with the smallest.
4742

4843
Hydrogen (1.0)
4944
--------------
5045

51-
Released just in time for holidays on 22 December 2013, Hydrogen was
46+
Released just in time for the holidays on 22 December 2013, Hydrogen was
5247
the first major VyOS release. It fixed features that were broken in
53-
Vyatta Core 6.6 (such as IPv4 BGP peer groups and DHCPv6 relay) and
54-
introduced command scripting, a task scheduler and web proxy LDAP
48+
Vyatta Core 6.6, such as IPv4 BGP peer groups and DHCPv6 relay, and
49+
introduced command scripting, a task scheduler, and web proxy LDAP
5550
authentication.
5651

5752
Helium (1.1)
5853
------------
54+
Helium, released on 9 October 2014, marked the first anniversary of the
55+
VyOS Project. The release introduced an event handler, L2TPv3 support,
56+
802.1ad (QinQ), and IGMP proxy, as well as experimental support for VXLAN
57+
and DMVPN. Notably, DMVPN remained non-functional in Vyatta Core due to its
58+
reliance on a proprietary NHRP implementation.
5959

60-
Helium was released on 9 October 2014, exactly on the day VyOS Project
61-
first came into being in the previous year. Helium came with a lot of
62-
new features, including an event handler and support for L2TPv3,
63-
802.1ad QinQ and IGMP proxy, as well as experimental support for VXLAN
64-
and DMVPN (the latter of which was also broken in Vyatta Core due to
65-
its reliance on a proprietary NHRP implementation).
6660

6761
Crux (1.2)
6862
----------
63+
Crux (the Southern Cross) was released on 28 January 2019 and marked a
64+
departure from legacy Vyatta codebase and the start of the migration from
65+
Perl to Python as the primary language. The underlying base system was
66+
upgraded from Debian 6 (Squeeze) to Debian 8 (Jessie).
6967

70-
Crux (the Southern Cross) came out on 28 January 2019 and was the
71-
first major release of VyOS as we know it today. The underlying
72-
Debian base was upgraded from Squeeze (6) to Jessie (8).
73-
74-
Although Crux came with too many new features to mention here, some
75-
noteworthy ones are: an mDNS repeater, a broadcast relay,
76-
a high-performance PPPoE server, an HFSC scheduler, as well as support
77-
for Wireguard, unicast VRRP, RPKI for BGP and fully 802.1ad-compliant
78-
QinQ ethertype. The telnet server and support for P2P filtering were
79-
removed.
68+
Crux introduced many new features, some of the most noteworthy are:
69+
an mDNS repeater, a broadcast relay, a high-performance PPPoE server,
70+
an HFSC scheduler, and support for Wireguard, unicast VRRP, RPKI for BGP,
71+
and fully 802.1ad-compliant QinQ ethertype. The telnet server and support
72+
for P2P filtering were removed.
8073

81-
Crux is the first version to feature the modular image build system.
82-
CLI definitions began to be written in the modern, verifiable XML
83-
templates. Python APIs were introduced for command scripting and
84-
configuration migration. Introduction of new Perl and shell code was
85-
proscribed and the rewriting of legacy Perl code in pure Python began
86-
with Crux.
74+
Crux was the first VyOS release to feature a modular image build system.
75+
CLI definitions were written using an XML syntax automatically checked
76+
against a schema at build time. Python APIs were introduced for command
77+
scripting and configuration migration. New Perl code and old-style (non-XML)
78+
command definition were no longer accepted from that point.
8779

88-
Crux reached end of support in 2023..
80+
Crux reached the end of support in 2023.
8981

9082
Equuleus (1.3)
9183
--------------
9284

93-
The current long-term support version of VyOS, Equuleus (the Pony)
94-
came out on 21 December 2021, once again in time for the winter
95-
holidays.
85+
Equuleus (the Little Horse) was a long-term support version released
86+
on 21 December 2021, just in time for the winter holidays.
9687

97-
Equuleus brought many long-desired features with it, most notably
98-
an SSTP VPN server, an IPoE server, an OpenConnect VPN server and
99-
a serial console server, in addition to reworked support for WWAN
100-
interfaces, support for GENEVE and MACSec interfaces, VRF, IS-IS
101-
routing, preliminary support for MPLS and LDP, and many other
102-
initialisms.
88+
Equuleus brought many long-awaited features, most notably an SSTP VPN
89+
server, an IPoE server, an OpenConnect VPN server, and a serial console
90+
server. It also introduced reworked support for WWAN interfaces, support
91+
for GENEVE and MACSec interfaces, VRF, IS-IS routing, and preliminary support
92+
for MPLS and LDP.
10393

104-
Equuleus reached end of support in 2025.
94+
Equuleus reached the end of support in 2025.
10595

10696
Sagitta (1.4)
10797
-------------
10898

109-
Sagitta (the Arrow) was released in 2024 and is currently a supported LTS release.
99+
Sagitta (the Arrow), released in 2024, is currently a supported LTS release.
110100

111101
Circinus (1.5)
112102
--------------
113103

114-
Circinus (the Compass) is the codename of the upcoming development
115-
branch, so there's no VyOS 1.5 yet.
104+
Circinus (the Drawing Compass) is the codename for the upcoming development
105+
branch. VyOS 1.5 Circinus has not been released yet.
116106

117107
A note on copyright
118108
===================
119109

120-
Unlike Vyatta, VyOS never had (nor will ever have) proprietary code.
110+
Unlike Vyatta, VyOS has never had closed-source code and never will.
121111
The only proprietary material in VyOS is non-code assets, such as
122-
graphics and the trademark "VyOS". [*]_ This means you can build your
123-
own long-term support images (as the entire toolchain we use is free
124-
software) and even distribute them, given you rename it and remove
125-
such assets before building. Although note that we do not provide
126-
support for images distributed by a third-party. See the
112+
graphics and the trademark "VyOS". [*]_
113+
114+
Note that we do not provide support for images distributed by a third party.
115+
See the
127116
`artwork license <https://github.com/vyos/vyos-build/blob/current/LICENSE.artwork>`_
128117
and the end-user license agreement at ``/usr/share/vyos/EULA`` in
129-
any pre-built image for more precise information.
118+
any pre-built image for more information.
130119

131120

132121
.. [*] From the Sanskrit adjective "Vyātta" (व्यात्त), meaning opened.
133-
.. [*] This is not unlike how Linus Torvalds owns the trademark "Linux".
122+
.. [*] This is similar to how Linus Torvalds owns the Linux trademark.

0 commit comments

Comments
 (0)