X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=0580a9e65b7cd7b3cf13c7577df4de80a98f0b98;hb=refs%2Fheads%2Fmaster;hp=833e1aa96955b6cd7c70bcb83af8238c43682487;hpb=6ec1f2e784928e9391381608e40df77432c4255d;p=aai%2Fsparky-be.git diff --git a/docs/index.rst b/docs/index.rst index 833e1aa..0580a9e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,28 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. _master_index: -TODO Add files to toctree and delete this header ------------------------------------------------- -.. toctree:: - :maxdepth: 1 +============================= +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 + +Overview +======== +Sparky is a service that interacts with resources and traversal microservices, 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. +The key AAI repos for running the Sparky UI are: + +- aai/sparky-fe: This holds the code that constructs the GUI +- aai/sparky-be: This holds the Java code and other technologies that provide the front-end with its data. + +.. toctree:: + :maxdepth: 2 + platform/index.rst