placement/README.rst
Q.hongtao 285686cbb5 Start README.rst with a better title
Now that we are using gitea the contents of our README.rst are
more prominently displayed. Starting it with a "Team and repository
tags" title is a bit confusing. This change makes it start with the
name of the project instead.

Change-Id: Iaf5d00a35f7991df8a4616790a3898a61090abf2
2019-11-28 09:58:34 +08:00

56 lines
1.8 KiB
ReStructuredText

If you are viewing this README on GitHub, please be aware that placement
development happens on `OpenStack git
<https://opendev.org/openstack/placement/>`_ and `OpenStack
gerrit <https://review.opendev.org>`_.
===================
OpenStack Placement
===================
.. image:: https://governance.openstack.org/tc/badges/placement.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
OpenStack Placement provides an HTTP service for managing, selecting,
and claiming providers of classes of inventory representing available
resources in a cloud.
API
---
To learn how to use Placement's API, consult the documentation available
online at:
- `Placement API Reference <https://docs.openstack.org/api-ref/placement/>`__
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
- `OpenStack for App Developers <https://www.openstack.org/appdev/>`__
- `Development resources for OpenStack clouds
<https://developer.openstack.org/>`__
Operators
---------
To learn how to deploy and configure OpenStack Placement, consult the
documentation available online at:
- `OpenStack Placement <https://docs.openstack.org/placement/>`__
In the unfortunate event that bugs are discovered, they should be reported to
the appropriate bug tracker. If you obtained the software from a 3rd party
operating system vendor, it is often wise to use their own bug tracker for
reporting problems. In all other cases use the master OpenStack bug tracker,
available at:
- `Bug Tracker <https://storyboard.openstack.org/#!/project/openstack/placement>`__
Developers
----------
For information on how to contribute to Placement, please see the contents of
CONTRIBUTING.rst.
Further developer focused documentation is available at:
- `Official Placement Documentation <https://docs.openstack.org/placement/>`__