src/docs/user/userguide/legalpad.diviner

   1 @title Legalpad User Guide
   2 @group userguide
   3
   4 Using Legalpad to track agreements and signatures on legal documents.
   5
   6 Overview
   7 ========
   8
   9 Legalpad is a simple application for tracking signatures on legal agreements.
  10 You can add legal documents, users can sign them, and you can keep track of who
  11 has signed what.
  12
  13 Right now, it is primarily useful for open source projects that have a
  14 Contributor License Agreement or a similar document which needs to be signed
  15 before changes can be accepted from contributors. In particular, it has
  16 integrations into Differential which can block changes from being accepted until
  17 the author has signed the required documents.
  18
  19 NOTE: Legalpad is a basic application, and missing many of the features of more
  20 general document signing software. It may be useful to help you do things
  21 beyond track CLAs, but you should evaluate its capabilities carefully.
  22
  23 Documents
  24 =========
  25
  26 The primary object in legalpad is the //Legalpad Document//, which represents
  27 a written agreement, contract, policy, or other similar document.
  28
  29 Most fields of a document are relatively straightforward, but some are unique
  30 to the application:
  31
  32 **Who Should Sign?** This field controls what kind of signatures the document
  33 accepts. You can choose either **Individuals** (users will be prompted to sign
  34 with their name), **Corporations** (users will be prompted to enter information
  35 identifying the corporation they are signing on behalf of) or **No One** (for
  36 policy documents or other documents which do not require a signature).
  37
  38 **Require Signature** This field allows you to create a document which all of
  39 your users must sign before they can use Phabricator, like a terms of service
  40 document. See "Use Case: Terms of Service" below for details. These documents
  41 must be signable by individuals.
  42
  43 Use Case: Requiring a CLA
  44 ===============
  45
  46 Open source projects often require contributors to sign a license agreement
  47 before their contributions can be accepted to the project. To require a CLA or
  48 similar document for an open source project:
  49
  50   - Create a CLA document in Legalpad.
  51   - Create a "Global" Herald rule which triggers "Always".
  52   - The rule should take the action "Require legal signatures", specifying
  53     your CLA document as the required document.
  54
  55 After you've done this, all new reviews created in Differential by authors who
  56 have not signed the document will trigger a signature requirement. These reviews
  57 can not be accepted until the document has been signed.
  58
  59 The content of these revisions will also be hidden until the document has been
  60 signed. This prevents reviewers from being tainted by examining the changes if
  61 the author ultimately declines to sign the CLA.
  62
  63 If the author has already signed all of the required documents, Herald will not
  64 take any actions. This reduces the amount of noise the CLA process generates for
  65 regular contributors.
  66
  67 You can require more than one document (to require that they all be signed), if
  68 you have several agreements that contributors must sign.
  69
  70 Alternatively, if you have several different sets of agreements for different
  71 projects, you can also choose a more narrow Herald condition than "Always" (for
  72 example, require a signature only if the revision is against certain
  73 repositories).
  74
  75 Use Case: Terms of Service
  76 =================================
  77
  78 If you have a "Terms of Service" document that you'd like users to agree to
  79 before they're allowed to use your install, you can add it to Legalpad and then
  80 check the **Require Signature** box for the document.
  81
  82 After logging in, users will need to agree to the document before they can
  83 do other things with their account (you'll need to agree to it, too, as soon
  84 as you save your changes, so that will give you a sense of the workflow).
  85
  86 Note that although users who have not signed all of the required documents can
  87 not use most Phabricator functions, they can browse other Legalpad documents
  88 that they have permission to see. This allows a terms document to be
  89 supplemented with additional policy or guideline documents that users are free
  90 to review before agreeing to the terms.
  91
  92
  93 Use Case: Document-Based Policies
  94 =======================
  95
  96 If you have a document like an NDA, you can write a policy rule which prevents
  97 users from seeing content until they sign the document:
  98
  99   - In any policy control ("Visible To", "Editable By"), choose "Custom Policy".
 100   - Add a rule like "Allow signers of legalpad documents: X".
 101   - Leave the default rule as "Deny all other users".
 102   - Save the policy.
 103
 104 Users will now only be able to take the action (for example, view or edit the
 105 object) if they have signed the specified documents.
 106
 107
 108 Adding Exemptions
 109 =================
 110
 111 If you have users who have signed an alternate form of a document (for example,
 112 you have a hard copy on file), or an equivalent document, or who are otherwise
 113 exempt from needing to sign a document in Legalpad, you can add a signature
 114 exemption for them.
 115
 116 Other applications will treat users with a signature exemption as though they
 117 had signed the document, although the UI will show the signature as an exemption
 118 rather than a normal signature.
 119
 120 To add an exemption, go to **Manage Document**, then **View Signatures**, then
 121 **Add Signature Exemption**.
 122
 123 You can optionally add notes about why a user is exempt from signing a document.
 124 To review the notes later (and see who added the exemption), click the colored
 125 asterisk in the list view.
 126
 127
 128 Roadmap
 129 ========
 130
 131 You can find discussion about the Legalpad roadmap here:
 132
 133 https://secure.phabricator.com/T5505
 134
 135 If there are features you'd like to see, let us know.