vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rename chapters and remove redundant VyOS wording

Browse Source
This commit is contained in:
Christian Breunig 2024-10-08 21:55:27 +02:00
parent 1bbe5de12c
commit db5e2af0e3
6 changed files with 33 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/cli.rst
View File

@ -329,7 +329,7 @@ configured, changes are added through a collection of :cfgcmd:`set` and
Both these ``show`` commands should be executed when in operational Both these ``show`` commands should be executed when in operational
mode, they do not work directly in configuration mode. There is a mode, they do not work directly in configuration mode. There is a
special way on how to :ref:`run_opmode_from_config_mode`. special way on how to :ref:run_opmode_from_config_mode.
.. hint:: Use the ``show configuration commands | strip-private`` .. hint:: Use the ``show configuration commands | strip-private``
command when you want to hide private data. You may want to do so if command when you want to hide private data. You may want to do so if
@ -528,7 +528,7 @@ mode using :cfgcmd:`show | commands`
set address dhcp set address dhcp
set hw-id 00:53:ad:44:3b:03 set hw-id 00:53:ad:44:3b:03
These commands are also relative to the level you are inside and only These commands are also relative to the level you are inside and only
relevant configuration blocks will be displayed when entering a relevant configuration blocks will be displayed when entering a
sub-level. sub-level.
@ -620,7 +620,7 @@ different levels in the hierarchy.
Use this command to preserve configuration changes upon reboot. By Use this command to preserve configuration changes upon reboot. By
default it is stored at */config/config.boot*. In the case you want default it is stored at */config/config.boot*. In the case you want
to store the configuration file somewhere else, you can add a local to store the configuration file somewhere else, you can add a local
path, a SCP address, a FTP address or a TFTP address. path, a SCP address, a FTP address or a TFTP address.
.. code-block:: none .. code-block:: none
@ -675,13 +675,13 @@ different levels in the hierarchy.
system will reboot into previous config revision. system will reboot into previous config revision.
.. code-block:: none .. code-block:: none
vyos@router# set firewall interface eth0 local name FromWorld vyos@router# set firewall interface eth0 local name FromWorld
vyos@router# commit-confirm vyos@router# commit-confirm
commit confirm will be automatically reboot in 10 minutes unless confirmed commit confirm will be automatically reboot in 10 minutes unless confirmed
Proceed? [confirm]y Proceed? [confirm]y
[edit] [edit]
vyos@router# confirm vyos@router# confirm
[edit] [edit]
@ -703,8 +703,8 @@ different levels in the hierarchy.
.. code-block:: none .. code-block:: none
vyos@router# show firewall name FromWorld vyos@router# show firewall name FromWorld
default-action drop default-action drop
rule 10 { rule 10 {
action accept action accept
@ -713,7 +713,7 @@ different levels in the hierarchy.
} }
} }
[edit] [edit]
vyos@router# edit firewall name FromWorld vyos@router# edit firewall name FromWorld
[edit firewall name FromWorld] [edit firewall name FromWorld]
vyos@router# copy rule 10 to rule 20 vyos@router# copy rule 10 to rule 20
[edit firewall name FromWorld] [edit firewall name FromWorld]
@ -730,7 +730,7 @@ different levels in the hierarchy.
You can also rename config subtrees: You can also rename config subtrees:
.. code-block:: none .. code-block:: none
vyos@router# rename rule 10 to rule 5 vyos@router# rename rule 10 to rule 5
[edit firewall name FromWorld] [edit firewall name FromWorld]
vyos@router# commit vyos@router# commit
@ -741,8 +741,8 @@ different levels in the hierarchy.
with no parameters. with no parameters.
.. code-block:: none .. code-block:: none
vyos@router# show vyos@router# show
default-action drop default-action drop
rule 5 { rule 5 {
action accept action accept
@ -791,11 +791,6 @@ different levels in the hierarchy.
firewall` command would return starting after the ``firewall firewall` command would return starting after the ``firewall
{`` line, hiding the comment. {`` line, hiding the comment.
.. _run_opmode_from_config_mode: .. _run_opmode_from_config_mode:
Access opmode from config mode Access opmode from config mode
@ -1018,7 +1013,7 @@ to load it with the ``load`` command:
.. code-block:: none .. code-block:: none
vyos@vyos# load vyos@vyos# load
Possible completions: Possible completions:
<Enter> Load from system config file <Enter> Load from system config file
<file> Load from file on local machine <file> Load from file on local machine
@ -1028,7 +1023,7 @@ to load it with the ``load`` command:
http://<host>/<file> Load from file on remote machine http://<host>/<file> Load from file on remote machine
https://<host>/<file> Load from file on remote machine https://<host>/<file> Load from file on remote machine
tftp://<host>/<file> Load from file on remote machine tftp://<host>/<file> Load from file on remote machine
Restore Default Restore Default
@ -1051,4 +1046,3 @@ configuration too.
.. note:: If you are remotely connected, you will lose your connection. .. note:: If you are remotely connected, you will lose your connection.
You may want to copy first the config, edit it to ensure You may want to copy first the config, edit it to ensure
connectivity, and load the edited config. connectivity, and load the edited config.

21
docs/index.rst
View File

@ -5,22 +5,21 @@ VyOS User Guide
############### ###############
.. grid:: 3 .. grid:: 3
:gutter: 2 :gutter: 2
.. grid-item-card:: Get / Build VyOS .. grid-item-card:: Get / Build VyOS
Quickly :ref:`Build<contributing/build-vyos:build vyos>` your own Image or take a look at how to :ref:`download<installation/install:download>` a free or supported version. Quickly :ref:`Build<contributing/build-vyos:build vyos>` your own Image or take a look at how to :ref:`download<installation/install:download>` a free or supported version.
.. grid-item-card:: Install VyOS .. grid-item-card:: Install VyOS
Read about how to install VyOS on :ref:`Bare Metal<installation/install:installation>` or in a Read about how to install VyOS on :ref:`Bare Metal<installation/install:installation>` or in a
:ref:`Virtual Environment<installation/virtual/index:running vyos in virtual environments>` and :ref:`Virtual Environment<installation/virtual/index:Virtual Environments>` and
how to use an image with the usual :ref:`cloud<installation/cloud/index:running VyOS in Cloud Environments>` providers how to use an image with the usual :ref:`cloud<installation/cloud/index:Cloud Environments>` providers
.. grid-item-card:: Configuration and Operation .. grid-item-card:: Configuration and Operation
@ -28,20 +27,20 @@ VyOS User Guide
set up :ref:`advanced routing<configuration/protocols/index:protocols>`, set up :ref:`advanced routing<configuration/protocols/index:protocols>`,
:ref:`VRFs<configuration/vrf/index:vrf>`, or :ref:`VRFs<configuration/vrf/index:vrf>`, or
:ref:`VPNs<configuration/vpn/index:vpn>` for example. :ref:`VPNs<configuration/vpn/index:vpn>` for example.
.. grid-item-card:: Automate .. grid-item-card:: Automate
Integrate VyOS in your automation Workflow with Integrate VyOS in your automation Workflow with
:ref:`Ansible<vyos-ansible>`, :ref:`Ansible<vyos-ansible>`,
have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`. have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`.
.. grid-item-card:: Examples .. grid-item-card:: Examples
Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>` Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>`
to build your infrastructure. to build your infrastructure.
.. grid-item-card:: Contribute and Community .. grid-item-card:: Contribute and Community

2
docs/installation/vyos-on-baremetal.rst → docs/installation/bare-metal.rst
View File

@ -1,7 +1,7 @@
.. _vyosonbaremetal: .. _vyosonbaremetal:
##################### #####################
Running on Bare Metal Bare Metal Deployment
##################### #####################
Supermicro A2SDi (Atom C3000) Supermicro A2SDi (Atom C3000)

10
docs/installation/cloud/index.rst
View File

@ -1,8 +1,6 @@
################################## ##################
Running VyOS in Cloud Environments Cloud Environments
################################## ##################
.. toctree:: .. toctree::
:caption: Content :caption: Content
@ -10,4 +8,4 @@ Running VyOS in Cloud Environments
aws aws
azure azure
gcp gcp
oracel oracel

4
docs/installation/index.rst
View File

@ -2,8 +2,6 @@
Installation and Image Management Installation and Image Management
################################# #################################
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Content :caption: Content
@ -11,7 +9,7 @@ Installation and Image Management
install install
virtual/index virtual/index
cloud/index cloud/index
vyos-on-baremetal bare-metal
update update
image image
migrate-from-vyatta migrate-from-vyatta

6
docs/installation/virtual/index.rst
View File

@ -1,6 +1,6 @@
#################################### ####################
Running VyOS in Virtual Environments Virtual Environments
#################################### ####################
.. toctree:: .. toctree::
:caption: Content :caption: Content