Differential D14303 Diff 34533 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 the Audit (post-push code review) tool and workflow.		Guide to the Audit (post-push code review) tool and workflow.

= Overview =		= Overview =

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

This document summarizes the post-push "audit" workflow implemented by the		This document summarizes the post-push "audit" workflow implemented by the
creatively-named //Audit// tool.		creatively-named //Audit// tool.

NOTE: The audit workflow is new, give us feedback about it! See
@{article:Give Feedback! Get Support!}.

= How Audit Works =		= How Audit Works =

Using auditing allows you to push and deploy code without waiting for code		Using auditing allows you to push and deploy code without waiting for code
review, while still doing code review eventually. The Audit tool primarily keeps		review, while still doing code review eventually. The Audit tool primarily keeps
track of two things:		track of two things:

- Commits and their audit state (like "Not Audited", "Approved", or		- Commits and their audit state (like "Not Audited", "Approved", or
"Concern Raised").		"Concern Raised").
▲ Show 20 Lines • Show All 73 Lines • ▼ Show 20 Lines	= Audit Tips =
- You can leave a comment across multiple lines by dragging across the line		- You can leave a comment across multiple lines by dragging across the line
numbers.		numbers.
- Inline comments are initially saved as drafts. They are not submitted until		- Inline comments are initially saved as drafts. They are not submitted until
you submit a comment at the bottom of the page.		you submit a comment at the bottom of the page.
- Press "?" to view keyboard shortcuts.		- Press "?" to view keyboard shortcuts.

= Next Steps =		= Next Steps =

- Learn more about Herald at @{article:Herald User Guide}; or		- Learn more about Herald at @{article:Herald User Guide}.
- give us feedback at @{article:Give Feedback! Get Support!}.