No OneTemporary
Actions

Size

5 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/applications/legalpad/application/PhabricatorApplicationLegalpad.php b/src/applications/legalpad/application/PhabricatorApplicationLegalpad.php
	index f723f1b081..71331779bc 100644
	--- a/src/applications/legalpad/application/PhabricatorApplicationLegalpad.php
	+++ b/src/applications/legalpad/application/PhabricatorApplicationLegalpad.php
	@@ -1,68 +1,79 @@
	<?php

	final class PhabricatorApplicationLegalpad extends PhabricatorApplication {

	public function getBaseURI() {
	return '/legalpad/';
	}

	public function getShortDescription() {
	return pht('Agreements and Signatures');
	}

	public function getIconName() {
	return 'legalpad';
	}

	public function getTitleGlyph() {
	return "\xC2\xA9";
	}

	public function getFlavorText() {
	return pht('With advanced signature technology.');
	}

	public function getApplicationGroup() {
	return self::GROUP_UTILITIES;
	}

	public function isBeta() {
	return true;
	}

	public function getRemarkupRules() {
	return array(
	new LegalpadDocumentRemarkupRule(),
	);
	}

	+ public function getHelpURI() {
	+ return PhabricatorEnv::getDoclink('Legalpad User Guide');
	+ }
	+
	+ public function getOverview() {
	+ return pht(
	+ 'Legalpad is a simple application for tracking signatures and '.
	+ 'legal agreements. At the moment, it is primarily intended to help '.
	+ 'open source projects keep track of Contributor License Agreements.');
	+ }
	+
	public function getRoutes() {
	return array(
	'/L(?P<id>\d+)' => 'LegalpadDocumentSignController',
	'/legalpad/' => array(
	'' => 'LegalpadDocumentListController',
	'(?:query/(?P<queryKey>[^/]+)/)?' => 'LegalpadDocumentListController',
	'create/' => 'LegalpadDocumentEditController',
	'edit/(?P<id>\d+)/' => 'LegalpadDocumentEditController',
	'comment/(?P<id>\d+)/' => 'LegalpadDocumentCommentController',
	'view/(?P<id>\d+)/' => 'LegalpadDocumentManageController',
	'done/' => 'LegalpadDocumentDoneController',
	'verify/(?P<code>[^/]+)/' =>
	'LegalpadDocumentSignatureVerificationController',
	'signatures/(?:(?P<id>\d+)/)?(?:query/(?P<queryKey>[^/]+)/)?' =>
	'LegalpadDocumentSignatureListController',
	'document/' => array(
	'preview/' => 'PhabricatorMarkupPreviewController'),
	));
	}

	protected function getCustomCapabilities() {
	return array(
	LegalpadCapabilityDefaultView::CAPABILITY => array(
	),
	LegalpadCapabilityDefaultEdit::CAPABILITY => array(
	),
	);
	}

	}
	diff --git a/src/docs/user/userguide/legalpad.diviner b/src/docs/user/userguide/legalpad.diviner
	new file mode 100644
	index 0000000000..2841316e81
	--- /dev/null
	+++ b/src/docs/user/userguide/legalpad.diviner
	@@ -0,0 +1,71 @@
	+@title Legalpad User Guide
	+@group userguide
	+
	+Using Legalpad to track agreements and signatures on legal documents.
	+
	+= Overview =
	+
	+Legalpad is a simple application for tracking signatures on legal agreements.
	+You can add legal documents, users can sign them, and you can keep track of who
	+has signed what.
	+
	+Right now, it is primarily useful for open source projects that have a
	+Contributor License Agreement or a similar document which needs to be signed
	+before changes can be accepted from contributors. In particular, it has
	+integrations into Differential which can block changes from being accepted until
	+the author has signed the required documents.
	+
	+NOTE: Legalpad is a basic application, and missing many of the features of more
	+general document signing software. It may be useful to help you do things
	+beyond track CLAs, but you should evaluate its capabilities carefully.
	+
	+Requiring a CLA
	+===============
	+
	+Open source projects often require contributors to sign a license agreement
	+before their contributions can be accepted to the project. To require a CLA or
	+similar document for an open source project:
	+
	+ - Create a CLA document in Legalpad.
	+ - Create a "Global" Herald rule which triggers "Always".
	+ - The rule should take the action "Require legal signatures", specifying
	+ your CLA document as the required document.
	+
	+After you've done this, all new reviews created in Differential by authors who
	+have not signed the document will trigger a signature requirement. These reviews
	+can not be accepted until the document has been signed.
	+
	+If the author has already signed all of the required documents, Herald will not
	+take any actions. This reduces the amount of noise the CLA process generates for
	+regular contributors.
	+
	+You can require more than one document (to require that they all be signed), if
	+you have several agreements that contributors must sign.
	+
	+Alternatively, if you have several different sets of agreements for different
	+projects, you can also choose a more narrow Herald condition than "Always" (for
	+example, require a signature only if the revision is against certain
	+repositories).
	+
	+Document-Based Policies
	+=======================
	+
	+If you have a document like an NDA, you can write a policy rule which prevents
	+users from seeing content until they sign the document:
	+
	+ - In any policy control ("Visible To", "Editable By"), choose "Custom Policy".
	+ - Add a rule like "Allow signers of legalpad documents: X".
	+ - Leave the default rule as "Deny all other users".
	+ - Save the policy.
	+
	+Users will now only be able to take the action (for example, view or edit the
	+object) if they have signed the specified documents.
	+
	+Roadmap
	+========
	+
	+You can find discussion about the Legalpad roadmap here:
	+
	+https://secure.phabricator.com/T5505
	+
	+If there are features you'd like to see, let us know.

File Metadata

Mime Type: text/x-diff
Expires: Mon, Jul 28, 10:33 PM (1 w, 4 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 187587
Default Alt Text: (5 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions