openstack/diskimage-builder
Code Issues Proposed changes
diskimage-builder/doc/source/developer/index.rst
Ian Wienand 78c0766bec Produce API documentation 
There's an increasing amount of pydoc based documentation.  Output the
module reference and link it into the developers main page.

One fixup to the rst needed

Change-Id: I1d43a1fe1c735eb4559e3d2b40834d1c8115c586
2017-05-25 14:26:31 +10:00

1.2 KiB
Raw Blame History

Developer Guide

design components invocation caches developing_elements dib_lint stable_interfaces

This documentation explains how to get started with creating your own disk-image-builder elements as well as some high level concepts for element creation.

Quickstart

To get started developing with diskimage-builder, install to a virtualenv:

$ mkdir dib
$ cd dib
$ virtualenv env
$ source env/bin/activate
$ git clone https://git.openstack.org/openstack/diskimage-builder
$ cd diskimage-builder
$ pip install -e .

You can now simply use disk-image-create to start building images and testing your changes. When you are done editing, use git review to submit changes to the upstream gerrit.

Python module documentation

For internal documentation on the DIB python components, see the modindex

Finding Work

We maintain a list of low-hanging-fruit tags on launchpad: