no developer documentation

Bug #1300990 reported by Ruby Loo
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
python-ironicclient
Fix Released
Low
Ruby Loo

Bug Description

There isn't any developer documentation. It would be nice to have something similar to
- python-novaclient (http://docs.openstack.org/developer/python-novaclient/), or
- python-keystoneclient (http://docs.openstack.org/developer/python-keystoneclient/), or
- python-glanceclient (http://docs.openstack.org/developer/python-glanceclient/)

Some description of:
- the python API (ironicclient modules)
- the ironic CLI
- contributing
- releases?

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-ironicclient (master)

Fix proposed to branch: master
Review: https://review.openstack.org/84545

Changed in python-ironicclient:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/85096

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/85107

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-ironicclient (master)

Reviewed: https://review.openstack.org/84545
Committed: https://git.openstack.org/cgit/openstack/python-ironicclient/commit/?id=ef49398f274c0988f5df9ad4d8f2f7cf5f446c68
Submitter: Jenkins
Branch: master

commit ef49398f274c0988f5df9ad4d8f2f7cf5f446c68
Author: Ruby Loo <email address hidden>
Date: Tue Apr 1 20:28:46 2014 +0000

    Add main developer page

    This adds the main ('index') page for developers (to be available
    at http://docs.openstack.org/developer/python-ironicclient/).
    It has minimal information, and is a place holder so that we can
    start adding documentation.

    This also fixes issues with 'python setup.py build_sphinx':
    - was getting "error: 'source_dir' must be a directory name"
      because sphinx 1.2b3 was being installed instead of 1.1.2
      (see https://bugs.launchpad.net/openstack-ci/+bug/1259511)
    - was getting "sphinx.errors.ExtensionError: Could not import
      extension oslo.sphinx (exception: No module named sphinx)"
    - was complaining about missing '_theme' (oslosphinx has the theme)

    Change-Id: I47ad7e10c20b80a99ae36755b2f7f67c080676fd
    Partial-Bug: #1300990

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-ironicclient (master)

Fix proposed to branch: master
Review: https://review.openstack.org/86127

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-ironicclient (master)

Reviewed: https://review.openstack.org/85096
Committed: https://git.openstack.org/cgit/openstack/python-ironicclient/commit/?id=dbc7d402186617f3c2adb43c61e207c297cbb6b9
Submitter: Jenkins
Branch: master

commit dbc7d402186617f3c2adb43c61e207c297cbb6b9
Author: Ruby Loo <email address hidden>
Date: Thu Apr 3 16:16:31 2014 +0000

    Documentation for contributors

    Adds documentation for contributors, which describes how to
    get started. It mentions licence agreement, launchpad ID, and
    includes links to project-related information.

    Change-Id: I47423c9f2cdfd708c8cb45d4284c5af16d598153
    Partial-Bug: #1300990

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/86127
Committed: https://git.openstack.org/cgit/openstack/python-ironicclient/commit/?id=5516fe0e8dc5a5ecbfd7c709cc49cc73c344afa5
Submitter: Jenkins
Branch: master

commit 5516fe0e8dc5a5ecbfd7c709cc49cc73c344afa5
Author: Ruby Loo <email address hidden>
Date: Tue Apr 8 19:14:04 2014 +0000

    Add documentation for ironic CLI

    Adds a short description about how to get started with the
    ironic CLI.

    Change-Id: I86247c36d9c3ce482dde009bef7e59fcdc493c64
    Partial-Bug: #1300990

Revision history for this message
Ruby Loo (rloo) wrote :

Need to add Jenkins and zuul jobs to generate the documentation: https://review.openstack.org/#/c/86390/

Revision history for this message
Openstack Gerrit (openstack-gerrit) wrote :

Reviewed: https://review.openstack.org/85107
Committed: https://git.openstack.org/cgit/openstack/python-ironicclient/commit/?id=2dedb46cfbc4f159b2e3b46a383e232023af0d3a
Submitter: Jenkins
Branch: master

commit 2dedb46cfbc4f159b2e3b46a383e232023af0d3a
Author: Ruby Loo <email address hidden>
Date: Thu Apr 3 16:49:31 2014 +0000

    Adds documentation for ironicclient API

    Adds some documentation on how to use the ironicclient API. Describes how
    to get a client object and has examples of a few ironic operations.
    The ironicclient modules are listed.

    Change-Id: Ic7c739fb5722b40c308b90c27178d937cad41028
    Partial-Bug: #1300990

Revision history for this message
Ruby Loo (rloo) wrote :

One last thing needed to be done before the documentation showed up at http://docs.openstack.org/developer/python-ironicclient/.

Because it is a client package, docs are only pushed to docs.openstack.org from docs-draft.openstack.org, when the package is released.

Changed in python-ironicclient:
status: In Progress → Fix Released
status: Fix Released → Fix Committed
Ruby Loo (rloo)
Changed in python-ironicclient:
importance: Undecided → Low
Changed in python-ironicclient:
milestone: none → 0.7.0
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

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