Improve documentation - Correct spelling - Use same Jira URL and username in all of documentation Change-Id: I9b13eb1a60c76607f1b66658237388870c598d71 Signed-off-by: David Pursehouse <david.pursehouse@sonymobile.com>
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md index 646cec8..c45014e 100644 --- a/src/main/resources/Documentation/config.md +++ b/src/main/resources/Documentation/config.md
@@ -24,14 +24,14 @@ a warning message is displayed as a suggestion on the client. OPTIONAL -: Issues-ids are liked when found on git commit message, no warning are +: Issues-ids are linked when found on git commit message, no warnings are displayed otherwise. Example: [commentLink "Jira"] match = (\\[[A-Z][A-Z]+-[1-9][0-9]*\\]) - html = "<a href=\"http://myjira.com/browse/$1\">$1</a>" + html = "<a href=\"http://jira.example.com/browse/$1\">$1</a>" association = SUGGESTED Once a Git commit with a comment link is detected, the Jira issue ID @@ -47,9 +47,9 @@ Example: [jira] - url=http://myjira.com - username=jirauser - passsword=jirapass + url=http://jira.example.com + username=admin + password=jirapass Jira credentials and connectivity details are asked and verified during the Gerrit init. @@ -65,12 +65,12 @@ *** Jira connectivity *** - Jira URL (empty to skip) [http://jira.lmitsoftware.com]: + Jira URL (empty to skip) [http://jira.example.com]: Jira username [admin]: Change admin's password [y/N]? y admin's password : ***** confirm password : ***** - Test connectivity to http://jira.lmitsoftware.com [N/?]: y + Test connectivity to http://jira.example.com [N/?]: y Checking Jira connectivity ... [OK] *** Jira issue-tracking association @@ -140,4 +140,4 @@ * Whenever a new Change-set is created on Gerrit, start progress on the Jira issue * Whenever a change is verified and reviewed with +2, transition the Jira issue to resolved * Whenever a change is merged to branch, mark the Jira transition the Jira issue to closed -* Whenever a change is abandoned, stop the progress on Jira issue \ No newline at end of file +* Whenever a change is abandoned, stop the progress on Jira issue