glance/README.rst
Thierry Carrez 35d9ec3f59 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: I538c8db4b45eb3f65dfe48f0c3ce006a8dfee4df
2019-11-13 17:03:44 +01:00

83 lines
2.6 KiB
ReStructuredText

================
OpenStack Glance
================
.. image:: https://governance.openstack.org/tc/badges/glance.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
:alt: The following tags have been asserted for the Glance project:
"project:official",
"tc:approved-release",
"stable:follows-policy",
"tc:starter-kit:compute",
"vulnerability:managed",
"assert:supports-upgrade",
"assert:follows-standard-deprecation".
Follow the link for an explanation of these tags.
.. NOTE(rosmaita): the alt text above will have to be updated when
additional tags are asserted for Glance. (The SVG in the
governance repo is updated automatically.)
.. Change things from this point on
Glance is an OpenStack project that provides services and associated libraries
to store, browse, share, distribute and manage bootable disk images,
other data closely associated with initializing compute resources,
and metadata definitions.
Use the following resources to learn more:
API
---
To learn how to use Glance's API, consult the documentation available
online at:
* `Image Service APIs <https://docs.openstack.org/api-ref/image/>`_
Developers
----------
For information on how to contribute to Glance, please see the contents
of the CONTRIBUTING.rst in this repository.
Any new code must follow the development guidelines detailed in the
HACKING.rst file, and pass all unit tests.
Further developer focused documentation is available at:
* `Official Glance documentation <https://docs.openstack.org/glance/latest/>`_
* `Official Client documentation <https://docs.openstack.org/python-glanceclient/latest/>`_
Operators
---------
To learn how to deploy and configure OpenStack Glance, consult the
documentation available online at:
* `Openstack Glance <https://docs.openstack.org/glance/latest/>`_
In the unfortunate event that bugs are discovered, they should be
reported to the appropriate bug tracker. You can raise bugs here:
* `Bug Tracker <https://bugs.launchpad.net/glance/>`_
Release notes
-------------
To learn more about Glance's new features, optimizations, and changes
between versions, consult the release notes online at:
* `Release Notes <https://docs.openstack.org/releasenotes/glance/>`__
Other Information
-----------------
During each design summit, we agree on what the whole community wants
to focus on for the upcoming release. You can see image service plans:
* `Image Service Plans <https://specs.openstack.org/openstack/glance-specs/>`_
For more information about the Glance project please see:
* `Glance Project <https://launchpad.net/glance/>`_