need to publish developer documentation

Bug #1279951 reported by Doug Hellmann
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
oslo-incubator
Fix Released
Medium
Unassigned
pycadf
Fix Released
Medium
gordon chung
taskflow
Fix Released
High
Ivan Melnikov

Bug Description

We need some developer documentation for the library, similar to http://docs.openstack.org/developer/oslo.messaging/, and then add a link to http://docs.openstack.org/developer/openstack-projects.html

Joshua Harlow (harlowja)
Changed in taskflow:
assignee: nobody → Ivan Melnikov (imelnikov)
importance: Undecided → High
Revision history for this message
Ivan Melnikov (imelnikov) wrote :

First step I think is https://review.openstack.org/73409 , which cleans up our sphinx documentation and makes use of oslo.sphinx

Revision history for this message
Doug Hellmann (doug-hellmann) wrote :

We don't have a separate project for oslo.version, but that library needs to be added, too.

Changed in pycadf:
importance: Undecided → Medium
status: New → Triaged
Changed in oslo:
importance: Undecided → Medium
status: New → Triaged
tags: added: documentation easy
Changed in taskflow:
status: New → In Progress
Revision history for this message
Ivan Melnikov (imelnikov) wrote :

For TaskFlow, we got https://review.openstack.org/73409 merged. The next step, as far as I understand, is adding documentation jobs to CI: https://review.openstack.org/74837

Changed in taskflow:
status: In Progress → Fix Committed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to pycadf (master)

Reviewed: https://review.openstack.org/65139
Committed: https://git.openstack.org/cgit/openstack/pycadf/commit/?id=1d5428afa7c4442762737fdca8bad3d533f5e275
Submitter: Jenkins
Branch: master

commit 1d5428afa7c4442762737fdca8bad3d533f5e275
Author: Gordon Chung <email address hidden>
Date: Mon Jan 6 14:52:17 2014 -0500

    pycadf documentation

    add basic documentation on CADF spec.

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

Changed in pycadf:
status: Triaged → Fix Committed
Revision history for this message
gordon chung (chungg) wrote :

docs included in pycadf 0.5

Changed in pycadf:
assignee: nobody → gordon chung (chungg)
status: Fix Committed → Fix Released
Changed in taskflow:
status: Fix Committed → Fix Released
Revision history for this message
Doug Hellmann (doug-hellmann) wrote :

The incubator is documented at http://docs.openstack.org/developer/oslo-incubator/ and oslo.version isn't actually used so we don't need to worry about it for now.

Changed in oslo:
status: Triaged → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/openstack-manuals 15.0.0

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Related blueprints

Remote bug watches

Bug watches keep track of this bug in other bug trackers.