diff options
| author | Christian Poessinger <christian@poessinger.com> | 2019-11-23 18:32:28 +0100 |
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2019-11-23 18:32:28 +0100 |
| commit | 2e2e9b887a6f160fffa4340195d00f609e44ba13 (patch) | |
| tree | aaa04a5f8863c8d7b9a0fd528cb46f25f8bd7735 /docs/index.rst | |
| parent | 79f15b05c2fc2a6ebd61721b3bb97d10d93c83d2 (diff) | |
| download | vyos-documentation-2e2e9b887a6f160fffa4340195d00f609e44ba13.tar.gz vyos-documentation-2e2e9b887a6f160fffa4340195d00f609e44ba13.zip | |
toc: build proper doc in html and pdf
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 49 |
1 files changed, 20 insertions, 29 deletions
diff --git a/docs/index.rst b/docs/index.rst index 5f18c011..742b8eec 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,41 +3,28 @@ VyOS User Guide =============== -VyOS is an open source network operating system based on Debian GNU/Linux. - -VyOS provides a free routing platform that competes directly with other -commercially available solutions from well known network providers. Because -VyOS is run on standard amd64, i586 and ARM systems, it is able to be used -as a router and firewall platform for cloud deployments. - -##### -About -##### - -We use multiple live versions of our manual hosted thankfully by -https://readthedocs.org. We will provide one version of the manual for every -VyOS major version starting with VyOS 1.2 which will receive Long-term support -(LTS). - -The manual version is selected/specified by it's Git branch name. You can -switch between versions of the documentation by selecting the appropriate -branch on the bottom left corner. - -VyOS CLI syntax may change between major (and sometimes minor) versions. Please -always refer to the documentation matching your current, running installation. -If a change in the CLI is required, VyOS will ship a so called migration script -which will take care of adjusting the synatax. No action needs to be taken by -you. +############ +Introduction +############ .. _introduction: .. toctree:: - :caption: Introduction :maxdepth: 2 + about history install cli quick-start + +###### +Basics +###### + +.. _introduction: +.. toctree:: + :maxdepth: 2 + configuration-overview interfaces/index routing/index @@ -52,12 +39,13 @@ you. load-balancing image-mgmt commandscripting -.. modules +######## +Appendix +######## .. _appendix: .. toctree:: - :caption: Appendix :maxdepth: 2 appendix/releasenotes @@ -68,10 +56,12 @@ you. appendix/vyos-on-baremetal appendix/migrate-from-vyatta +############ +Contributing +############ .. _contributing: .. toctree:: - :caption: Contributing :maxdepth: 2 contributing/build-vyos @@ -79,6 +69,7 @@ you. contributing/development contributing/documentation + ################ Copyright Notice ################ |