aodh/doc/source/index.rst
liusheng ba275d3925 Add documentation about event alarm
The usage and configuration of event alarm functionality is missing.

Change-Id: I9938069f6cb8e27fb9e1ee7663f722dacb0368f6
Signed-off-by: liusheng <liusheng@huawei.com>
2016-04-25 09:48:02 +08:00

68 lines
1.4 KiB
ReStructuredText

..
Copyright 2012 Nicolas Barcet for Canonical
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
============================================
Welcome to the Aodh developer documentation!
============================================
What is the purpose of the project and vision for it?
=====================================================
* Provide alarms and notifications based on metrics.
This documentation offers information on how Aodh works and how to contribute
to the project.
Overview
========
.. toctree::
:maxdepth: 2
architecture
webapi/index
Developer Documentation
=======================
.. toctree::
:maxdepth: 2
install/index
configuration
testing
contributing
event-alarm
Appendix
========
.. toctree::
:maxdepth: 1
releasenotes/index
glossary
api/index
.. update index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`