From 4c5692dc381f6538bd18ed33e87d27c3b506766b Mon Sep 17 00:00:00 2001 From: jimmy Date: Wed, 25 Oct 2017 14:27:49 -0400 Subject: Convert docs to rst and set up platform section Issue-ID: AAI-255 Change-Id: Id78116b2e3fadb3d0f4f7d2a602ba63633c806b7 Signed-off-by: jimmy --- docs/index.rst | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index a8251653..716d04e2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,13 +2,18 @@ AAI Documentation Repository ---------------------------- +Active and Available Inventory (AAI) is the “one-stop-shop” where all the network information comes together. Modern networks are complex, dynamic, and difficult to manage, and AAI delivers live insight into hybrid services and virtual resources, in support of closed loop processes. We hold the references to the network services and infrastructure, data center resources, connectivity components, and service overlays; and we know how they’re all related. + +The key AAI repos for running the AAI REST APIs: + +- aai/aai-common: This holds the model, annotations and common modules used across the Resources and Traversal micro services +- aai/traversal: AAI Traversal Micro Service providing REST APIs for traversal/search of inventory resources +- aai/resources: AAI Resources Micro Service providing CRUD REST APIs for inventory resources + .. toctree:: :maxdepth: 3 AAI REST API Documentation/AAIRESTAPI_AMSTERDAM - Getting Started/AAI_Developer_Environment_Setup - Getting Started/How_to_Docker_setup_on_Single_VM - Getting Started/How_to_AAI_data_snapshot_and_restore_in_ONAP_1_1 - Getting Started/Edge_Rules - Getting Started/Queries/Policy_Named_Query - Getting Started/Queries/vnf_to_esr_system_info_Named_Query + platform/index.rst + release-notes/index.rst + -- cgit 1.2.3-korg