From c25c40dfa96dfeb022b203280c607c1f1835417b Mon Sep 17 00:00:00 2001 From: Robert Göhler Date: Sun, 24 Jan 2021 22:14:00 +0100 Subject: Migrate new file structure to crux (#435) * order workflows and add submodule * rename gitmodules file * delete docs/.gitignore * add vyos custom linter * correct __pycache__ in gitignore * add test-coverage.py * move draw.io folder * arrange changelog, install history and about * arrange: firewall * arrange: highavailability * arrange: loadbalancing * arrange: nat * arrange: services * sort configexamples and configuration interfaces * wireles: rename wireless * rearrange: Protocols and Policy * rearrange: Firewall and Zone Policy * rearrange: Interfaces * rearrange: Interfaces * rearrange: dynamic DNS * hostinfo: add page to index * rearrange: appendix * venv: add Pipfile * rearrange: contributing * index: remove debugging * rearrange: fix all figure and refs * rearrange: commandtree * fix: cli, openvpn, install headline level * protocols: change headline * firewall: move mss clamping * ip: separate ipv4 and ipv6 * arp: move to static page * igmp: rename multicast page * Update to year 2021 --- docs/index.rst | 90 ++++++++++++++++------------------------------------------ 1 file changed, 24 insertions(+), 66 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index d0f2c6e7..e3c92e22 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,85 +4,43 @@ VyOS User Guide ############### - -.. toctree:: - :caption: Introduction - :name: intro - :maxdepth: 2 - - about - history - install - cli - quick-start - .. toctree:: - :caption: Configuration - :name: configuration - :maxdepth: 2 - - configuration-overview - interfaces/index - routing/index - firewall - nat - vpn/index - qos - services/index - system/index - high-availability - load-balancing - image-mgmt - commandscripting -.. modules + :maxdepth: 1 + introducing/about + introducing/history + changelog/index .. toctree:: - :caption: Appendix - :name: appendix :maxdepth: 2 + :includehidden: + :caption: First Steps - appendix/releasenotes - appendix/troubleshooting - appendix/examples/index - appendix/commandtree/index - appendix/vyos-on-vmware - appendix/vyos-on-gns3 - appendix/vyos-on-baremetal - appendix/migrate-from-vyatta + installation/index + quick-start + cli + commandtree/index .. toctree:: - :caption: Contributing - :name: contributing :maxdepth: 2 - - contributing/issues_features - contributing/development - contributing/documentation - contributing/vyos_cli - contributing/coding_guidelines - contributing/upstream-packages - contributing/build-vyos + :includehidden: + :caption: Adminguide + configuration/index + operation/index + automation/index + troubleshooting/index + configexamples/index -################ -Copyright Notice -################ -Copyright (C) 2018-2019 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. +.. toctree:: + :maxdepth: 2 + :includehidden: + :caption: Development -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 + documentation + copyright \ No newline at end of file -- cgit v1.2.3