d0e49e1b41
This patch contains several changes to the documentation which were brought about by, initially, removing the webapi/v1 page and replacing it with a link to the /api-ref/ page. As I did that, I saw that our front page (index.html) needed to be updated as well, and decided that the front page needed to actually be completely rerwitten -- while preserving all the links. Some of the TOC links from the front page were malformed because subpages included more than one H1 heading, so I had to make small changes in the api-audit-support and code-contribution-guide and dev-quickstart pages, in order for the front page to render properly. As I corrected the headings on dev-quickstart, I realized the page was not comprehensively organized, and so decided to reorganize the sections and make it easier to navigate. Here is a bullet-point summary of this change: * Major changes to content and organization of index page * Moved the version history from webapi/v1 to dev/webapi-version-history * Added API conceptual guide at dev/webapi * Replaced webapi/v1 with a link to dev/webapi, in case anyone bookmarked it * Removed doc references to webapi/v1 * Merged the pages dev/contributing and dev/code-contribution-guide * Removed duplicate H1 headers in deploy/api-audit-support * Reorganized and renamed section headers in dev/dev-quickstart, and made some substantive corrections and changes as well * Updated wording at the top of the index and deploy/user-guide pages. Change-Id: Ib418e1d4fdfab4f0e15560270f39922e33df3f12
30 lines
1.1 KiB
ReStructuredText
30 lines
1.1 KiB
ReStructuredText
======
|
|
Ironic
|
|
======
|
|
|
|
Ironic consists of an API and plug-ins for managing and provisioning
|
|
physical machines in a security-aware and fault-tolerant manner. It can be
|
|
used with nova as a hypervisor driver, or standalone service using bifrost.
|
|
By default, it will use PXE and IPMI to interact with bare metal machines.
|
|
Ironic also supports vendor-specific plug-ins which may implement additional
|
|
functionality.
|
|
|
|
Ironic is distributed under the terms of the Apache License, Version 2.0. The
|
|
full terms and conditions of this license are detailed in the LICENSE file.
|
|
|
|
Project resources
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
* Documentation: http://docs.openstack.org/developer/ironic
|
|
* Source: http://git.openstack.org/cgit/openstack/ironic
|
|
* Bugs: http://bugs.launchpad.net/ironic
|
|
* Wiki: https://wiki.openstack.org/wiki/Ironic
|
|
* APIs: http://developer.openstack.org/api-ref/baremetal/index.html
|
|
|
|
Project status, bugs, and requests for feature enhancements (RFEs) are tracked
|
|
on Launchpad:
|
|
http://launchpad.net/ironic
|
|
|
|
For information on how to contribute to ironic, see
|
|
http://docs.openstack.org/developer/ironic/dev/code-contribution-guide.html
|