openstack/cinder
Code Issues Proposed changes

Start README.rst with a better title

Browse Source 
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: I4a93073447b0479b81dbcc877b4fd6b5d15a6a01
This commit is contained in:
Thierry Carrez 2019-11-19 17:46:53 +01:00
parent 6b0624f4d3
commit 139ff1dfcd
1 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.rst
View File

@ -1,18 +1,15 @@
========================
Team and repository tags
========================
================
OpenStack Cinder
================
.. image:: https://governance.openstack.org/tc/badges/cinder.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
======
CINDER
======
OpenStack Cinder is a storage service for an open cloud computing service.
You have come across a storage service for an open cloud computing service.
It has identified itself as `Cinder`. It was abstracted from the Nova project.
You can learn more about Cinder at:
* Wiki: https://wiki.openstack.org/Cinder
* Developer docs: https://docs.openstack.org/cinder/latest/
@ -27,8 +24,8 @@ If you'd like to run from the master branch, you can clone the git repo:
git clone https://opendev.org/openstack/cinder
For developer information please see
`HACKING.rst <https://opendev.org/openstack/cinder/src/branch/master/HACKING.rst>`_
If you'd like to contribute, please see the information in
`CONTRIBUTING.rst <https://opendev.org/openstack/cinder/src/branch/master/CONTRIBUTING.rst>`_
You can raise bugs here https://bugs.launchpad.net/cinder