We are trying to make this documentation less openstack specific. We should stop using the openstack sphinx theme as a result. Use alabaster is it is nice and clean and allows us to set our logo. Change-Id: Icb772f6a52803af53ece419cc3908bdd8e2faad0
|3 years ago|
|doc/source||3 years ago|
|.gitignore||8 years ago|
|.gitreview||3 years ago|
|LICENSE||9 years ago|
|README.rst||3 years ago|
|requirements.txt||3 years ago|
|setup.cfg||3 years ago|
|setup.py||3 years ago|
|tox.ini||4 years ago|
To build the manual, execute the following command:
tox, the documentation will be available for viewing in HTML format in the
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".