Merge "move developer docs under contributor"

This commit is contained in:
Jenkins 2017-07-13 17:53:05 +00:00 committed by Gerrit Code Review
commit 2f7240ffed
17 changed files with 74 additions and 43 deletions

View File

@ -0,0 +1,65 @@
..
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
api/index
.. update index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -1,5 +1,6 @@
..
Copyright 2012 Nicolas Barcet for Canonical
Copyright 2010 OpenStack Foundation
All Rights Reserved.
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
@ -13,55 +14,20 @@
License for the specific language governing permissions and limitations
under the License.
============================================
Welcome to the Aodh developer documentation!
============================================
==================================
Welcome to Aodh's 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
========
The Alarming service (aodh) project provides a service that enables the ability
to trigger actions based on defined rules against metric or event data
collected by Ceilometer or Gnocchi.
.. toctree::
:maxdepth: 2
architecture
webapi/index
Developer Documentation
=======================
.. toctree::
:maxdepth: 2
install/index
configuration
testing
contributing
event-alarm
Appendix
========
contributor/index
.. toctree::
:maxdepth: 1
releasenotes/index
glossary
api/index
.. update index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`