diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/about.rst | 8 | ||||
| -rw-r--r-- | docs/appendix/releasenotes.rst | 7 | ||||
| -rw-r--r-- | docs/configuration-overview.rst | 20 | ||||
| -rw-r--r-- | docs/contributing/build-vyos.rst | 5 | ||||
| -rw-r--r-- | docs/index.rst | 15 | ||||
| -rw-r--r-- | docs/routing/index.rst | 8 |
6 files changed, 28 insertions, 35 deletions
diff --git a/docs/about.rst b/docs/about.rst index 8f9b7b8d..4af91890 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -1,12 +1,8 @@ .. _about: -############ -Introduction -############ - -***** +##### About -***** +##### VyOS is an open source network operating system based on Debian GNU/Linux. diff --git a/docs/appendix/releasenotes.rst b/docs/appendix/releasenotes.rst index 51460f58..13e8fa1c 100644 --- a/docs/appendix/releasenotes.rst +++ b/docs/appendix/releasenotes.rst @@ -1,12 +1,7 @@ .. _releasenotes: -######## -Appendix -######## - -************* Release notes -************* +############# 1.2 (Crux) ========== diff --git a/docs/configuration-overview.rst b/docs/configuration-overview.rst index 5118a4e7..aba9b1dc 100644 --- a/docs/configuration-overview.rst +++ b/docs/configuration-overview.rst @@ -1,12 +1,8 @@ .. _configuration-overview: -###### -Basics -###### - -********************** +###################### Configuration Overview -********************** +###################### VyOS makes use of a unified configuration file for all system configuration: `config.boot`. This allows for easy template creation, backup, and replication @@ -199,7 +195,7 @@ replacements and ``-`` for deletions. vyos@vyos# It is also possible to display all `set` commands within configuration mode -using ``show | commands`` +using ``show | commands` .. code-block:: sh @@ -344,7 +340,7 @@ Archive VyOS automatically maintains backups of previous configurations. Local archive and revisions ---------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^ Revisions are stored on disk. You can view them, compare them, and rollback to previous revisions if anything goes wrong. @@ -391,7 +387,7 @@ command: vyos@vyos# Comparing Revisions -^^^^^^^^^^^^^^^^^^^ +""""""""""""""""""" You can compare revisions with ``compare X Y`` command, where X and Y are revision numbers. The output will describe how the configuration X is when @@ -415,7 +411,7 @@ x misses when compared to y. -} Rolling Back Changes -^^^^^^^^^^^^^^^^^^^^ +"""""""""""""""""""" You can rollback configuration using the rollback command. This command will apply the selected revision and trigger a system reboot. @@ -434,7 +430,7 @@ apply the selected revision and trigger a system reboot. vyos@vyos# Configuring the archive size -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +"""""""""""""""""""""""""""" You can specify the number of revisions stored on disk with ``set system config-management commit-revisions X``, where X is a number between 0 and 65535. @@ -451,7 +447,7 @@ You can specify the location with: * ``set system config-management commit-archive location URL`` -For example, ``set system config-management commit-archive location tftp://10.0.0.1/vyos``. +For example, ``set system config-management commit-archive location tftp://10.0.0.1/vyos`. You can specify the location with ``set system config-management commit-archive location URL`` command, e.g. ``set system config-management commit-archive diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index c7d103d7..ab9ba6b2 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -1,10 +1,5 @@ .. _build: - -############ -Contributing -############ - Building VyOS ============= diff --git a/docs/index.rst b/docs/index.rst index abeddc1d..9ca48869 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,6 +3,9 @@ VyOS User Guide =============== +############ +Introduction +############ .. toctree:: :caption: Introduction @@ -15,6 +18,9 @@ VyOS User Guide cli quick-start +###### +Basics +###### .. toctree:: :caption: Basics @@ -26,6 +32,9 @@ VyOS User Guide system/index image-mgmt +######## +Advanced +######## .. toctree:: :caption: Advanced @@ -44,6 +53,9 @@ VyOS User Guide commandscripting troubleshooting +######## +Appendix +######## .. toctree:: :caption: Appendix @@ -57,6 +69,9 @@ VyOS User Guide appendix/vyos-on-baremetal appendix/migrate-from-vyatta +############ +Contributing +############ .. toctree:: :caption: Contributing diff --git a/docs/routing/index.rst b/docs/routing/index.rst index 40176940..b49120f7 100644 --- a/docs/routing/index.rst +++ b/docs/routing/index.rst @@ -1,12 +1,8 @@ .. _routing: -######## -Advanced -######## - -******* +####### Routing -******* +####### .. toctree:: :maxdepth: 1 |