diff options
| author | Christian Poessinger <christian@poessinger.com> | 2019-11-08 17:40:32 +0100 | 
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2019-11-08 17:42:00 +0100 | 
| commit | 7d3a19bcad6a011b407d4f143f70c6f70631ad95 (patch) | |
| tree | ca1f9adeaff9f9eb07a6a732dea36b6b9b33f4a0 /docs | |
| parent | 477f5717dad68be5cc5039acbdd34a14bdc3bd56 (diff) | |
| download | vyos-documentation-7d3a19bcad6a011b407d4f143f70c6f70631ad95.tar.gz vyos-documentation-7d3a19bcad6a011b407d4f143f70c6f70631ad95.zip | |
index: reformat table of contents
Make TOC sections more obvious and remove single include file for
contribution and development.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing/index.rst | 12 | ||||
| -rw-r--r-- | docs/index.rst | 104 | 
2 files changed, 67 insertions, 49 deletions
| diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst deleted file mode 100644 index c90d533e..00000000 --- a/docs/contributing/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _contributing_index: - -.. toctree:: -   :maxdepth: 2 -   :hidden: - -   issues_features -   development -   vyos_cli -   coding_guidelines -   upstream-packages -   build-vyos diff --git a/docs/index.rst b/docs/index.rst index 503545bd..302c6757 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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  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:: -    :maxdepth: 2 -    :caption: Contents: -    :includehidden: - -    history.rst -    install.rst -    cli.rst -    quick-start.rst -    configuration-overview.rst -    interfaces/index.rst -    routing/index.rst -    firewall.rst -    nat.rst -    vpn/index.rst -    qos.rst -    services/index.rst -    system/index.rst -    high-availability.rst -    clustering.rst -    load-balancing.rst -    image-mgmt.rst -    commandscripting.rst +   :maxdepth: 2 + +   history.rst +   install.rst +   cli.rst +   quick-start.rst +   configuration-overview.rst +   interfaces/index.rst +   routing/index.rst +   firewall.rst +   nat.rst +   vpn/index.rst +   qos.rst +   services/index.rst +   system/index.rst +   high-availability.rst +   clustering.rst +   load-balancing.rst +   image-mgmt.rst +   commandscripting.rst +.. modules + +######## +Appendix +######## + +.. _appendix:  .. toctree:: -    :maxdepth: 2 -    :caption: Appendix: -    :includehidden: - -    appendix/releasenotes.rst -    appendix/troubleshooting.rst -    appendix/examples/index.rst -    appendix/commandtree/index.rst -    appendix/vyos-on-vmware.rst -    appendix/vyos-on-baremetal.rst -    appendix/migrate-from-vyatta.rst +   :maxdepth: 2 + +   appendix/releasenotes.rst +   appendix/troubleshooting.rst +   appendix/examples/index.rst +   appendix/commandtree/index.rst +   appendix/vyos-on-vmware.rst +   appendix/vyos-on-baremetal.rst +   appendix/migrate-from-vyatta.rst + + +############ +Contributing +############ +.. _contributing:  .. toctree:: -    :maxdepth: 2 -    :caption: Contributing: -    :includehidden: +   :maxdepth: 2 -    contributing/index.rst +   contributing/issues_features +   contributing/development +   contributing/vyos_cli +   contributing/coding_guidelines +   contributing/upstream-packages +   contributing/build-vyos  ################ | 
