c6b6f269cc
Prior to this, no user documentation of dib-lint existed, which meant users had to read the dib-lint code itself to figure out how it worked. This changes adds documentation on using dib-lint and the checks it currently supports. Change-Id: I285c5cc680dd9fbd9bd3f667ef102be14e248114
37 lines
822 B
ReStructuredText
37 lines
822 B
ReStructuredText
Developer Documentation
|
|
=======================
|
|
|
|
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 create 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.
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
design
|
|
components
|
|
invocation
|
|
caches
|
|
developing_elements
|
|
dib_lint
|
|
stable_interfaces
|