Update docs structure according to new guidelines in https://wiki.opnfv.org/display/DOC

[doctor.git] / docs / development / requirements / index.rst

diff --git a/docs/development/requirements/index.rst b/docs/development/requirements/index.rst
new file mode 100644 (file)
index 0000000..fcbfb88
--- /dev/null
+++ b/docs/development/requirements/index.rst
@@ -0,0 +1,62 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+****************************************
+Doctor: Fault Management and Maintenance
+****************************************
+
+:Project: Doctor, https://wiki.opnfv.org/doctor
+:Editors: Ashiq Khan (NTT DOCOMO), Gerald Kunzmann (NTT DOCOMO)
+:Authors: Ryota Mibu (NEC), Carlos Goncalves (NEC), Tomi Juvonen (Nokia),
+          Tommy Lindgren (Ericsson), Bertrand Souville (NTT DOCOMO),
+          Balazs Gibizer (Ericsson), Ildiko Vancsa (Ericsson) and others.
+
+:Abstract: Doctor is an OPNFV requirement project [DOCT]_. Its scope is NFVI
+           fault management, and maintenance and it aims at developing and
+           realizing the consequent implementation for the OPNFV reference
+           platform.
+
+           This deliverable is introducing the use cases and operational
+           scenarios for Fault Management considered in the Doctor project.
+           From the general features, a high level architecture describing
+           logical building blocks and interfaces is derived. Finally,
+           a detailed implementation is introduced, based on available open
+           source components, and a related gap analysis is done as part of
+           this project. The implementation plan finally discusses an initial
+           realization for a NFVI fault management and maintenance solution in
+           open source software.
+
+:History:
+
+          ========== =====================================================
+          Date       Description
+          ========== =====================================================
+          02.12.2014 Project creation
+          14.04.2015 Initial version of the deliverable uploaded to Gerrit
+          18.05.2015 Stable version of the Doctor deliverable
+          25.02.2016 Updated version for the Brahmaputra release
+          26.09.2016 Updated version for the Colorado release
+          xx.xx.2017 Updated version for the Danube release
+          ========== =====================================================
+
+.. raw:: latex
+
+    \newpage
+
+.. include::
+    glossary.rst
+
+.. toctree::
+    :maxdepth: 4
+    :numbered:
+
+    01-intro.rst
+    02-use_cases.rst
+    03-architecture.rst
+    04-gaps.rst
+    05-implementation.rst
+    06-summary.rst
+    07-annex.rst
+
+.. include::
+    99-references.rst