pycadf documentation

add basic documentation on CADF spec.

Closes-Bug: #1279951
Change-Id: Ie1703d9b5109d8275377857e5362e3b09385f647
Implements: blueprint document-pycadf

1 files changed, 61 insertions, 0 deletions

diff --git a/doc/source/index.rst b/doc/source/index.rst
new file mode 100644
index 0000000..a72e1a9
--- /dev/null
+++ b/doc/source/index.rst
@@ -0,0 +1,61 @@
+..
+      Copyright 2014 IBM Corp.
+
+      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.
+
+===============================
+ PyCADF developer documentation
+===============================
+
+The `CADF (Cloud Audit Data Federation Working Group)`_ is working to develop
+open standards for audit data which can be federated from cloud providers,
+with the intent to elevate customer’s trust in cloud hosted applications.
+
+Specifications and profiles produced by the CADF will help protect the
+investments of companies seeking to move their applications to cloud
+deployment models and preserve their ability to audit operational processes,
+regardless of their chosen cloud provider. The CADF develops specifications
+for audit event data and interface models and a compatible interaction model
+that will describe interactions between IT resources for cloud deployment models.
+
+pyCADF is the python implementation of the CADF specification
+
+This documentation offers information on how CADF works and how to
+contribute to the project.
+
+.. _CADF (Cloud Audit Data Federation Working Group): http://www.dmtf.org/standards/cadf
+
+Table of contents
+=================
+
+.. toctree::
+   :maxdepth: 2
+
+   api/index
+   specification/index
+   event_concept
+   middleware
+
+.. update index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+To Do
+=====
+
+.. todolist::