OpenDev Manual
Go to file
Zuul e40ff9d3c5 Merge "PyPI: clarify case where owner can't be removed" 2023-07-11 13:13:08 +00:00
doc/source Merge "PyPI: clarify case where owner can't be removed" 2023-07-11 13:13:08 +00:00
.gitignore Add ChangeLog and AUTHORS to .gitignore 2015-05-13 16:20:27 -07:00
.gitreview Update .gitreview after rename 2020-03-20 16:07:06 +01:00
LICENSE Initial commit 2014-05-26 20:25:48 -04:00
README.rst Rework README.rst for OpenDev 2020-03-05 16:37:12 +01:00
requirements.txt Use alabaster theme 2020-03-27 09:28:57 -07:00
setup.cfg Update contact info for OpenDev community 2020-04-07 19:13:41 +00:00
setup.py Update python files for OpenDev 2020-03-04 21:08:06 +01:00
tox.ini Update infra-specs URL 2019-05-30 21:19:53 +02:00

README.rst

OpenDev 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.

Terminology

A note on terminology use in the manual:

This manual is in service of OpenDev, but does so primarily by documenting how developers and project drivers can use the infrastructure to accomplish their work.

We strive for consistent terminology that matches what developers and our tooling use, even if some hosted projects use different terminology.

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".