vitrage/README.rst
pangliye 0b16f2e933 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.

While at it, make intro more user-friendly and point to CONTRIBUTING.rst
instead of HACKING.rst for contributor guidance.

Change-Id: I1a7044ea10b94cdb25dfcc05d3b2b77d877c1dd5
2019-11-20 15:27:09 +08:00

25 lines
1.0 KiB
ReStructuredText

=================
OpenStack Vitrage
=================
.. image:: https://governance.openstack.org/tc/badges/vitrage.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
OpenStack Vitrage is the OpenStack RCA (Root Cause Analysis) Service for organizing, analyzing and expanding OpenStack alarms & events, yielding insights regarding the root cause of problems and deducing the existence of problems before they are directly detected.
Enabling Vitrage in DevStack
----------------------------
More details in: `README file <devstack/README.rst>`_
Project Resources
-----------------
* Project documentation: https://docs.openstack.org/vitrage/latest/
* Wiki page: https://wiki.openstack.org/wiki/Vitrage
* Source: https://opendev.org/openstack/vitrage
* StoryBoard: https://storyboard.openstack.org/#!/project/openstack/vitrage
* Release notes: https://docs.openstack.org/releasenotes/vitrage
* Design specifications: https://specs.openstack.org/openstack/vitrage-specs/