Jeremy Stanley 87d6088053 Switch docs from referencing Freenode to OFTC
We moved our services to OFTC at the end of May, 2021. Update all
old Freenode references in the manual, and also drop mention of
registering nicks as this is not currently required to join channels
we serve.

Change-Id: Icd9005802c891d3637ac13804b36aa960b616a2c
2021-06-22 19:36:33 +00:00
2020-03-20 16:07:06 +01:00
2014-05-26 20:25:48 -04:00
2020-03-05 16:37:12 +01:00
2020-03-27 09:28:57 -07:00
2020-03-04 21:08:06 +01:00
2019-05-30 21:19:53 +02:00

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

Description
OpenDev Manual
Readme 4.4 MiB
Languages
Python 100%