From 2822922d9fb8e0104392e0bdf86bdb770f7a6035 Mon Sep 17 00:00:00 2001 From: Witold Bedyk Date: Wed, 25 Apr 2018 14:49:10 +0200 Subject: [PATCH] Update Monasca documentation page * add introduction * remove empty references Change-Id: I5a1b36db1d03ba27633679cd9fdd3570157335cf Story: 2001912 Task: 14428 --- doc/source/configuration/index.rst | 10 ----- doc/source/index.rst | 59 ++++++++++++++++++------------ 2 files changed, 35 insertions(+), 34 deletions(-) delete mode 100644 doc/source/configuration/index.rst diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst deleted file mode 100644 index 91f38f6de..000000000 --- a/doc/source/configuration/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _configuring: - -============= -Configuration -============= - -.. toctree:: - :maxdepth: 1 - - sample diff --git a/doc/source/index.rst b/doc/source/index.rst index 024f27f01..5d4035f59 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,37 +15,48 @@ under the License. =================================== -Welcome to Monasca's documentation! +Welcome to Monasca's Documentation! =================================== -Monasca is a open-source multi-tenant, highly scalable, performant, -fault-tolerant monitoring-as-a-service solution that -integrates with OpenStack. It uses a REST API for high-speed metrics -processing and querying and has a streaming -alarm and notification engine. +The monitoring requirements in OpenStack environments are vast, varied, and +highly complex. Monasca's project mission is to provide a +monitoring-as-a-service solution that is multi-tenant, highly scalable, +performant, and fault-tolerant. Monasca provides an extensible platform for +advanced monitoring that can be used by both operators and tenants to gain +operational insights about their infrastructure and applications. -The developer documentation provided here is continually kept up-to-date -based on the latest code, and may not represent the state of the project at -any specific prior release. +Monasca uses REST APIs for high-speed metrics, logs processing and querying. It +integrates a streaming alarm engine, a notification engine and an aggregation +engine. -.. note:: This is documentation for developers, if you are looking for more - general documentation including API, install, operator and user - guides see `docs.openstack.org`_ +The use cases you can implement with Monasca are very diverse. Monasca follows +a micro-services architecture, with several services split across multiple +repositories. Each module is designed to provide a discrete service in the +overall monitoring solution and can be deployed or omitted according to +operators/customers needs. -.. _`docs.openstack.org`: https://docs.openstack.org - -.. toctree:: - :maxdepth: 2 - - user/index - admin/index - install/index - configuration/index - cli/index - contributor/index +For Contributors +================ .. toctree:: :maxdepth: 1 - glossary + contributor/index +For Operators +================ + +Configuration +------------- + +* :doc:`Sample Config Files ` + +.. toctree:: + :hidden: + + admin/index + cli/index + configuration/sample + glossary + install/index + user/index