summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorDaniel Thorpe <1077065+dantho281@users.noreply.github.com>2021-02-11 02:25:57 +0000
committerGitHub <noreply@github.com>2021-02-11 02:25:57 +0000
commite88fba68357181bd54fcc7489cbba08780cee6cd (patch)
treeb67e88b1208fa835edf0420a42dd2b624ec2105b /docs/index.rst
parentdab473bfd04ab2930c043b853ba9995d1ff335e6 (diff)
parentf33b0c78b07c80998d2c0e64d6a20bcb109f6db5 (diff)
downloadvyos-documentation-e88fba68357181bd54fcc7489cbba08780cee6cd.tar.gz
vyos-documentation-e88fba68357181bd54fcc7489cbba08780cee6cd.zip
Merge pull request #1 from vyos/master
Update fork
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst113
1 files changed, 25 insertions, 88 deletions
diff --git a/docs/index.rst b/docs/index.rst
index bab4f930..574a2c49 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,106 +4,43 @@
VyOS User Guide
###############
-
-.. toctree::
- :caption: Introduction
- :name: intro
- :maxdepth: 2
-
- about
- history
- install
- cli
- quick-start
-
-
.. toctree::
- :caption: Basic Configuration
- :name: basics
- :maxdepth: 2
+ :maxdepth: 1
- configuration-overview
- interfaces/basic-index
- system/basic-index
- image-mgmt
+ introducing/about
+ introducing/history
+ changelog/index
.. toctree::
- :caption: Advanced Configuration
- :name: advanced
:maxdepth: 2
+ :includehidden:
+ :caption: First Steps
- interfaces/advanced-index
- system/advanced-index
- services/index
- firewall
- routing/index
- vrf
- nat
- nptv6
- qos
- high-availability
- vpn/index
- load-balancing
- command-list-configuration
-
-
+ installation/index
+ quick-start
+ cli
+
.. toctree::
- :caption: System Operation
- :name: system-operation
:maxdepth: 2
+ :includehidden:
+ :caption: Adminguide
- information
- troubleshooting
- command-list-operation
-
-
-.. toctree::
- :caption: Appendix
- :name: appendix
- :maxdepth: 2
- appendix/release-notes
- appendix/examples/index
- appendix/vyos-on-vmware
- appendix/vyos-on-baremetal
- appendix/vyos-on-clouds
- appendix/vyos-on-virtual-environments
- appendix/migrate-from-vyatta
- appendix/command-scripting
- appendix/http-api
- appendix/vyos-on-gns3
+ configuration/index
+ operation/index
+ automation/index
+ troubleshooting/index
+ configexamples/index
.. toctree::
- :caption: Contributing
- :name: contributing
:maxdepth: 2
-
- contributing/build-vyos
- contributing/upstream-packages
- contributing/issues-features
- contributing/development
- contributing/debugging
- contributing/documentation
-
-
-################
-Copyright Notice
-################
-
-Copyright (C) 2018-2020 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.
+ :includehidden:
+ :caption: Development
+
+ contributing/index
+ debugging
+ documentation
+ coverage
+ copyright