Ruby Loo 1bd81b9699 [doc] update ironic's landing page

This updates ironic's landing page https://docs.openstack.org/ironic/latest/
so that:
- it isn't only for developer documentation
- the sections are reordered to better reflect the order of information
  from new user to experienced developer
- a user guide entry was added (since there is user documentation)
- the releasenotes/index.rst was removed since it was a placeholder to
  redirect links to new locations. Due to the doc migrations, that original
  URL doesn't exist anymore anyway, so this page should not be bookmarked
  so we don't need to keep it
- the section names are more consistent
- the User Guide and Administrator Guide sections have links to subsections
- removed a link to <api/index>, which doesn't exist

Change-Id: I413048526f96a8c11eb7da365b935f617307de10

2017-07-24 14:05:26 -04:00

2.3 KiB

Raw Blame History

Welcome to Ironic's documentation!

Introduction

Ironic is an OpenStack project which provisions bare metal (as opposed to virtual) machines. It may be used independently or as part of an OpenStack Cloud, and integrates with the OpenStack Identity (keystone), Compute (nova), Network (neutron), Image (glance), and Object (swift) services.

The Bare Metal service manages hardware through both common (eg. PXE and IPMI) and vendor-specific remote management protocols. It provides the cloud operator with a unified interface to a heterogeneous fleet of servers while also providing the Compute service with an interface that allows physical servers to be managed as though they were virtual machines.

This documentation is continually updated and may not represent the state of the project at any specific prior release. To access documentation for a previous release of ironic, append the OpenStack release name to the URL; for example, the ocata release is available at http://docs.openstack.org/ironic/ocata/.

User Guide

user/index

Administrator Guide

admin/index

Driver References

Every driver author is expected to document the use and configuration of their driver. These pages are linked below.

Driver Documentation pages <admin/drivers> Further Considerations for the Agent Drivers <admin/drivers/ipa>

Bare Metal API References

Ironic's REST API has changed since its first release, and continues to evolve to meet the changing needs of the community. Here we provide a conceptual guide as well as more detailed reference documentation.

API Concept Guide <contributor/webapi> API Reference (latest) <http://developer.openstack.org/api-ref/baremetal/> API Version History <contributor/webapi-version-history>

Command References

Here are references for commands not elsewhere documented.

cli/index

Contributor Guide

contributor/index

Indices and tables

genindex
search

2.3 KiB Raw Blame History