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, 35 insertions, 28 deletions
diff --git a/docs/about.rst b/docs/about.rst index 4af91890..8f9b7b8d 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -1,8 +1,12 @@ .. _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 13e8fa1c..51460f58 100644 --- a/docs/appendix/releasenotes.rst +++ b/docs/appendix/releasenotes.rst @@ -1,7 +1,12 @@ .. _releasenotes: +######## +Appendix +######## + +************* Release notes -############# +************* 1.2 (Crux) ========== diff --git a/docs/configuration-overview.rst b/docs/configuration-overview.rst index aba9b1dc..5118a4e7 100644 --- a/docs/configuration-overview.rst +++ b/docs/configuration-overview.rst @@ -1,8 +1,12 @@ .. _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 @@ -195,7 +199,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 @@ -340,7 +344,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. @@ -387,7 +391,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 @@ -411,7 +415,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. @@ -430,7 +434,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. @@ -447,7 +451,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 ab9ba6b2..c7d103d7 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -1,5 +1,10 @@ .. _build: + +############ +Contributing +############ + Building VyOS ============= diff --git a/docs/index.rst b/docs/index.rst index 9ca48869..abeddc1d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,9 +3,6 @@ VyOS User Guide =============== -############ -Introduction -############ .. toctree:: :caption: Introduction @@ -18,9 +15,6 @@ Introduction cli quick-start -###### -Basics -###### .. toctree:: :caption: Basics @@ -32,9 +26,6 @@ Basics system/index image-mgmt -######## -Advanced -######## .. toctree:: :caption: Advanced @@ -53,9 +44,6 @@ Advanced commandscripting troubleshooting -######## -Appendix -######## .. toctree:: :caption: Appendix @@ -69,9 +57,6 @@ Appendix 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 b49120f7..40176940 100644 --- a/docs/routing/index.rst +++ b/docs/routing/index.rst @@ -1,8 +1,12 @@ .. _routing: -####### +######## +Advanced +######## + +******* Routing -####### +******* .. toctree:: :maxdepth: 1 |