Updating the CII info in readme

[aai/sparky-be.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index bc69e1b..73cef31 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,6 +4,14 @@
 Sparky - Inventory UI Service
 =============================
 
+.. image:: https://bestpractices.coreinfrastructure.org/projects/1737/badge
+   :height: 30px
+   :width: 200 px
+   :scale: 100 %
+   :alt: alternate text
+   :align: right
+   :target: https://bestpractices.coreinfrastructure.org/projects/1737
+   
 Architecture
 ============
 Sparky a service that interacts with AAI and provides users with a user interface to view and analyze AAI data. The main goal behind Sparky is to provide a clear and user friendly view of AAI data.
@@ -12,9 +20,11 @@ It is divided into both a front-end (the code that constructs the GUI) and a bac
 
 At this time, Sparky has two views available for use:
 
-`View and Inspect <./VIEW_INSPECT.md>`_ - Graph-based view of entities within AAI
+.. toctree::
+   :maxdepth: 1
 
-`VNFs <./VNFS.md>`_ - Aggregation-based view of VNFs within AAI
+   Graph-based view of entities within AAI <./view_inspect>
+   Aggregation-based view of VNFs within AAI VNFs <./vnfs>
 
 Interactions
 ------------