[VOL-2875] Documentation update
- Updated the main landing page and overview documentation
- Added the lab setup (copied from CORD docs)
- Use forked sphinx-multiversion to publish docs, which allows versions
to be listed at bottom of sidebar
- Updated logo and favicon, fixed CSS to make logo legible
- Use VERSION file to set the version in the sidebar
- Add more words to dictionary
- removed reload functionality that is nonworking in Sphinx 2.x
- Fixed lint/linkcheck issues
Change-Id: I032e67d76393778fc697944a6d5df9c8cdacbbc4
diff --git a/index.rst b/index.rst
index 83d408d..b1039c2 100644
--- a/index.rst
+++ b/index.rst
@@ -1,74 +1,80 @@
VOLTHA Documentation
====================
-.. image:: images/VOLTHA_LOGO.png
+`VOLTHA (Virtual OLT Hardware Abstraction
+<https://www.opennetworking.org/voltha/>`_ is an open source project to create a
+hardware abstraction for broadband access equipment. It supports the principle
+of multi-vendor, disaggregated, "any broadband access as a service" for the
+Telco Central Office.
-Welcome to the VOLTHA project documentation.
+Key concepts in VOLTHA:
+
+- **Network as a Switch**: It makes a set of connected access network devices
+ to look like a SDN programmable switch.
+
+- **Evolution to virtualization**: it can work with a variety of access network
+ technologies and devices
+
+- **Unified OAM abstraction**: it provides unified, vendor- and technology
+ agnostic handling of device management tasks, such as service lifecycle,
+ device lifecycle (including discovery, upgrade), system monitoring, alarms,
+ troubleshooting, security, etc.
+
+- **Cloud/DevOps bridge to modernization**: it does all above while using a
+ microservices architecture running on top of Docker and/or Kubernetes.
+
+VOLTHA is a sub-project of the `Open Networking Foundation's
+<https://www.opennetworking.org>`_ `CORD project
+<https://www.opennetworking.org/cord/>`_.
+
+.. figure:: ./_static/voltha_components.svg
+ :alt: VOLTHA Component Diagram
+ :width: 70%
+
+ VOLTHA Component Diagram
+
+
+Community
+---------
+
+Information about participating in the VOLTHA community and development process
+can be found on the `VOLTHA section of the CORD Wiki
+<https://wiki.opencord.org/display/CORD/VOLTHA>`_.
+
.. toctree::
:maxdepth: 1
:caption: Overview
+ :hidden:
:glob:
overview/*
+ readme
.. toctree::
:maxdepth: 1
- :caption: Voltctl
-
- voltctl/README.md
-
-.. toctree::
- :maxdepth: 2
- :caption: BBSim
+ :hidden:
+ :caption: Components
bbsim/docs/source/index.rst
-
-.. toctree::
- :maxdepth: 1
- :caption: Release Notes
- :glob:
-
- release_notes/*
-
-.. toctree::
- :maxdepth: 1
- :caption: Testing
-
- testing/index.rst
- voltha-system-tests/README.md
-
-.. toctree::
- :maxdepth: 1
- :caption: VOLTHA Core (outdated)
-
- voltha-go/README.md
- voltha-go/quickstart.md
- voltha-go/BUILD.md
-
-.. toctree::
- :maxdepth: 1
- :caption: Adapters (outdated)
-
+ ofagent-go/README.md
+ openolt/README.md
voltha-openolt-adapter/README.md
-
-.. toctree::
- :maxdepth: 1
- :caption: VOLTHA-protos (outdated)
-
+ voltctl/README.md
voltha-protos/README.md
.. toctree::
:maxdepth: 1
- :caption: Documentation Notes
+ :hidden:
+ :caption: Testing
- readme
+ voltha-system-tests/README.md
+ testing/index.rst
+.. toctree::
+ :maxdepth: 1
+ :hidden:
+ :caption: Releases
+ :glob:
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+ release-notes/*