From 8180e64c380d9693615db8295afac8502177aff6 Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Sat, 7 Mar 2015 13:45:29 -0500 Subject: Clean up pycadf's doc landing page - the end of the intro paragraph came to an unexpected stop, so clean that up. - suggest removing the debugging section, as that is now maintained by oslotest: http://docs.openstack.org/developer/oslotest/features.html - add more info to the contributing section, since it was lacking before. Change-Id: I7abd5b0ce192f18fa80a208ac5b191d1c7bd2981 --- doc/source/index.rst | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) (limited to 'doc/source/index.rst') 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 ================== -- cgit v1.2.1