add sphinx panels and create 6 panels on index.rst

(cherry picked from commit 9708481d5e539a4b5c3d13b1a774abcda84df138)

Pipfile

@@ -9,6 +9,7 @@ docutils = "*"
 lxml = "*"
 sphinx-notfound-page = "*"
 Sphinx = ">=1.4.3"
+sphinx-panels = "*"
 
 [dev-packages]
 

docker/Dockerfile

@@ -34,6 +34,8 @@ RUN pip3 install sphinx-rtd-theme
 RUN pip3 install sphinx-autobuild
 RUN pip3 install sphinx-notfound-page
 RUN pip3 install lxml
+RUN pip3 install myst-parser
+RUN pip3 install sphinx-panels
 
 
 # Cleanup

docs/_static/css/custom.css

@@ -1,3 +1,8 @@
+div.card-header {
+  font-weight: bold;
+  background: #fdab10;
+}
+
 span.opcmd,
 span.cfgcmd {
     font-weight: bold;

docs/conf.py

@@ -45,6 +45,8 @@ extensions = ['sphinx.ext.intersphinx',
               'sphinx.ext.ifconfig',
               'sphinx.ext.graphviz',
               'notfound.extension',
+              'myst_parser',
+              'sphinx_panels',
               'vyos'
 ]
 

docs/index.rst

@@ -4,7 +4,53 @@
 VyOS User Guide
 ###############
 
+.. panels::
+   :container: container-lg pb-3
+   :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2
+   
+   Get / Build VyOS
+   ^^^^^^^^^^^^^^^^
+   Quickly :ref:`Build<contributing/build-vyos:build vyos>` your own Image or take a look at how to :ref:`download<installation/install:download>` a free or supported version.
+   ---
+
+   Install VyOS
+   ^^^^^^^^^^^^
+   Read about how to install VyOS on :ref:`Bare Metall<installation/install:installation>` or in a
+   :ref:`Virtual Environment<installation/virtual/index:running vyos in virtual environments>` and
+   how to use an image with the usual :ref:`cloud<installation/cloud/index:running VyOS in Cloud Environments>` providers 
+   ---
+
+   Configuration and Operation
+   ^^^^^^^^^^^^^^^^^^^^^^^^^^^
+   Use the :ref:`Quickstart Guide<quick-start:Quick Start>`, to have a fast overview. Or go deeper and
+   set up :ref:`advanced routing<configuration/protocols/index:protocols>`,
+   :ref:`VRFs<configuration/vrf/index:vrf>`, or
+   :ref:`VPNs<configuration/vpn/index:vpn>` for example.
+   ---
+
+   Automate
+   ^^^^^^^^
+   Integrate VyOS in your automation Workflow with 
+   :ref:`Ansible<vyos-ansible>`,
+   have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`.
+   ---
+
+   Examples
+   ^^^^^^^^
+   Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>`
+   to build your infrastructure.
+   ---
+
+   Contribute and Community
+   ^^^^^^^^^^^^^^^^^^^^^^^^
+   | There are many ways to contribute to the project.
+   | Add missing parts or improve the :ref:`Documentation<documentation:Write Documentation>`.
+   | Discuss in `Slack <https://slack.vyos.io/>`_ or the `Forum <https://forum.vyos.io>`_.
+   | Or you can pick up a `Task <https://phabricator.vyos.net/>`_ and fix the :ref:`code<contributing/development:development>`.
+
+
 .. toctree::
+   :hidden:
    :maxdepth: 1
 
    introducing/about
@@ -14,7 +60,7 @@ VyOS User Guide
 
 .. toctree::
    :maxdepth: 2
-   :includehidden:
+   :hidden:
    :caption: First Steps
 
    installation/index
@@ -23,7 +69,7 @@ VyOS User Guide
 
 .. toctree::
    :maxdepth: 2
-   :includehidden:
+   :hidden:
    :caption: Adminguide
 
 
@@ -36,7 +82,7 @@ VyOS User Guide
 
 .. toctree::
    :maxdepth: 2
-   :includehidden:
+   :hidden:
    :caption: Development
 
    contributing/index

requirements.txt

@@ -4,4 +4,4 @@ setuptools
 docutils
 lxml
 sphinx-notfound-page
-docutils<0.18
+docutils<0.18