Leverage upper-constraints files to pin all dependencies

[holmes/rule-management.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index c7887dd..0a16914 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,20 +1,15 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. _master_index:
 
 Holmes
-------------------------------------------------
+------
 
-Holmes provides alarm correlation and analysis for Telecom cloud infrastructure and services, including hosts, vims, VNFs and NSs. Holmes aims to find the root reason which causes the failure or degradation of services by digging into the ocean of events collected from different levels of the Telecom cloud.
-
-Holmes comprises three modules: the rule management module, the engine management module and the data source adapter.
-
-- Holmes
-    - Rule Management Module
-    - Engine Management Module
-    - Data Source Adapter
+This document is aimed to give the users some brief introductions on Holmes from different aspects.
+The users could find useful information, e.g. the architecuture, the APIs and the installation steps, etc.
+as well as the release notes of Holmes in this document.
 
 .. toctree::
    :maxdepth: 1
-   
-   offeredapis.rst
-
 
+   platform/index.rst
+   release-notes.rst