From b6149c798a329179de7f051f6cf99aad4275a184 Mon Sep 17 00:00:00 2001 From: Thierry Carrez Date: Wed, 13 Nov 2019 16:51:02 +0100 Subject: [PATCH] Update README.rst for better looks Now that we use gitea, our README.rst is more visble and should be made a decent entry point to the marvelous world of release management. This change make it look better, clearer, and updates links. Change-Id: If331975e16e9d60b9839491354679d9c1a027217 --- README.rst | 47 +++++++++++++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 18 deletions(-) diff --git a/README.rst b/README.rst index c3b2cc92df..cb31860ea3 100644 --- a/README.rst +++ b/README.rst @@ -1,28 +1,39 @@ -======================= - Using This Repository -======================= +==================== + OpenStack Releases +==================== -All official OpenStack software should go through the +.. image:: https://governance.openstack.org/tc/badges/releases.svg + :target: https://governance.openstack.org/tc/reference/tags/index.html + +This repository is used to drive release automation for OpenStack release +deliverables, ultimately publishing them on the https://releases.openstack.org/ +website. + +Changes to this repository are proposed using Gerrit at +https://review.opendev.org. This repository is managed by the OpenStack +`Release Management team +`_. + +For more information on how to use this repository, please read our +`reference documentation `_. + +Who should use this repository +------------------------------ + +All official OpenStack software should go through the OpenStack `Release Management team `_ team to produce releases. Exceptions to this rule are granted by the Technical Committee and documented in the openstack/governance repository ('release-management' key in reference/projects.yaml). -This repository is used to track release requests. Releases are managed -using groups of "deliverables", made up of individual project repositories -sharing a Launchpad group and a version number history. Many deliverables -will only have one constituent project repository. - -The repository is managed by the `Release Management team -`_. - -.. image:: https://governance.openstack.org/tc/badges/releases.svg - :target: https://governance.openstack.org/tc/reference/tags/index.html - -Refer to `the reference documentation -`_ for more details - Deliverables managed by teams not under OpenStack governance should follow the `tagging instructions in the infra manual `__. + +More information +---------------- + +You can reach the Release Management team on the #openstack-release channel +on Freenode IRC, or by sending an email with '[release]' as a subject prefix +to the `openstack-discuss `_ mailing-list.