vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

index: reformat table of contents

Browse Source 
Make TOC sections more obvious and remove single include file for
contribution and development.
This commit is contained in:
Christian Poessinger 2019-11-08 17:40:32 +01:00
parent 477f5717da
commit 7d3a19bcad
2 changed files with 65 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributing/index.rst
View File

@ -1,12 +0,0 @@
.. _contributing_index:
.. toctree::
:maxdepth: 2
:hidden:
issues_features
development
vyos_cli
coding_guidelines
upstream-packages
build-vyos

100
docs/index.rst
View File

@ -10,49 +10,79 @@ 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 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. 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.
############
Introduction
############
.. _introduction:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents:
:includehidden:
history.rst history.rst
install.rst install.rst
cli.rst cli.rst
quick-start.rst quick-start.rst
configuration-overview.rst configuration-overview.rst
interfaces/index.rst interfaces/index.rst
routing/index.rst routing/index.rst
firewall.rst firewall.rst
nat.rst nat.rst
vpn/index.rst vpn/index.rst
qos.rst qos.rst
services/index.rst services/index.rst
system/index.rst system/index.rst
high-availability.rst high-availability.rst
clustering.rst clustering.rst
load-balancing.rst load-balancing.rst
image-mgmt.rst image-mgmt.rst
commandscripting.rst commandscripting.rst
.. modules
########
Appendix
########
.. _appendix:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Appendix:
:includehidden:
appendix/releasenotes.rst appendix/releasenotes.rst
appendix/troubleshooting.rst appendix/troubleshooting.rst
appendix/examples/index.rst appendix/examples/index.rst
appendix/commandtree/index.rst appendix/commandtree/index.rst
appendix/vyos-on-vmware.rst appendix/vyos-on-vmware.rst
appendix/vyos-on-baremetal.rst appendix/vyos-on-baremetal.rst
appendix/migrate-from-vyatta.rst appendix/migrate-from-vyatta.rst
############
Contributing
############
.. _contributing:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contributing:
:includehidden:
contributing/index.rst contributing/issues_features
contributing/development
contributing/vyos_cli
contributing/coding_guidelines
contributing/upstream-packages
contributing/build-vyos
################ ################