summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst108
1 files changed, 25 insertions, 83 deletions
diff --git a/docs/index.rst b/docs/index.rst
index ab9d3f66..3322bf8d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,102 +6,44 @@ VyOS User Guide
.. toctree::
- :caption: Introduction
- :name: intro
:maxdepth: 2
+ :hidden:
+ :caption: FIND CAPTION NAME
- about
- history
- install
- cli
- quick-start
-
+ introducing/about
+ introducing/history
+ introducing/releases
+ changelog/index
.. toctree::
- :caption: Basic Configuration
- :name: basics
:maxdepth: 2
+ :hidden:
+ :includehidden:
+ :caption: first steps
- configuration-overview
- interfaces/basic-index
- system/basic-index
- image-mgmt
-
-
-.. toctree::
- :caption: Advanced Configuration
- :name: advanced
- :maxdepth: 2
-
- 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
+ :hidden:
+ :includehidden:
+ :caption: Adminguide
- information
- troubleshooting
- command-list-operation
+ configuration/index
+ operation/index
+ automation/index
+ troubleshooting/index
+ configexamples/index
.. toctree::
- :caption: Appendix
- :name: appendix
:maxdepth: 2
-
- appendix/release-notes
- appendix/examples/index
- appendix/vyos-on-baremetal
- appendix/virtual/index
- appendix/vyos-on-clouds
- appendix/migrate-from-vyatta
- appendix/command-scripting
- appendix/http-api
-
-
-.. toctree::
+ :hidden:
+ :includehidden:
: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.
+ contributing/index
+ copyright