@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Add some basic documentation for Legalpad
Summary: Ref T3116. Explain a couple of core use cases and contextualize the app a bit.
Test Plan: Read application help screen and user guide.
Reviewers: btrahan, chad
Reviewed By: chad
Subscribers: epriestley
Maniphest Tasks: T3116
Differential Revision: https://secure.phabricator.com/D9777
+82
+11
src/applications/legalpad/application/PhabricatorApplicationLegalpad.php
+11
src/applications/legalpad/application/PhabricatorApplicationLegalpad.php
···
36
36
);
37
37
}
38
38
39
+
public function getHelpURI() {
40
+
return PhabricatorEnv::getDoclink('Legalpad User Guide');
41
+
}
42
+
43
+
public function getOverview() {
44
+
return pht(
45
+
'**Legalpad** is a simple application for tracking signatures and '.
46
+
'legal agreements. At the moment, it is primarily intended to help '.
47
+
'open source projects keep track of Contributor License Agreements.');
48
+
}
49
+
39
50
public function getRoutes() {
40
51
return array(
41
52
'/L(?P<id>\d+)' => 'LegalpadDocumentSignController',
+71
src/docs/user/userguide/legalpad.diviner
+71
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
+
Legalpad is a simple application for tracking signatures on legal agreements.
9
+
You can add legal documents, users can sign them, and you can keep track of who
10
+
has signed what.
11
+
12
+
Right now, it is primarily useful for open source projects that have a
13
+
Contributor License Agreement or a similar document which needs to be signed
14
+
before changes can be accepted from contributors. In particular, it has
15
+
integrations into Differential which can block changes from being accepted until
16
+
the author has signed the required documents.
17
+
18
+
NOTE: Legalpad is a basic application, and missing many of the features of more
19
+
general document signing software. It may be useful to help you do things
20
+
beyond track CLAs, but you should evaluate its capabilities carefully.
21
+
22
+
Requiring a CLA
23
+
===============
24
+
25
+
Open source projects often require contributors to sign a license agreement
26
+
before their contributions can be accepted to the project. To require a CLA or
27
+
similar document for an open source project:
28
+
29
+
- Create a CLA document in Legalpad.
30
+
- Create a "Global" Herald rule which triggers "Always".
31
+
- The rule should take the action "Require legal signatures", specifying
32
+
your CLA document as the required document.
33
+
34
+
After you've done this, all new reviews created in Differential by authors who
35
+
have not signed the document will trigger a signature requirement. These reviews
36
+
can not be accepted until the document has been signed.
37
+
38
+
If the author has already signed all of the required documents, Herald will not
39
+
take any actions. This reduces the amount of noise the CLA process generates for
40
+
regular contributors.
41
+
42
+
You can require more than one document (to require that they all be signed), if
43
+
you have several agreements that contributors must sign.
44
+
45
+
Alternatively, if you have several different sets of agreements for different
46
+
projects, you can also choose a more narrow Herald condition than "Always" (for
47
+
example, require a signature only if the revision is against certain
48
+
repositories).
49
+
50
+
Document-Based Policies
51
+
=======================
52
+
53
+
If you have a document like an NDA, you can write a policy rule which prevents
54
+
users from seeing content until they sign the document:
55
+
56
+
- In any policy control ("Visible To", "Editable By"), choose "Custom Policy".
57
+
- Add a rule like "Allow signers of legalpad documents: X".
58
+
- Leave the default rule as "Deny all other users".
59
+
- Save the policy.
60
+
61
+
Users will now only be able to take the action (for example, view or edit the
62
+
object) if they have signed the specified documents.
63
+
64
+
Roadmap
65
+
========
66
+
67
+
You can find discussion about the Legalpad roadmap here:
68
+
69
+
https://secure.phabricator.com/T5505
70
+
71
+
If there are features you'd like to see, let us know.