openstack
/
openstack
Code Issues Proposed changes

Give general OpenStack info in the README 

Some newcomers sometimes browse gitea or GitHub to learn about
OpenStack and naturally open the openstack/openstack repository,
only to find a confusing and pretty technical explanation about
submodule tracking and the subtleties of tested combinations of
components.

Provide some general information about OpenStack first, to
redirect those lose souls to friendler shores.

Change-Id: I41cde655f6c5d08fc482c40953687570acd59d3f
This commit is contained in:
Thierry Carrez 2020-07-15 15:46:42 +02:00
parent 6d8871ac39
commit 992416c8ad
1 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.rst
View File

@ -1,11 +1,32 @@
OpenStack Tracking Repo
=======================
OpenStack
=========
zuul gates all of the contained projects in an effective single
timeline. This means that OpenStack, across all of the projects, does
already have a sequence of combinations that have been explicitly
tested, but it's non-trivial to go from a single commit of a particular
project to the commits that were tested with it.
OpenStack is a collection of interoperable components that can be deployed
to provide computing, networking and storage resources. Those infrastructure
resources can then be accessed by end users through programmable APIs.
This repository just represents OpenStack as a collection of git submodules.
You can find the repositories for individual components at:
https://opendev.org/openstack
You can learn more about the various components in OpenStack at:
https://openstack.org/software
To learn more about how to contribute to OpenStack, please head to our
Contributor portal: https://www.openstack.org/community/
To learn more about how OpenStack is governed, you can visit:
https://governance.openstack.org/
Why this repository ?
---------------------
Our continuous integration system, Zuul, gates all of the contained projects
in an effective single timeline. This means that OpenStack, across all of the
projects, does already have a sequence of combinations that have been
explicitly tested, but it's non-trivial to go from a single commit of a
particular project to the commits that were tested with it.
Gerrit's submodule tracking feature will update a super project every
time a subproject is updated, so the specific sequence created by zuul