summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2020-12-08 14:57:44 +0100
committerrebortg <github@ghlr.de>2020-12-08 14:57:44 +0100
commitf6c43343bbea7c98b6e735f5204da1759343ca23 (patch)
tree8ddd1150ffaf65cd36678ebc95c7d9fb22ae1dce /docs/index.rst
parente6d0a80db37769a3d40084a8d55abfd7b24b941a (diff)
parent0bb741b58bc0dd7f0beae7364ed519f7165bdbb7 (diff)
downloadvyos-documentation-f6c43343bbea7c98b6e735f5204da1759343ca23.tar.gz
vyos-documentation-f6c43343bbea7c98b6e735f5204da1759343ca23.zip
Merge branch 'sagitta' of https://github.com/rebortg/vyos-documentation
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst107
1 files changed, 25 insertions, 82 deletions
diff --git a/docs/index.rst b/docs/index.rst
index ab9d3f66..5d8bfd55 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,104 +4,47 @@
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
+ 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
-
-
+ installation/index
+ quick-start
+ cli
+
.. toctree::
- :caption: Advanced Configuration
- :name: advanced
:maxdepth: 2
+ :hidden:
+ :includehidden:
+ :caption: Adminguide
- interfaces/advanced-index
- system/advanced-index
- services/index
- firewall
- routing/index
- vrf
- nat
- nptv6
- qos
- high-availability
- vpn/index
- load-balancing
- command-list-configuration
-
-
-.. toctree::
- :caption: System Operation
- :name: system-operation
- :maxdepth: 2
- 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
+ coverage
+ copyright