Skip to content

Commit db5e2af

Browse files
committed
Rename chapters and remove redundant VyOS wording
1 parent 1bbe5de commit db5e2af

File tree

6 files changed

+33
-44
lines changed

6 files changed

+33
-44
lines changed

docs/cli.rst

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ configured, changes are added through a collection of :cfgcmd:`set` and
329329
330330
Both these ``show`` commands should be executed when in operational
331331
mode, they do not work directly in configuration mode. There is a
332-
special way on how to :ref:`run_opmode_from_config_mode`.
332+
special way on how to :ref:run_opmode_from_config_mode.
333333

334334
.. hint:: Use the ``show configuration commands | strip-private``
335335
command when you want to hide private data. You may want to do so if
@@ -528,7 +528,7 @@ mode using :cfgcmd:`show | commands`
528528
set address dhcp
529529
set hw-id 00:53:ad:44:3b:03
530530
531-
These commands are also relative to the level you are inside and only
531+
These commands are also relative to the level you are inside and only
532532
relevant configuration blocks will be displayed when entering a
533533
sub-level.
534534

@@ -620,7 +620,7 @@ different levels in the hierarchy.
620620
Use this command to preserve configuration changes upon reboot. By
621621
default it is stored at */config/config.boot*. In the case you want
622622
to store the configuration file somewhere else, you can add a local
623-
path, a SCP address, a FTP address or a TFTP address.
623+
path, a SCP address, a FTP address or a TFTP address.
624624

625625
.. code-block:: none
626626
@@ -675,13 +675,13 @@ different levels in the hierarchy.
675675
system will reboot into previous config revision.
676676

677677
.. code-block:: none
678-
678+
679679
vyos@router# set firewall interface eth0 local name FromWorld
680-
vyos@router# commit-confirm
680+
vyos@router# commit-confirm
681681
commit confirm will be automatically reboot in 10 minutes unless confirmed
682682
Proceed? [confirm]y
683683
[edit]
684-
vyos@router# confirm
684+
vyos@router# confirm
685685
[edit]
686686
687687
@@ -703,8 +703,8 @@ different levels in the hierarchy.
703703

704704

705705
.. code-block:: none
706-
707-
vyos@router# show firewall name FromWorld
706+
707+
vyos@router# show firewall name FromWorld
708708
default-action drop
709709
rule 10 {
710710
action accept
@@ -713,7 +713,7 @@ different levels in the hierarchy.
713713
}
714714
}
715715
[edit]
716-
vyos@router# edit firewall name FromWorld
716+
vyos@router# edit firewall name FromWorld
717717
[edit firewall name FromWorld]
718718
vyos@router# copy rule 10 to rule 20
719719
[edit firewall name FromWorld]
@@ -730,7 +730,7 @@ different levels in the hierarchy.
730730
You can also rename config subtrees:
731731

732732
.. code-block:: none
733-
733+
734734
vyos@router# rename rule 10 to rule 5
735735
[edit firewall name FromWorld]
736736
vyos@router# commit
@@ -741,8 +741,8 @@ different levels in the hierarchy.
741741
with no parameters.
742742

743743
.. code-block:: none
744-
745-
vyos@router# show
744+
745+
vyos@router# show
746746
default-action drop
747747
rule 5 {
748748
action accept
@@ -791,11 +791,6 @@ different levels in the hierarchy.
791791
firewall` command would return starting after the ``firewall
792792
{`` line, hiding the comment.
793793

794-
795-
796-
797-
798-
799794
.. _run_opmode_from_config_mode:
800795

801796
Access opmode from config mode
@@ -1018,7 +1013,7 @@ to load it with the ``load`` command:
10181013

10191014
.. code-block:: none
10201015
1021-
vyos@vyos# load
1016+
vyos@vyos# load
10221017
Possible completions:
10231018
<Enter> Load from system config file
10241019
<file> Load from file on local machine
@@ -1028,7 +1023,7 @@ to load it with the ``load`` command:
10281023
http://<host>/<file> Load from file on remote machine
10291024
https://<host>/<file> Load from file on remote machine
10301025
tftp://<host>/<file> Load from file on remote machine
1031-
1026+
10321027
10331028
10341029
Restore Default
@@ -1051,4 +1046,3 @@ configuration too.
10511046
.. note:: If you are remotely connected, you will lose your connection.
10521047
You may want to copy first the config, edit it to ensure
10531048
connectivity, and load the edited config.
1054-

docs/index.rst

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,42 @@ VyOS User Guide
55
###############
66

77

8-
98
.. grid:: 3
109
:gutter: 2
11-
10+
1211
.. grid-item-card:: Get / Build VyOS
1312

14-
13+
1514
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.
16-
15+
1716

1817
.. grid-item-card:: Install VyOS
1918

2019
Read about how to install VyOS on :ref:`Bare Metal<installation/install:installation>` or in a
21-
:ref:`Virtual Environment<installation/virtual/index:running vyos in virtual environments>` and
22-
how to use an image with the usual :ref:`cloud<installation/cloud/index:running VyOS in Cloud Environments>` providers
23-
20+
:ref:`Virtual Environment<installation/virtual/index:Virtual Environments>` and
21+
how to use an image with the usual :ref:`cloud<installation/cloud/index:Cloud Environments>` providers
22+
2423

2524
.. grid-item-card:: Configuration and Operation
2625

2726
Use the :ref:`Quickstart Guide<quick-start:Quick Start>`, to have a fast overview. Or go deeper and
2827
set up :ref:`advanced routing<configuration/protocols/index:protocols>`,
2928
:ref:`VRFs<configuration/vrf/index:vrf>`, or
3029
:ref:`VPNs<configuration/vpn/index:vpn>` for example.
31-
30+
3231

3332
.. grid-item-card:: Automate
3433

35-
Integrate VyOS in your automation Workflow with
34+
Integrate VyOS in your automation Workflow with
3635
:ref:`Ansible<vyos-ansible>`,
3736
have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`.
38-
37+
3938

4039
.. grid-item-card:: Examples
4140

4241
Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>`
4342
to build your infrastructure.
44-
43+
4544

4645
.. grid-item-card:: Contribute and Community
4746

docs/installation/vyos-on-baremetal.rst renamed to docs/installation/bare-metal.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _vyosonbaremetal:
22

33
#####################
4-
Running on Bare Metal
4+
Bare Metal Deployment
55
#####################
66

77
Supermicro A2SDi (Atom C3000)

docs/installation/cloud/index.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
##################################
2-
Running VyOS in Cloud Environments
3-
##################################
4-
5-
1+
##################
2+
Cloud Environments
3+
##################
64

75
.. toctree::
86
:caption: Content
97

108
aws
119
azure
1210
gcp
13-
oracel
11+
oracel

docs/installation/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22
Installation and Image Management
33
#################################
44

5-
6-
75
.. toctree::
86
:maxdepth: 2
97
:caption: Content
108

119
install
1210
virtual/index
1311
cloud/index
14-
vyos-on-baremetal
12+
bare-metal
1513
update
1614
image
1715
migrate-from-vyatta

docs/installation/virtual/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
####################################
2-
Running VyOS in Virtual Environments
3-
####################################
1+
####################
2+
Virtual Environments
3+
####################
44

55
.. toctree::
66
:caption: Content

0 commit comments

Comments
 (0)