summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuan Antonio Osorio Robles <juan.osorio.robles@ericsson.com>2015-06-25 13:33:24 +0300
committerJuan Antonio Osorio Robles <juan.osorio.robles@ericsson.com>2015-06-25 13:33:24 +0300
commit681905e8b5ec6885fed7e5e79901dc421df6a8be (patch)
treec961fa8aab1f77ef2b2f1e90070f339da4b849c9
parentd25c8fe6f331cca1945fe68b40465a0644fe4ee6 (diff)
Add overall description of the projectHEADmaster
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 <juan.osorio.robles@ericsson.com>
-rw-r--r--docs/source/index.rst26
1 files changed, 23 insertions, 3 deletions
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