From 681905e8b5ec6885fed7e5e79901dc421df6a8be Mon Sep 17 00:00:00 2001 From: Juan Antonio Osorio Robles Date: Thu, 25 Jun 2015 13:33:24 +0300 Subject: Add overall description of the project This CR adds a brief description of the inspector project. This will appear in the index page. Change-Id: I5a62bfcc31acddec70b8bf6c797938dbf91b41b0 Signed-off-by: Juan Antonio Osorio Robles --- docs/source/index.rst | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/source/index.rst b/docs/source/index.rst index df0429a..b577190 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,10 +3,30 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Inspector's documentation! -===================================== +Inspector Project +================= -Contents: +What Inspector is NOT +--------------------- + +* A monitoring solution +* A new standard for audit +* A project defining a hard standard of audit + +What Inspector is +----------------- + +* A project to bring alignment and collaboration in order to get proper audit + information from the OPNFV components. +* An effort to fill the gaps in the information that's provided by the + infrastructure components. + + - This will be achieved by inspector being the place to put + bug-reports/wish-list items for more detailed information from the infra. +* An effort to bring sustainable audit where it's not existing already. + + - e.g. bring audit to OpenDaylight or components of OpenStack that are + missing it. .. toctree:: :maxdepth: 2 -- cgit 1.2.3-korg