OpenStack Infrastructure User Manual
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Andreas Jaeger 62e839d0c9 Update for OpenDev Gerrit changes 4 weeks ago
doc/source Update for OpenDev Gerrit changes 4 weeks ago
.gitignore Add ChangeLog and AUTHORS to .gitignore 4 years ago
.gitreview OpenDev Migration Patch 1 month ago
LICENSE Initial commit 5 years ago
README.rst Add terminology notes to README 3 years ago
requirements.txt Use sidebar from openstackdocstheme 1.17 1 year ago
setup.cfg Revert "Change openstack-infra to openstack-discuss" 5 months ago Update sphinx version 2 years ago
tox.ini Fix yaml snippet for sphinx for python3 1 year ago


OpenStack Project Infrastructure Manual

To build the manual, execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory.


A note on terminology use in the manual:

This is a manual that describes how to use the OpenStack project infrastructure. The OpenStack project, and the Technical Committee (TC) in particular, from time to time uses words such as "project", "team", "program", "repository", etc. to help classify how it organizes the OpenStack project from an administrative point of view. This manual is in service of OpenStack, but does so primarily by documenting how developers and project drivers can use the infrastructure to accomplish their work. While the TC may change its terms from time to time, it is not necessary for us to change all of the terminology in this manual to match. We should strive for consistent terminology that matches what developers and our tooling use. When we describe specific TC-related processes, we should use the current TC terminology to avoid confusion.

Generally speaking these terms should be used as follows:

Project: The overall idea that there is a bunch of people working on a bunch of code/text/etc. It can also refer to that actual collection of code/text/etc (for instance, a project can be bundled up into a tarball, and extracted into a directory). When a tool interacts with that collection of code/text/etc, it interacts with the project (even if it does so via the mechanism of git).

Repository: There are times when one needs to refer to the actual source code management system of a project, that is, "git", and the actual technical implementations of that SCM. In those cases where it is important to distinguish the actual attributes of the SCM from the project, it is useful to use the word "repository".