summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2021-02-11 20:38:34 +0100
committerGitHub <noreply@github.com>2021-02-11 20:38:34 +0100
commit262e886fde9ced4a1211bfa99e7d675f98dbf3b9 (patch)
tree9d8e205db531f2eb8183164cc66f848116a9600b
parente8c28a5bd7103aa9ebd402eaab644f99fc25f475 (diff)
parenta0154149dd448be158e356fa8ae8b6595e6bd35b (diff)
downloadvyos-documentation-262e886fde9ced4a1211bfa99e7d675f98dbf3b9.tar.gz
vyos-documentation-262e886fde9ced4a1211bfa99e7d675f98dbf3b9.zip
Merge pull request #449 from dantho281/fix/dantho-docs-cleanup
Fix/dantho docs cleanup
-rw-r--r--docs/_include/interface-ip.txt2
-rw-r--r--docs/_include/interface-xdp.txt6
-rw-r--r--docs/configuration/service/snmp.rst5
-rw-r--r--docs/configuration/service/ssh.rst7
-rw-r--r--docs/configuration/service/tftp-server.rst6
-rw-r--r--docs/configuration/system/option.rst6
6 files changed, 18 insertions, 14 deletions
diff --git a/docs/_include/interface-ip.txt b/docs/_include/interface-ip.txt
index 89937806..abbed529 100644
--- a/docs/_include/interface-ip.txt
+++ b/docs/_include/interface-ip.txt
@@ -126,7 +126,7 @@
possible to allow these hosts to communicate through the upstream router by
proxy_arp'ing.
- .. note:: Don't need to be used together with proxy_arp.
+ .. note:: Does not need to be used together with proxy_arp.
This technology is known by different names:
diff --git a/docs/_include/interface-xdp.txt b/docs/_include/interface-xdp.txt
index d87151fc..e28db88d 100644
--- a/docs/_include/interface-xdp.txt
+++ b/docs/_include/interface-xdp.txt
@@ -1,6 +1,6 @@
.. cfgcmd:: set interfaces {{ var0 }} <interface> xdp
- Enable support for Linux :abbr:`XDP (eXpress Data Path)` on recent 1.3 rolling
+ Enable support for Linux :abbr:`XDP (eXpress Data Path)` on recent 1.4 rolling
releases. You must enable it for every interface which should participate in
the XDP forwarding.
@@ -18,10 +18,12 @@
nftables.
Enabling this feature will only load the XDP router code as described here:
+ .. stop_vyoslinter
https://blog.apnic.net/2020/04/30/how-to-build-an-xdp-based-bgp-peering-router/
+ .. start_vyoslinter
Example:
.. code-block:: none
- set interfaces {{ var0 }} {{ var1 }} xdp \ No newline at end of file
+ set interfaces {{ var0 }} {{ var1 }} xdp
diff --git a/docs/configuration/service/snmp.rst b/docs/configuration/service/snmp.rst
index e962c1c5..4a5a2780 100644
--- a/docs/configuration/service/snmp.rst
+++ b/docs/configuration/service/snmp.rst
@@ -201,7 +201,8 @@ VyOS MIBs
All SNMP MIBs are located in each image of VyOS here: ``/usr/share/snmp/mibs/``
-you are be able to download the files with the a activate ssh service like this
+You are be able to download the files using SCP, once the SSH service
+has been activated like so
.. code-block:: none
@@ -270,4 +271,4 @@ following content:
.. _SNMPv2: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_2
.. _SNMPv3: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_3
-.. start_vyoslinter \ No newline at end of file
+.. start_vyoslinter
diff --git a/docs/configuration/service/ssh.rst b/docs/configuration/service/ssh.rst
index 94249766..6b09d40d 100644
--- a/docs/configuration/service/ssh.rst
+++ b/docs/configuration/service/ssh.rst
@@ -127,8 +127,8 @@ Operation
.. opcmd:: generate ssh client-key /path/to/private_key
- Re-generated a known pub/private keyfile which can e.g. used to connect to
- other services (RPKI cache).
+ Re-generated a known pub/private keyfile which can be used to connect to
+ other services (e.g. RPKI cache).
Example:
@@ -153,5 +153,6 @@ Operation
| =.. o=.oo|
+----[SHA256]-----+
- Two new files ``/config/auth/id_rsa_rpki`` and ``/config/auth/id_rsa_rpki.pub``
+ Two new files ``/config/auth/id_rsa_rpki`` and
+ ``/config/auth/id_rsa_rpki.pub``
will be created.
diff --git a/docs/configuration/service/tftp-server.rst b/docs/configuration/service/tftp-server.rst
index 276ce5fb..d220d789 100644
--- a/docs/configuration/service/tftp-server.rst
+++ b/docs/configuration/service/tftp-server.rst
@@ -32,15 +32,15 @@ on each IP address.
.. cfgcmd:: set service tftp-server allow-upload
-Optional, if you want to enable uploads, else TFTP server will act as read-only
-server.
+Optional, if you want to enable uploads, else TFTP server will act as a
+read-only server.
Example
-------
Provide TFTP server listening on both IPv4 and IPv6 addresses ``192.0.2.1`` and
``2001:db8::1`` serving the content from ``/config/tftpboot``. Uploading via
-TFTP to this server is not allowed!
+TFTP to this server is disabled.
The resulting configuration will look like:
diff --git a/docs/configuration/system/option.rst b/docs/configuration/system/option.rst
index e029ec96..a4e08245 100644
--- a/docs/configuration/system/option.rst
+++ b/docs/configuration/system/option.rst
@@ -28,8 +28,8 @@ HTTP client
.. cfgcmd:: set system option http-client source-address <address>
- Several commands utilize curl to initiate transfers. Configure the local
- source IPv4/IPv6 address used for all CURL operations.
+ Several commands utilize cURL to initiate transfers. Configure the local
+ source IPv4/IPv6 address used for all cURL operations.
.. cfgcmd:: set system option http-client source-interface <interface>
@@ -54,7 +54,7 @@ the used keyboard layout on the system console.
Defaults to ``us``.
.. note:: Changing the keymap only has an effect on the system console, using
- SSH oder Serial remote access to the device is not affected as the keyboard
+ SSH or Serial remote access to the device is not affected as the keyboard
layout here corresponds to your access system.
.. _system_options_performance: