Issue 1179: documentation should say exactly how to enable contributor agreements
Status:  New
Owner: ----
Reported by bshanks....@gmail.com, Nov 11, 2011
currently the only documentation appears to be in http://gerrit.googlecode.com/svn/documentation/2.0/config-gerrit.html , which says
"
auth.contributorAgreements

    Controls whether or not the contributor agreement features are enabled for the Gerrit site. If enabled a user must complete a contributor agreement before they can upload changes.

    If enabled, the admin must also insert one or more rows into contributor_agreements and create agreement files under $site_path/static, so users can actually complete one or more agreements.

    By default this is false (no agreements are used).
"

1) how does one "enable" this option in the file? do i put

auth.contributorAgreements = true
auth.contributorAgreements = yes

[auth]

contributorAgreements=1

etc?

2) what should i put in the rows inserted into contributor_agreements? an example MYSQL statement would be helpful. the schema is

+-----------------------------+--------------+------+-----+---------+-------+
| Field                       | Type         | Null | Key | Default | Extra |
+-----------------------------+--------------+------+-----+---------+-------+
| active                      | char(1)      | NO   | MUL | N       |       |
| require_contact_information | char(1)      | NO   |     | N       |       |
| auto_verify                 | char(1)      | NO   |     | N       |       |
| short_name                  | varchar(40)  | NO   |     |         |       |
| short_description           | varchar(255) | YES  |     | NULL    |       |
| agreement_url               | varchar(255) | NO   |     |         |       |
| id                          | int(11)      | NO   | PRI | 0       |       |
+-----------------------------+--------------+------+-----+---------+-------+
i don't know what any of active, require_contact_information, auto_verify should be ("t"? "y"? "1"?), or what they mean.

(i even did "grep -r 'auto_verify' *" in the source of gerrit, but no luck)

thanks,
  bayle
Mar 28, 2012
#1 la...@lancehudson.com
For the future people who would like to know this info:

[auth]
contributorAgreements = true

and to insert into the db (example)

active                      : Y
require_contact_information : Y
auto_verify                 : Y
short_name                  : cla
short_description           : Contributor License Agreement
agreement_url               : static/cla.html
id                          : 1

The boolean's must be in caps.

auto_verify, if true, this means that no one has to approve the agreement before it is valid (someone please correct me).  This is from the code: Does this agreement automatically verify new accounts?  (/gerrit/gerrit-reviewdb/src/main/java/com/google/gerrit/reviewdb/client/ContributorAgreement.java @ L61)

I verified this.

Note: this is no ui (yet) for validating user agreements nor managing user agreements with respect to groups (there is functionality where membership in a group automatically approves an agreement)