diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/about.rst | 19 | ||||
-rw-r--r-- | docs/configuration-overview.rst | 12 | ||||
-rw-r--r-- | docs/contributing/documentation.rst | 27 | ||||
-rw-r--r-- | docs/index.rst | 41 |
4 files changed, 55 insertions, 44 deletions
diff --git a/docs/about.rst b/docs/about.rst index 4af91890..9a7a7aac 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -27,3 +27,22 @@ which will take care of adjusting the synatax. No action needs to be taken by you. +**************** +Copyright Notice +**************** + +Copyright (C) 2018-2019 VyOS maintainers and contributors + +Permission is granted to make and distribute verbatim copies of this manual +provided the copyright notice and this permission notice are preserved on all +copies. + +Permission is granted to copy and distribute modified versions of this manual +under the conditions for verbatim copying, provided that the entire resulting +derived work is distributed under the terms of a permission notice identical +to this one. + +Permission is granted to copy and distribute translations of this manual into +another language, under the above conditions for modified versions, except that +this permission notice may be stated in a translation approved by the VyOS +maintainers.
\ No newline at end of file diff --git a/docs/configuration-overview.rst b/docs/configuration-overview.rst index aba9b1dc..ca8dc448 100644 --- a/docs/configuration-overview.rst +++ b/docs/configuration-overview.rst @@ -195,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 @@ -340,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. @@ -387,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 @@ -411,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. @@ -430,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. @@ -447,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/documentation.rst b/docs/contributing/documentation.rst index 3f088455..c89be9d4 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -83,6 +83,33 @@ This requires you already have a GitHub account. Style Guide ----------- +Sections +^^^^^^^^ + +We use the following syntax for Headlines. + +.. code-block:: sh + + ##### + Parts + ##### + + ******** + Chapters + ******** + + Sections + ======== + + Subsections + ----------- + + Subsubsections + ^^^^^^^^^^^^^^ + + Paragraphs + """""""""" + Address space ^^^^^^^^^^^^^ diff --git a/docs/index.rst b/docs/index.rst index 9ca48869..e8ae344f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,9 @@ .. _index: +############### VyOS User Guide -=============== +############### -############ -Introduction -############ .. toctree:: :caption: Introduction @@ -18,9 +16,6 @@ Introduction cli quick-start -###### -Basics -###### .. toctree:: :caption: Basics @@ -32,9 +27,6 @@ Basics system/index image-mgmt -######## -Advanced -######## .. toctree:: :caption: Advanced @@ -53,9 +45,6 @@ Advanced commandscripting troubleshooting -######## -Appendix -######## .. toctree:: :caption: Appendix @@ -69,9 +58,6 @@ Appendix appendix/vyos-on-baremetal appendix/migrate-from-vyatta -############ -Contributing -############ .. toctree:: :caption: Contributing @@ -81,25 +67,4 @@ Contributing contributing/build-vyos contributing/issues-features contributing/development - contributing/documentation - - -################ -Copyright Notice -################ - -Copyright (C) 2018-2019 VyOS maintainers and contributors - -Permission is granted to make and distribute verbatim copies of this manual -provided the copyright notice and this permission notice are preserved on all -copies. - -Permission is granted to copy and distribute modified versions of this manual -under the conditions for verbatim copying, provided that the entire resulting -derived work is distributed under the terms of a permission notice identical -to this one. - -Permission is granted to copy and distribute translations of this manual into -another language, under the above conditions for modified versions, except that -this permission notice may be stated in a translation approved by the VyOS -maintainers. + contributing/documentation
\ No newline at end of file |