summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGuangrongFu <fu.guangrong@zte.com.cn>2017-10-10 19:14:12 +0800
committerGuangrongFu <fu.guangrong@zte.com.cn>2017-10-10 19:14:47 +0800
commited614d0b1f124c5476055f137086dce111798d8e (patch)
treea633d66e3c995121a375d299961ee0b4dcd1b832 /docs
parent1c0fcc2b9b864bc9994991bc5437c7ee3ba6b2b3 (diff)
Re-organize the dir structure
Change-Id: I139533b48d7383acb97988d9d628b81fee88d02a Issue-ID: HOLMES-66 Signed-off-by: GuangrongFu <fu.guangrong@zte.com.cn>
Diffstat (limited to 'docs')
-rw-r--r--docs/platform/administration.rst2
-rw-r--r--docs/platform/consumedapis.rst2
-rw-r--r--docs/platform/index.rst7
-rw-r--r--docs/platform/log-and-diagnostic-info.rst4
-rw-r--r--docs/platform/offeredapis.rst5
-rw-r--r--docs/release-notes/index.rst15
6 files changed, 26 insertions, 9 deletions
diff --git a/docs/platform/administration.rst b/docs/platform/administration.rst
index a32790f..5213df7 100644
--- a/docs/platform/administration.rst
+++ b/docs/platform/administration.rst
@@ -12,4 +12,4 @@ Processes
Actions
^^^^^^^
* Action X
-* Action Y \ No newline at end of file
+* Action Y
diff --git a/docs/platform/consumedapis.rst b/docs/platform/consumedapis.rst
index f6eebb0..5124ec4 100644
--- a/docs/platform/consumedapis.rst
+++ b/docs/platform/consumedapis.rst
@@ -4,4 +4,4 @@
Consumed APIs
-------------
-References to APIs offered by other components \ No newline at end of file
+In the Amsterdam release, Holmes does not consume any APIs provided by other ONAP components.
diff --git a/docs/platform/index.rst b/docs/platform/index.rst
index 19742bb..441d0a9 100644
--- a/docs/platform/index.rst
+++ b/docs/platform/index.rst
@@ -1,7 +1,7 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-Holmes
-------------------------------------------------
+Platform
+--------
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.
@@ -10,9 +10,10 @@ Holmes provides alarm correlation and analysis for Telecom cloud infrastructure
architecture.rst
offeredapis.rst
+ consumedapis.rst
delivery.rst
log-and-diagnostic-info.rst
installation.rst
configuration.rst
administration.rst
- human-interfaces.rst \ No newline at end of file
+ human-interfaces.rst
diff --git a/docs/platform/log-and-diagnostic-info.rst b/docs/platform/log-and-diagnostic-info.rst
index 4561eab..4bda4ba 100644
--- a/docs/platform/log-and-diagnostic-info.rst
+++ b/docs/platform/log-and-diagnostic-info.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
Logging & Diagnostic Information
-
+---------------------------------
Description of how to interact with and diagnose problems with the components as delivered.
@@ -11,4 +11,4 @@ Where to Access Information
Error / Warning Messages
-^^^^^^^^^^^^^^^^^^^^^^^^ \ No newline at end of file
+^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/platform/offeredapis.rst b/docs/platform/offeredapis.rst
index 41142ed..4bab359 100644
--- a/docs/platform/offeredapis.rst
+++ b/docs/platform/offeredapis.rst
@@ -1,5 +1,6 @@
-Holmes Rule Management Component Offered APIs
-==================================
+Offered APIs
+------------
+
The rule management module provides the following APIs.
* Rule Creation
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
new file mode 100644
index 0000000..57f654f
--- /dev/null
+++ b/docs/release-notes/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Release-notes
+-------------
+
+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.
+
+.. toctree::
+ :maxdepth: 1
+
+ new-features.rst
+ bug-fixes.rst
+ upgrade-notes.rst
+ security-issues.rst
+ known-issues.rst