ironic-ui/doc/source/index.rst
Julia Kreger 8d6fcd819c Refactor ironic-ui documentation to remove warnings
Warnings, such as those caused by the README.rst file's
inclusion of an externally hosted file cause the default
sphinx job to fail. Removed the link, and cleaned up the
documentation formatting to make it more clear moving
forward.

Change-Id: I55afe786b794a6cb179a3de20b5f4e0f3f8072c8
2016-12-12 23:43:49 +00:00

34 lines
1.1 KiB
ReStructuredText

===============================================
Welcome to Ironic UI's developer documentation!
===============================================
Introduction
============
The ironic UI is an OpenStack Horizon plugin that will allow users to view and
manage their ironic bare metal nodes, ports and drivers.
The documentation provided here is continually kept up-to-date based
on the latest code that has been committed, and may not represent the state of
the project at any specific prior release.
For information on any current or prior version of Ironic, see `the release
notes`_.
.. _the release notes: http://docs.openstack.org/releasenotes/ironic-ui/
For more information on ironic, see `the ironic documentation`_.
.. _the ironic documentation: http://docs.openstack.org/developer/ironic/
Administrator's Guide
=====================
.. toctree::
:maxdepth: 1
Introduction to ironic <http://docs.openstack.org/developer/ironic/deploy/user-guide.html>
Installing the ironic UI <installation>
Contributing <contributing>
Release notes <http://docs.openstack.org/releasenotes/ironic-ui>