Clark Boylan
91bab6d6ae
We have a document section dedicated to explaining how to set up an HTTPS remote for Gerrit. While this section indicates that this shouldn't be necessary it doesn't explicitly call out that SSH is preferred. Make this change. Also point people back to the Getting started document if they haven't read that yet as it covers Gerrit SSH connectivity. Change-Id: Ibb0fe097cd63ff57111455c94a00586ff2b050d2
OpenDev Manual
To build the manual, execute the following command:
$ toxAfter 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".