metalsmith/README.rst
Dmitry Tantsur be21ac731b Updates after becoming an official projects
* Build documentation on docs.openstack.org
* Add badges, update README
* Adjust docs subdirs to match the standards

Change-Id: Ie4f51f994ef783c4924a6523fbdfe600fede6d12
2018-09-21 14:09:39 +02:00

39 lines
1.2 KiB
ReStructuredText

Deployment and Scheduling tool for Bare Metal
=============================================
.. image:: https://governance.openstack.org/badges/metalsmith.svg
:target: https://governance.openstack.org/reference/tags/index.html
Overview
--------
This is a simple tool to provision bare metal machines using `OpenStack Bare
Metal Service (ironic) <https://docs.openstack.org/ironic/latest/>`_ and,
optionally, `OpenStack Image Service (glance)
<https://docs.openstack.org/glance/latest/>`_ and `OpenStack Networking
Service (neutron) <https://docs.openstack.org/neutron/latest/>`_.
* License: Apache License, Version 2.0
* Documentation: https://docs.openstack.org/metalsmith/
* Source: https://git.openstack.org/cgit/openstack/metalsmith
* Bugs: https://storyboard.openstack.org/#!/project/openstack/metalsmith
Installation
------------
::
pip install --user metalsmith
Contributing
------------
* Pull requests: `Gerrit
<https://review.openstack.org/#/q/project:openstack/metalsmith>`_
(see `developer's guide
<https://docs.openstack.org/infra/manual/developers.html>`_)
* Bugs and RFEs: `StoryBoard
<https://storyboard.openstack.org/#!/project/openstack/metalsmith>`_
(please do NOT report bugs to Github)