From bc16dd747ae89e6b1ecc2d1345c8ce32df8ff2d1 Mon Sep 17 00:00:00 2001 From: gord chung Date: Wed, 21 Jun 2017 18:50:20 +0000 Subject: [PATCH] move developer docs under contributor - drop _template since there's nothing Change-Id: I850eda1d7b3e729f5d68562f469ecdfa1ce162a0 --- doc/source/_templates/.placeholder | 0 doc/source/{api/index.rst => contributor/api} | 0 doc/source/{ => contributor}/architecture.rst | 0 .../{ => contributor}/configuration.rst | 0 doc/source/{ => contributor}/contributing.rst | 0 doc/source/{ => contributor}/event-alarm.rst | 0 doc/source/contributor/index.rst | 65 +++++++++++++++++++ .../{ => contributor}/install/development.rst | 0 .../{ => contributor}/install/index.rst | 0 .../{ => contributor}/install/manual.rst | 0 .../{ => contributor}/install/mod_wsgi.rst | 0 .../{ => contributor}/install/uwsgi.rst | 0 .../{ => contributor}/releasenotes/index.rst | 0 doc/source/{ => contributor}/testing.rst | 0 doc/source/{ => contributor}/webapi/index.rst | 0 doc/source/{ => contributor}/webapi/v2.rst | 0 doc/source/index.rst | 52 +++------------ 17 files changed, 74 insertions(+), 43 deletions(-) delete mode 100644 doc/source/_templates/.placeholder rename doc/source/{api/index.rst => contributor/api} (100%) rename doc/source/{ => contributor}/architecture.rst (100%) rename doc/source/{ => contributor}/configuration.rst (100%) rename doc/source/{ => contributor}/contributing.rst (100%) rename doc/source/{ => contributor}/event-alarm.rst (100%) create mode 100644 doc/source/contributor/index.rst rename doc/source/{ => contributor}/install/development.rst (100%) rename doc/source/{ => contributor}/install/index.rst (100%) rename doc/source/{ => contributor}/install/manual.rst (100%) rename doc/source/{ => contributor}/install/mod_wsgi.rst (100%) rename doc/source/{ => contributor}/install/uwsgi.rst (100%) rename doc/source/{ => contributor}/releasenotes/index.rst (100%) rename doc/source/{ => contributor}/testing.rst (100%) rename doc/source/{ => contributor}/webapi/index.rst (100%) rename doc/source/{ => contributor}/webapi/v2.rst (100%) diff --git a/doc/source/_templates/.placeholder b/doc/source/_templates/.placeholder deleted file mode 100644 index e69de29bb..000000000 diff --git a/doc/source/api/index.rst b/doc/source/contributor/api similarity index 100% rename from doc/source/api/index.rst rename to doc/source/contributor/api diff --git a/doc/source/architecture.rst b/doc/source/contributor/architecture.rst similarity index 100% rename from doc/source/architecture.rst rename to doc/source/contributor/architecture.rst diff --git a/doc/source/configuration.rst b/doc/source/contributor/configuration.rst similarity index 100% rename from doc/source/configuration.rst rename to doc/source/contributor/configuration.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst similarity index 100% rename from doc/source/contributing.rst rename to doc/source/contributor/contributing.rst diff --git a/doc/source/event-alarm.rst b/doc/source/contributor/event-alarm.rst similarity index 100% rename from doc/source/event-alarm.rst rename to doc/source/contributor/event-alarm.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..f9f54bfc0 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -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` diff --git a/doc/source/install/development.rst b/doc/source/contributor/install/development.rst similarity index 100% rename from doc/source/install/development.rst rename to doc/source/contributor/install/development.rst diff --git a/doc/source/install/index.rst b/doc/source/contributor/install/index.rst similarity index 100% rename from doc/source/install/index.rst rename to doc/source/contributor/install/index.rst diff --git a/doc/source/install/manual.rst b/doc/source/contributor/install/manual.rst similarity index 100% rename from doc/source/install/manual.rst rename to doc/source/contributor/install/manual.rst diff --git a/doc/source/install/mod_wsgi.rst b/doc/source/contributor/install/mod_wsgi.rst similarity index 100% rename from doc/source/install/mod_wsgi.rst rename to doc/source/contributor/install/mod_wsgi.rst diff --git a/doc/source/install/uwsgi.rst b/doc/source/contributor/install/uwsgi.rst similarity index 100% rename from doc/source/install/uwsgi.rst rename to doc/source/contributor/install/uwsgi.rst diff --git a/doc/source/releasenotes/index.rst b/doc/source/contributor/releasenotes/index.rst similarity index 100% rename from doc/source/releasenotes/index.rst rename to doc/source/contributor/releasenotes/index.rst diff --git a/doc/source/testing.rst b/doc/source/contributor/testing.rst similarity index 100% rename from doc/source/testing.rst rename to doc/source/contributor/testing.rst diff --git a/doc/source/webapi/index.rst b/doc/source/contributor/webapi/index.rst similarity index 100% rename from doc/source/webapi/index.rst rename to doc/source/contributor/webapi/index.rst diff --git a/doc/source/webapi/v2.rst b/doc/source/contributor/webapi/v2.rst similarity index 100% rename from doc/source/webapi/v2.rst rename to doc/source/contributor/webapi/v2.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index f201b690c..a299f68ff 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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`