Differential D25007 Diff 23 src/docs/user/userguide/audit.diviner

Changeset View

Standalone View

src/docs/user/userguide/audit.diviner

	@title Audit User Guide			@title Audit User Guide
	@group userguide			@group userguide

	Guide to using Phabricator to audit published commits.			Guide to using Phorge to audit published commits.


	Overview			Overview
	========			========

	Phabricator supports two code review workflows, "review" (pre-publish) and			Phorge supports two code review workflows, "review" (pre-publish) and
	"audit" (post-publish). To understand the differences between the two, see			"audit" (post-publish). To understand the differences between the two, see
	@{article:User Guide: Review vs Audit}.			@{article:User Guide: Review vs Audit}.


	How Audit Works			How Audit Works
	===============			===============

	The audit workflow occurs after changes have been published. It provides ways			The audit workflow occurs after changes have been published. It provides ways
	Show All 35 Lines
	Users interact with commits by leaving comments and applying actions, like			Users interact with commits by leaving comments and applying actions, like
	accepting the changes or raising a concern. These actions change the state of			accepting the changes or raising a concern. These actions change the state of
	their own audit and the overall audit state of the commit. Here's an example of			their own audit and the overall audit state of the commit. Here's an example of
	a typical audit workflow:			a typical audit workflow:

	- Alice publishes a commit containing some Javascript.			- Alice publishes a commit containing some Javascript.
	- This triggers an audit request to Bailey, the Javascript technical			- This triggers an audit request to Bailey, the Javascript technical
	lead on the project (see below for a description of trigger mechanisms).			lead on the project (see below for a description of trigger mechanisms).
	- Later, Bailey logs into Phabricator and sees the audit request. She ignores			- Later, Bailey logs into Phorge and sees the audit request. She ignores
	it for the moment, since it isn't blocking anything. At the end of the			it for the moment, since it isn't blocking anything. At the end of the
	week she looks through her open requests to see what the team has been			week she looks through her open requests to see what the team has been
	up to.			up to.
	- Bailey notices a few minor problems with Alice's commit. She leaves			- Bailey notices a few minor problems with Alice's commit. She leaves
	comments describing improvements and uses "Raise Concern" to send the			comments describing improvements and uses "Raise Concern" to send the
	commit back into Alice's queue.			commit back into Alice's queue.
	- Later, Alice logs into Phabricator and sees that Bailey has raised a			- Later, Alice logs into Phorge and sees that Bailey has raised a
	concern (usually, Alice will also get an email). She resolves the issue			concern (usually, Alice will also get an email). She resolves the issue
	somehow, maybe by making a followup commit with fixes.			somehow, maybe by making a followup commit with fixes.
	- After the issues have been dealt with, she uses "Request Verification" to			- After the issues have been dealt with, she uses "Request Verification" to
	return the change to Bailey so Bailey can verify that the concerns have			return the change to Bailey so Bailey can verify that the concerns have
	been addressed.			been addressed.
	- Bailey uses "Accept Commit" to close the audit.			- Bailey uses "Accept Commit" to close the audit.

	In {nav Diffusion > Browse Commits}, you can review commits and query for			In {nav Diffusion > Browse Commits}, you can review commits and query for
	▲ Show 20 Lines • Show All 80 Lines • ▼ Show 20 Lines

	Audit Maintenance			Audit Maintenance
	=================			=================

	The `bin/audit` command allows you to perform several maintenance operations.			The `bin/audit` command allows you to perform several maintenance operations.
	Get more information about a command by running:			Get more information about a command by running:

	```			```
	phabricator/ $ ./bin/audit help <command>			phorge/ $ ./bin/audit help <command>
	```			```

	Supported operations are:			Supported operations are:

	Delete Audits: Delete audits that match certain parameters with			Delete Audits: Delete audits that match certain parameters with
	`bin/audit delete`.			`bin/audit delete`.

	You can use this command to forcibly delete requests which may have triggered			You can use this command to forcibly delete requests which may have triggered
	Show All 25 Lines