opendev/gerrit
Code Issues Proposed changes

Mail footer discoverability helper

Browse Source 
Add info regarding mail footers and filter authoring to PolyGerrit and
to GWT UI settings screens and include a mention in the change footer
template.

Feature: Issue 4982
Change-Id: I3443af49fcdc16ca941ee7cf2b5e33c1106f3b1d
This commit is contained in:
Wyatt Allen
2016-11-28 11:28:10 -08:00
parent 16abcf65cf
commit 12a36023fb
13 changed files with 452 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
gerrit-gwtui/src/main/java/com/google/gerrit/client/account/AccountConstants.java
View File

@@ -239,6 +239,10 @@ public interface AccountConstants extends Constants {
String errorDialogTitleRegisterNewEmail();
String emailFilterHelpTitle();
String emailFilterHelp();
String newAgreement();
String agreementName();

69
gerrit-gwtui/src/main/java/com/google/gerrit/client/account/AccountConstants.properties
View File

@@ -158,7 +158,74 @@ descRegisterNewEmail = \
<p>A confirmation link will be sent by email to this address.</p>\
<p>You must click on the link to complete the registration and make the address available for selection.</p>
errorDialogTitleRegisterNewEmail = Email Registration Failed
emailFilterHelpTitle = Mail Filters
emailFilterHelp = \
<p>\
Gerrit emails include metadata about the change to support \
writing mail filters.\
</p>\
<p>\
Here are some example Gmail queries that can be used for filters or \
for searching through archived messages. View the \
<a href="https://gerrit-review.googlesource.com/Documentation/user-notify.html"\
target="_blank" rel="nofollow">Gerrit documentation</a> for \
the complete set of footers.\
</p>\
<table>\
<tbody>\
<tr><th>Name</th><th>Query</th></tr>\
<tr>\
<td>Changes requesting my review</td>\
<td>\
<code>\
"Gerrit-Reviewer: <em>Your Name</em>\
&lt;<em>your.email@example.com</em>&gt;"\
</code>\
</td>\
</tr>\
<tr>\
<td>Changes from a specific owner</td>\
<td>\
<code>\
"Gerrit-Owner: <em>Owner name</em>\
&lt;<em>owner.email@example.com</em>&gt;"\
</code>\
</td>\
</tr>\
<tr>\
<td>Changes targeting a specific branch</td>\
<td>\
<code>\
"Gerrit-Branch: <em>branch-name</em>"\
</code>\
</td>\
</tr>\
<tr>\
<td>Changes in a specific project</td>\
<td>\
<code>\
"Gerrit-Project: <em>project-name</em>"\
</code>\
</td>\
</tr>\
<tr>\
<td>Messages related to a specific Change ID</td>\
<td>\
<code>\
"Gerrit-Change-Id: <em>Change ID</em>"\
</code>\
</td>\
</tr>\
<tr>\
<td>Messages related to a specific change number</td>\
<td>\
<code>\
"Gerrit-Change-Number: <em>change number</em>"\
</code>\
</td>\
</tr>\
</tbody>\
</table>
newAgreement = New Contributor Agreement
agreementName = Name

6
gerrit-gwtui/src/main/java/com/google/gerrit/client/account/ContactPanelShort.java
View File

@@ -21,6 +21,7 @@ import com.google.gerrit.client.rpc.CallbackGroup;
import com.google.gerrit.client.rpc.GerritCallback;
import com.google.gerrit.client.rpc.NativeString;
import com.google.gerrit.client.rpc.Natives;
import com.google.gerrit.client.ui.ComplexDisclosurePanel;
import com.google.gerrit.client.ui.OnEditEnabler;
import com.google.gerrit.common.PageLinks;
import com.google.gerrit.common.errors.EmailException;
@@ -153,6 +154,11 @@ class ContactPanelShort extends Composite {
}
});
final ComplexDisclosurePanel mailFilterHelp =
new ComplexDisclosurePanel(Util.C.emailFilterHelpTitle(), false);
mailFilterHelp.setContent(new HTML(Util.C.emailFilterHelp()));
body.add(mailFilterHelp);
emailPick.addChangeHandler(
new ChangeHandler() {
@Override