Merge "Clean up pycadf's doc landing page"

3 files changed, 19 insertions, 79 deletions

diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
deleted file mode 100644
index b34ecd0..0000000
--- a/doc/source/contributing.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-..
-      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.
-
-.. _contributing:
-
-=============
- Contributing
-=============
-
-Contributions to the pyCADF library are welcomed.
-
-Important links:
-
-1. `Github repository`_
-
-2. `Launchpad project`_
-
-.. _Github repository: https://github.com/openstack/pycadf
-.. _Launchpad project: https://launchpad.net/pycadf
diff --git a/doc/source/debugging.rst b/doc/source/debugging.rst
deleted file mode 100644
index 3aca00b..0000000
--- a/doc/source/debugging.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-..
-      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.
-
-.. _debugging:
-
-===================
- Debugging with PDB
-===================
-
-Using PDB breakpoints with tox and testr normally doesn't work since the tests
-just fail with a BdbQuit exception rather than stopping at the breakpoint.
-
-To run with PDB breakpoints during testing, use the ``debug`` tox environment
-rather than ``py27``. Here's an example, passing the name of a test since
-you'll normally only want to run the test that hits your breakpoint::
-
-    $ tox -e debug pycadf.tests.test_cadf_spec
-
-For reference, the ``debug`` tox environment implements the instructions
-here: https://wiki.openstack.org/wiki/Testr#Debugging_.28pdb.29_Tests
-The pyCADF library provides a tox environment that enables pdb based
-debugging of test cases.
-
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 5f2ba36..d27630b 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -19,7 +19,7 @@
 
 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.
+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
@@ -28,10 +28,8 @@ 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.
+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
 
@@ -45,14 +43,22 @@ Getting Started
     specification/index
     middleware
 
-Developer Documentation
-=======================
-
-.. toctree::
-    :maxdepth: 1
-
-    contributing
-    debugging
+Contributing
+============
+
+pyCADF utilizes all of the usual OpenStack processes and requirements for
+contributions. The code is hosted `on OpenStack's Git server`_. `Bug reports`_
+and `blueprints`_ may be submitted to the :code:`pycadf` project on
+`Launchpad`_.  Code may be submitted to the :code:`openstack/pycadf` project
+using `Gerrit`_.
+
+.. _`on OpenStack's Git server`: https://git.openstack.org/cgit/openstack/pycadf/tree
+.. _Launchpad: https://launchpad.net/pycadf
+.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
+.. _Bug reports: https://bugs.launchpad.net/pycadf/+bugs
+.. _blueprints: https://blueprints.launchpad.net/pycadf
+.. _PyPi: https://pypi.python.org/pypi/pycadf
+.. _tarball: http://tarballs.openstack.org/pycadf
 
 Code Documentation
 ==================