X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=73cef31da3e9b04c179a8edda4fec175ce91757e;hb=75d0da4cdb78e1881d0ba9bbe8d89ddfb17f2793;hp=bc69e1b5d57a8da430e1b7fecb578c9a65e059c2;hpb=2d5605c0dd4aeda6798404913881f94e5e091438;p=aai%2Fsparky-be.git diff --git a/docs/index.rst b/docs/index.rst index bc69e1b..73cef31 100644 --- 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 ------------