Commit Graph

11 Commits

Author SHA1 Message Date
Ian Wienand
5bae00db0c Make README.rst a bit more generic
I think diskimage-builder has grown somewhat since this was written,
and this makes it sound like it is only useful as a TripleO component.

Give a more generic overview, add a simple example to illustrate the
point and generally make it clear this is a flexible solution for
building disk images.  Add a mention of the local documentation
source.

Change-Id: I74f13ccc1e3fe50ac907efcc7f479e59fe44455c
2015-09-16 13:52:43 +10:00
Antoine Musso
f22a5a8b91 doc: migrate from README.rst to Sphinx
The README.rst has a lot of information that has been duplicated in the
Sphinx maintained documentation (3600330).

Remove dupes from README.rst
Point to http://docs.openstack.org/developer/diskimage-builder/

Change summary:

=====================+======================================
README.md            | Sphinx document
section              |
=====================+======================================
Installation         | installation.rst
---------------------+--------------------------------------
Invocation           | invocation.rst
---------------------+--------------------------------------
Requirements         | installation.rst Speedups
---------------------+--------------------------------------
Caches/offline       | caches.rst + changes from 849e9cb2
                     | fix some markup
---------------------+--------------------------------------
Install Types        | install_types.rst
---------------------+--------------------------------------
Writing an element   | developing_elements.rst + fe7823a2
                     | `Testing element` from b9b6640f
                     | `3rd party elements' from f1e7bf3a
---------------------+--------------------------------------
Existing elements    | elements.rst
---------------------+--------------------------------------
What tools are there | components.rst
---------------------+--------------------------------------
Design               | design.rst
---------------------+--------------------------------------

Change-Id: I578daa8e3a8d876b3ee3c9a748d7c8aa2bf7a0b7
2015-09-10 16:55:39 +10:00
Junya Akahira
4211822978 Fix a typo in README.rst
Change-Id: If38d147a9521de0e599f10a3e336000373ad1efa
2015-08-24 17:33:26 +09:00
Gregory Haynes
8cf37064a5 Remove deprecated disk-image-get-kernel
This script has been deprecated in favor of the baremetal element for
some time. Lets remove it.

Change-Id: Idd7db766a039ba8e74f0e98e74eb27246e753f4b
2015-07-06 16:44:07 +00:00
Gregory Haynes
8266e14adc Add functional smoke test for disk-image-create
We do not have any testing inside DIB for testing disk-image-create
logic. Lets do some smoke testing for all our supported image formats.

Also adding a run_functests.sh so we can extend this later without editing
the jenkins job.

Change-Id: Ie491e27f00bde54f73af6b47c9696ec04d973b14
2015-04-24 16:37:29 +00:00
Jenkins
451aa827d1 Merge "Add a link to the "Writing an element" section" 2015-03-12 02:15:30 +00:00
Jenkins
d18184c836 Merge "Updated readme" 2015-02-25 23:08:43 +00:00
Abel Lopez
f1e7bf3ab4 Updated readme
The section on third party elements was old and wrong.

Change-Id: If401f294bf15364cadff7c02cb3b81e9ac6224b3
2015-02-24 11:07:00 -08:00
James Polley
849e9cb2c2 Add a link to the "Writing an element" section
Instead of telling the reader to find a section of the current doc,
provide a link.

Change-Id: I0746f02ab5a051c04829d28f1d55df6b1823437b
2015-02-18 16:16:36 -08:00
stephane
fe7823a249 Add documentation of DIB_IMAGE_CACHE variable
It is an established convention to use DIB_IMAGE_CACHE in elements to
refer to the cache location. This convention has not been documented
in the README, unlike other element development practices. This change
adds documentation for DIB_IMAGE_CACHE both from an element user and
developer perspective.

This change was prompted by I76030654e7dfc7b7d4dfa87e082c14e7cee479b9

Change-Id: I6fcc2409450cdb45e5afcb292908fbaee1af258a
2015-02-15 19:13:53 +00:00
Gregory Haynes
c4bbb6f3bc Create docs site containing element READMEs
We currently do not have the ability to create a docs site which
outlines all the elements.

Change-Id: I77ccf61e0c4b1509b3e7ce9b8f15ea5ccfd50d9b
2015-02-10 11:45:35 -08:00